---
title: "API salesCreditMemo"
slug: "api-salescreditmemo"
description: "Detailed Softera Sales Credit Memo API reference covering customer data, amounts, taxes, dimensions, return reasons, attachments, and credit memo lines."
tags: ["Business Central API", "Integration", "Integracija", "Business Central", "API", "Softera sprendimai"]
updated: 2026-09-09T16:02:03Z
published: 2026-09-09T16:02:03Z
canonical: "instrukcijos.softera.lt/api-salescreditmemo"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://instrukcijos.softera.lt/llms.txt
> Use this file to discover all available pages before exploring further.

# salesCreditMemo

| **API** | **Path** |
| --- | --- |
| salesCreditMemos | businesscentralPrefix/softera/softeraEInvoice/v2.0/companies({{companyId}})/salesCreditMemos |

**Methods**

| Method | Return Type | Description |
| --- | --- | --- |
| GET salesCreditMemo | salesCreditMemo | Gets a sales credit memo object. |
| POST salesCreditMemo | salesCreditMemo | Creates a sales credit memo object. |
| PATCH salesCreditMemo | salesCreditMemo | Updates a sales credit memo object. |
| DELETE salesCreditMemo | none | Deletes a sales credit memo object. |

**Bound Actions**

| Action | Description | Action Call | Response | Response Code |
| --- | --- | --- | --- | --- |
| cancel | Cancels the corresponding sales credit memo | salesCreditMemos({id})/Microsoft.NAV.cancel | No response | 204 |
| cancelAndSend | Cancels and sends the corresponding sales credit memo | salesCreditMemos({id})/Microsoft.NAV.cancelAndSend | No response | 204 |
| post | Posts the corresponding sales credit memo | salesCreditMemos({id})/Microsoft.NAV.post | No response | 204 |
| postAndSend | Posts and sends the corresponding sales credit memo | salesCreditMemos({id})/Microsoft.NAV.postAndSend | No response | 204 |
| send | Sends the corresponding sales credit memo | salesCreditMemos({id})/Microsoft.NAV.send | 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](https://instrukcijos.softera.lt/docs/en/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 |  |
| creditMemoDate | Date |  |  |
| postingDate | Date |  |  |
| dueDate | Date |  |  |
| customerId | Guid |  |  |
| customerNumber | String | 20 |  |
| customerName | String | 100 | Read-only |
| billToName | String | 100 | Read-only |
| billToCustomerId | Guid |  |  |
| billToCustomerNumber | String | 20 |  |
| sellToAddressLine1 | String | 100 |  |
| sellToAddressLine2 | String | 50 |  |
| sellToCity | String | 30 |  |
| sellToCountry | String | 10 |  |
| sellToState | String | 30 |  |
| sellToPostCode | String | 20 |  |
| billToAddressLine1 | String | 100 |  |
| billToAddressLine2 | String | 50 |  |
| billToCity | String | 30 |  |
| billToCountry | String | 10 |  |
| billToState | String | 30 |  |
| billToPostCode | String | 20 |  |
| postingDescription | String |  |  |
| shortcutDimension1Code | String | 20 |  |
| shortcutDimension2Code | String | 20 |  |
| currencyId | Guid |  |  |
| currencyCode | String |  |  |
| paymentTermsId | Guid |  |  |
| paymentMethodCode | String |  |  |
| shipmentMethodId | Guid |  |  |
| salesperson | String | 20 |  |
| pricesIncludeTax | Boolean |  | Read-only |
| discountAmount | Decimal |  |  |
| discountAppliedBeforeTax | Boolean |  | Read-only |
| totalAmountExcludingTax | Decimal |  | Read-only |
| totalTaxAmount | Decimal |  | Read-only |
| totalAmountIncludingTax | Decimal |  | Read-only |
| status | String |  | Read-only |
| posted | Boolean |  | Read-only |
| lastModifiedDateTime | DateTimeOffset |  | Read-only |
| invoiceId | Guid |  |  |
| invoiceNumber | String | 20 |  |
| phoneNumber | String | 30 |  |
| email | String | 80 |  |
| locationCode | String |  |  |
| userId | String |  |  |
| documentLink | String |  |  |
| documentNote | String |  |  |
| customerReturnReasonId | Guid |  |  |
| apiTotalAmountExclVAT | Decimal |  |  |
| apiTotalAmountInclVAT | Decimal |  |  |

**Related API's (expand)**

| Name | Type | Description |
| --- | --- | --- |
| customer | Microsoft.NAV.customer |  |
| dimensionValue | Microsoft.NAV.dimensionValue |  |
| dimensionSetLines | Collection(Microsoft.NAV.dimensionSetLine) |  |
| salesCreditMemoLines | Collection(Microsoft.NAV.salesCreditMemoLine) |  |
| pdfDocument | Microsoft.NAV.pdfDocument |  |
| attachments | Collection(Microsoft.NAV.attachment) |  |
| documentAttachments | Collection(Microsoft.NAV.documentAttachment) |  |