| API | Path |
|---|---|
| customers | businesscentralPrefix/softera/softeraEInvoice/v2.0/companies({{companyId}})/customers |
Methods
| Method | Return Type | Description |
|---|---|---|
| GET customer | customer | Gets a customer object. |
| POST customer | customer | Creates a customer object. |
| PATCH customer | customer | Updates a customer object. |
| DELETE customer | none | Deletes a customer object. |
Important
If Assign Default Template is enabled in API Setup, customerTemplateCode does not need to be sent in the request — it will be assigned automatically based on the customer's country (Local / EU / Foreign Customer Template). See API Setup for configuration.
Tip
Business Central can check for duplicate customers before creating a new one, based on Registration Number (registrationNumber / taxRegistrationNumber) or Name (displayName). Enable this via Check Duplicates by Reg. No. and Check Duplicates by Name in API Setup — if a matching record is found, the request is rejected with an error instead of creating a duplicate.
Fields
| Name | Type | MaxLength | Description |
|---|---|---|---|
| id | Guid | ||
| number | String | 20 | |
| displayName | String | 100 | |
| type | String | ||
| addressLine1 | String | 100 | |
| addressLine2 | String | 50 | |
| country | String | 10 | |
| city | String | 30 | |
| state | String | 30 | |
| postalCode | String | 20 | |
| phoneNumber | String | 30 | |
| String | 80 | ||
| website | String | 80 | |
| salespersonCode | String | 20 | |
| balanceDue | Decimal | Read-only | |
| creditLimit | Decimal | ||
| taxLiable | Boolean | ||
| taxAreaId | Guid | ||
| taxAreaDisplayName | String | Read-only | |
| taxRegistrationNumber | String | 20 | |
| registrationNumber | String | 50 | |
| currencyId | Guid | ||
| currencyCode | String | ||
| paymentTermsId | Guid | ||
| paymentTermsCode | String | 10 | |
| shipmentMethodId | Guid | ||
| paymentMethodId | Guid | ||
| languageCode | String | 10 | |
| blocked | String | ||
| customerTemplateCode | String | ||
| customerLink | String | 250 | |
| globalDimension1Code | String | 20 | |
| globalDimension2Code | String | 20 | |
| lastModifiedDateTime | DateTimeOffset | Read-only |
Related API's (expand)
| Name | Type | Description |
|---|---|---|
| customerFinancialDetail | Microsoft.NAV.customerFinancialDetail | |
| picture | Microsoft.NAV.picture | |
| defaultDimensions | Collection(Microsoft.NAV.defaultDimension) | |
| agedAccountsReceivable | Microsoft.NAV.agedAccountsReceivable | |
| contactsInformation | Collection(Microsoft.NAV.contactInformation) |