Not supported in older versions
Available from Business Central version 22.2 and higher.
| API | Path |
|---|---|
| purchaseCreditMemos | businesscentralPrefix/softera/softeraEInvoice/v2.0/companies({{companyId}})/purchaseCreditMemos |
Methods
| Method | Return Type | Description |
|---|---|---|
| GET purchaseCreditMemo | purchaseCreditMemo | Gets a purchase credit memo object. |
| POST purchaseCreditMemo | purchaseCreditMemo | Creates a purchase credit memo object. |
| PATCH purchaseCreditMemo | purchaseCreditMemo | Updates a purchase credit memo object. |
| DELETE purchaseCreditMemo | none | Deletes a purchase credit memo object. |
Bound Actions
| Action | Description | Action Call | Response | Response Code |
|---|---|---|---|---|
| Post | Posts the corresponding purchase credit memo | purchaseCreditMemos({id})/Microsoft.NAV.post | No response | 204 |
| Cancel | Cancels the corresponding purchase credit memo | purchaseCreditMemos({id})/Microsoft.NAV.cancel | 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 |
| creditMemoDate | Date | ||
| postingDate | Date | ||
| dueDate | Date | ||
| vendorId | Guid | ||
| vendorNumber | String | 20 | |
| vendorName | String | 100 | Read-only |
| vendorCrMemoNumber | String | 35 | |
| payToVendorId | Guid | ||
| payToVendorNumber | String | 20 | |
| payToName | String | 100 | Read-only |
| buyFromAddressLine1 | String | 100 | |
| buyFromAddressLine2 | String | 50 | |
| buyFromCity | String | 30 | |
| buyFromCountry | String | 10 | |
| buyFromState | String | 30 | |
| buyFromPostCode | String | 20 | |
| payToAddressLine1 | String | 100 | |
| payToAddressLine2 | String | 50 | |
| payToCity | String | 30 | |
| payToCountry | String | 10 | |
| payToState | String | 30 | |
| payToPostCode | String | 20 | |
| postingDescription | String | ||
| shortcutDimension1Code | String | 20 | |
| shortcutDimension2Code | String | 20 | |
| currencyId | Guid | ||
| currencyCode | String | ||
| paymentTermsId | Guid | ||
| paymentMethodCode | String | ||
| shipmentMethodId | Guid | ||
| purchaser | String | 20 | |
| pricesIncludeTax | Boolean | Read-only | |
| discountAmount | Decimal | ||
| discountAppliedBeforeTax | Boolean | Read-only | |
| totalAmountExcludingTax | Decimal | Read-only | |
| totalTaxAmount | Decimal | Read-only | |
| totalAmountIncludingTax | Decimal | Read-only | |
| apiTotalAmountExclVAT | Decimal | ||
| apiTotalAmountInclVAT | Decimal | ||
| status | String | Read-only | |
| posted | Boolean | Read-only | |
| locationCode | String | ||
| documentLink | String | ||
| documentNote | String | ||
| lastModifiedDateTime | DateTimeOffset | ||
| invoiceId | Guid | ||
| invoiceNumber | String | 20 | |
| vendorReturnReasonId | Guid | ||
| userId | String |
Related API's (expand)
| Name | Type | Description |
|---|---|---|
| vendor | Microsoft.NAV.vendor | |
| dimensionValue | Microsoft.NAV.dimensionValue | |
| dimensionSetLines | Collection(Microsoft.NAV.dimensionSetLine) | |
| purchaseCreditMemoLines | Collection(Microsoft.NAV.purchaseCreditMemoLine) | |
| pdfDocument | Microsoft.NAV.pdfDocument | |
| attachments | Collection(Microsoft.NAV.attachment) | |
| documentAttachments | Collection(Microsoft.NAV.documentAttachment) |