| API | Path |
|---|---|
| salesOrders | businesscentralPrefix/softera/softeraEInvoice/v2.0/companies({{companyId}})/salesOrders |
Methods
| Method | Return Type | Description |
|---|---|---|
| GET salesOrder | salesOrder | Gets a sales order object. |
| POST salesOrder | salesOrder | Creates a sales order object. |
| PATCH salesOrder | salesOrder | Updates a sales order object. |
| DELETE salesOrder | none | Deletes a sales order object. |
Bound Actions
| Action | Description | Action Call | Response | Response Code |
|---|---|---|---|---|
| shipAndInvoice | Ships and invoices the corresponding sales order | salesOrders({id})/Microsoft.NAV.shipAndInvoice | No response | 204 |
Important
Always populate apiTotalAmountExclVAT and apiTotalAmountInclVAT with the totals calculated in your external system. Business Central compares these against its own calculated amounts, and any mismatch will block posting with a VAT error. See API Setup for how the VAT mismatch check works and how to allow auto-correction or bypass it if needed.
Fields
| Name | Type | MaxLength | Description |
|---|---|---|---|
| id | Guid | Read-only | |
| number | String | 20 | Read-only |
| externalDocumentNumber | String | 35 | |
| orderDate | Date | ||
| postingDate | Date | ||
| postingDescription | String | 100 | |
| customerId | Guid | ||
| customerNumber | String | 20 | |
| customerName | String | 100 | Read-only |
| billToName | String | 100 | Read-only |
| billToCustomerId | Guid | ||
| billToCustomerNumber | String | 20 | |
| shipToName | String | 100 | |
| shipToContact | String | 100 | |
| sellToAddressLine1 | String | 100 | |
| sellToAddressLine2 | String | 50 | |
| sellToCity | String | 30 | |
| sellToCountry | String | 10 | |
| sellToState | String | 30 | |
| sellToPostCode | String | 20 | |
| billToAddressLine1 | String | 100 | Read-only |
| billToAddressLine2 | String | 50 | Read-only |
| billToCity | String | 30 | Read-only |
| billToCountry | String | 10 | Read-only |
| billToState | String | 30 | Read-only |
| billToPostCode | String | 20 | Read-only |
| shipToAddressLine1 | String | 100 | |
| shipToAddressLine2 | String | 50 | |
| shipToCity | String | 30 | |
| shipToCountry | String | 10 | |
| shipToState | String | 30 | |
| shipToPostCode | String | 20 | |
| shortcutDimension1Code | String | 20 | |
| shortcutDimension2Code | String | 20 | |
| currencyId | Guid | ||
| currencyCode | String | 10 | |
| pricesIncludeTax | Boolean | ||
| paymentTermsId | Guid | ||
| paymentMethodCode | String | 10 | |
| shipmentMethodId | Guid | ||
| salesperson | String | 20 | |
| partialShipping | Boolean | ||
| requestedDeliveryDate | Date | ||
| discountAmount | Decimal | ||
| discountAppliedBeforeTax | Boolean | Read-only | |
| totalAmountExcludingTax | Decimal | Read-only | |
| totalTaxAmount | Decimal | Read-only | |
| totalAmountIncludingTax | Decimal | Read-only | |
| fullyShipped | Boolean | ||
| status | String | Read-only | |
| lastModifiedDateTime | DateTimeOffset | Read-only | |
| phoneNumber | String | 30 | |
| String | 80 | ||
| apiTotalAmountExclVAT | Decimal | ||
| apiTotalAmountInclVAT | Decimal | ||
| locationCode | String | 10 | |
| userId | String | 50 |
Related API's (expand)
| Name | Type | Description |
|---|---|---|
| customer | Microsoft.NAV.customer | |
| dimensionSetLines | Collection(Microsoft.NAV.dimensionSetLine) | |
| salesOrderLines | Collection(Microsoft.NAV.salesOrderLine) | |
| pdfDocument | Microsoft.NAV.pdfDocument | |
| attachments | Collection(Microsoft.NAV.attachment) | |
| documentAttachments | Collection(Microsoft.NAV.documentAttachment) |