| API | Path |
|---|---|
| purchaseInvoices | businesscentralPrefix/softera/softeraEInvoice/v2.0/companies({{companyId}})/purchaseInvoices |
Methods
| Method | Return Type | Description |
|---|---|---|
| GET purchaseInvoice | purchaseInvoice | Gets a purchase invoice object. |
| POST purchaseInvoice | purchaseInvoice | Creates a purchase invoice object. |
| PATCH purchaseInvoice | purchaseInvoice | Updates a purchase invoice object. |
| DELETE purchaseInvoice | none | Deletes a purchase invoice object. |
Bound Actions
| Action | Description | Action Call | Response | Response Code |
|---|---|---|---|---|
| Post | Posts the corresponding purchase invoice | POST purchaseInvoices({id})/Microsoft.NAV.post | 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 |
| invoiceDate | Date | ||
| postingDate | Date | ||
| dueDate | Date | ||
| vendorInvoiceNumber | String | 35 | |
| vendorOrderNumber | String | 35 | |
| postingDescription | String | ||
| vendorId | Guid | ||
| vendorNumber | String | 20 | |
| vendorName | String | 100 | Read-only |
| payToName | String | 100 | Read-only |
| payToContact | String | 100 | Read-only |
| payToVendorId | Guid | ||
| payToVendorNumber | String | 20 | |
| shipToName | String | 100 | |
| shipToContact | String | 100 | |
| buyFromAddressLine1 | String | 100 | |
| buyFromAddressLine2 | String | 50 | |
| buyFromCity | String | 30 | |
| buyFromCountry | String | 10 | |
| buyFromState | String | 30 | |
| buyFromPostCode | String | 20 | |
| shipToAddressLine1 | String | 100 | |
| shipToAddressLine2 | String | 50 | |
| shipToCity | String | 30 | |
| shipToCountry | String | 10 | |
| shipToState | String | 30 | |
| shipToPostCode | String | 20 | |
| payToAddressLine1 | String | 100 | Read-only |
| payToAddressLine2 | String | 50 | Read-only |
| payToCity | String | 30 | Read-only |
| payToCountry | String | 10 | Read-only |
| payToState | String | 30 | Read-only |
| payToPostCode | String | 20 | Read-only |
| shortcutDimension1Code | String | ||
| shortcutDimension2Code | String | ||
| currencyId | Guid | ||
| currencyCode | String | ||
| orderId | Guid | Read-only | |
| orderNumber | String | 20 | Read-only |
| paymentMethodCode | String | ||
| pricesIncludeTax | Boolean | ||
| userId | String | ||
| discountAmount | Decimal | ||
| discountAppliedBeforeTax | Boolean | ||
| totalAmountExcludingTax | Decimal | Read-only | |
| totalTaxAmount | Decimal | Read-only | |
| totalAmountIncludingTax | Decimal | ||
| apiTotalAmountExclVAT | Decimal | ||
| apiTotalAmountInclVAT | Decimal | ||
| status | String | Read-only | |
| posted | Boolean | Read-only | |
| locationCode | String | ||
| documentLink | String | ||
| documentNote | String | ||
| closed | Boolean | ||
| lastModifiedDateTime | DateTimeOffset | Read-only |
Related API's (expand)
| Name | Type | Description |
|---|---|---|
| vendor | Microsoft.NAV.vendor | |
| purchaseInvoiceLines | Collection(Microsoft.NAV.purchaseInvoiceLine) | |
| dimensionSetLines | Collection(Microsoft.NAV.dimensionSetLine) | |
| pdfDocument | Microsoft.NAV.pdfDocument | |
| attachments | Collection(Microsoft.NAV.attachment) | |
| documentAttachments | Collection(Microsoft.NAV.documentAttachment) |