salesCreditMemo resource type

Represents a sales credit memo in Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET salesCreditMemosalesCreditMemoGets a sales credit memo object.
DELETE salesCreditMemononeDeletes a sales credit memo object.
POST salesCreditMemosalesCreditMemoCreates a sales credit memo object.
PATCH salesCreditMemosalesCreditMemoUpdates a sales credit memo object.

Bound actions

The salesCreditMemo resource type offers a bound action called cancelAndSend, which cancels and sends the corresponding salesCreditMemo batch. This is illustrated in the following example: CANCELANDSEND https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/salesCreditMemos({id})/Microsoft.NAV.cancelAndSend

The response has no content; the response code is 204.

The salesCreditMemo resource type offers a bound action called cancel, which cancels the corresponding salesCreditMemo batch. This is illustrated in the following example: CANCEL https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/salesCreditMemos({id})/Microsoft.NAV.cancel

The response has no content; the response code is 204.

The salesCreditMemo resource type offers a bound action called post, which posts the corresponding salesCreditMemo batch. This is illustrated in the following example: POST https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/salesCreditMemos({id})/Microsoft.NAV.post

The response has no content; the response code is 204.

The salesCreditMemo resource type offers a bound action called postAndSend, which posts and sends the corresponding salesCreditMemo batch. This is illustrated in the following example: POSTANDSEND https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/salesCreditMemos({id})/Microsoft.NAV.postAndSend

The response has no content; the response code is 204.

The salesCreditMemo resource type offers a bound action called send, which sends the corresponding salesCreditMemo batch. This is illustrated in the following example: SEND https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/salesCreditMemos({id})/Microsoft.NAV.send

The response has no content; the response code is 204.

NavigationReturn TypeDescription
customercustomerGets the customer of the salesCreditMemo.
dimensionValuedimensionValueGets the dimensionvalue of the salesCreditMemo.
currencycurrencyGets the currency of the salesCreditMemo.
paymentTermpaymentTermGets the paymentterm of the salesCreditMemo.
shipmentMethodshipmentMethodGets the shipmentmethod of the salesCreditMemo.
customerReturnReasoncustomerReturnReasonGets the customerreturnreason of the salesCreditMemo.
dimensionSetLinesdimensionSetLinesGets the dimensionsetlines of the salesCreditMemo.
salesCreditMemoLinessalesCreditMemoLinesGets the salescreditmemolines of the salesCreditMemo.
pdfDocumentpdfDocumentGets the pdfdocument of the salesCreditMemo.
attachmentsattachmentsGets the attachments of the salesCreditMemo.
documentAttachmentsdocumentAttachmentsGets the documentattachments of the salesCreditMemo.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sales credit memo. Non-editable.
numberstringSpecifies the number of the sales credit memo.
externalDocumentNumberstringSpecifies an external document number for the sales credit memo.
creditMemoDatedateThe credit memo date.
postingDatedateThe date that the sales credit memo is posted.
dueDatedateT he date the sales credit memo is due.
customerIdGUIDThe unique ID of customer.
customerNumberstringThe customer's number.
customerNamestringThe customer's name.
billToNamestringBill to name.
billToCustomerIdGUIDBill to customer id.
billToCustomerNumberstringBill to customer number.
sellToAddressLine1stringSell to address line 1.
sellToAddressLine2stringSell to address line 2.
sellToCitystringSell to city.
sellToCountrystringSell to country.
sellToStatestringSell to state.
sellToPostCodestringSell to post code.
billToAddressLine1stringBill to address line 1.
billToAddressLine2stringBill to address line 2.
billToCitystringBill to city.
billToCountrystringBill to country.
billToStatestringBill to state.
billToPostCodestringBill to post code.
shortcutDimension1Codestring
shortcutDimension2Codestring
currencyIdGUIDSpecifies which currency the sales credit memo uses.
currencyCodestringThe default currency code for the sales credit memo.
paymentTermsIdGUIDSpecifies which payment term the sales credit memo uses.
shipmentMethodIdGUIDSpecifies which shipment method the sales credit memo uses.
salespersonstringThe salesperson code for the sales credit memo.
pricesIncludeTaxbooleanSpecifies whether the prices include Tax or not. Read-Only.
discountAmountdecimalThe sales credit memo discount amount.
discountAppliedBeforeTaxbooleanSpecifies whether the discount is applied before tax.
totalAmountExcludingTaxdecimalThe total amount excluding tax. Read-Only.
totalTaxAmountdecimalThe total tax amount for the sales credit memo. Read-Only.
totalAmountIncludingTaxdecimalThe total amount including tax. Read-Only.
statusNAV.salesCrMemoEntityBufferStatusSpecifies the status of the sales credit memo. It can be "Draft" , "In Review", "Open", "Canceled", "Corrective", or "Paid".
lastModifiedDateTimedatetimeThe last datetime the sales credit memo was modified. Read-Only.
invoiceIdGUIDThe unique ID of invoice.
invoiceNumberstringThe sales invoice number that the sales credit memo is linked to.
phoneNumberstringSpecifies the sales credit memo's telephone number.
emailstringSpecifies the sales credit memo's email address.
customerReturnReasonIdGUID

JSON representation

Here's a JSON representation of the salesCreditMemo resource.

{
    "id": "GUID",
    "number": "string",
    "externalDocumentNumber": "string",
    "creditMemoDate": "date",
    "postingDate": "date",
    "dueDate": "date",
    "customerId": "GUID",
    "customerNumber": "string",
    "customerName": "string",
    "billToName": "string",
    "billToCustomerId": "GUID",
    "billToCustomerNumber": "string",
    "sellToAddressLine1": "string",
    "sellToAddressLine2": "string",
    "sellToCity": "string",
    "sellToCountry": "string",
    "sellToState": "string",
    "sellToPostCode": "string",
    "billToAddressLine1": "string",
    "billToAddressLine2": "string",
    "billToCity": "string",
    "billToCountry": "string",
    "billToState": "string",
    "billToPostCode": "string",
    "shortcutDimension1Code": "string",
    "shortcutDimension2Code": "string",
    "currencyId": "GUID",
    "currencyCode": "string",
    "paymentTermsId": "GUID",
    "shipmentMethodId": "GUID",
    "salesperson": "string",
    "pricesIncludeTax": "boolean",
    "discountAmount": "decimal",
    "discountAppliedBeforeTax": "boolean",
    "totalAmountExcludingTax": "decimal",
    "totalTaxAmount": "decimal",
    "totalAmountIncludingTax": "decimal",
    "status": "NAV.salesCrMemoEntityBufferStatus",
    "lastModifiedDateTime": "datetime",
    "invoiceId": "GUID",
    "invoiceNumber": "string",
    "phoneNumber": "string",
    "email": "string",
    "customerReturnReasonId": "GUID"
}

GET salesCreditMemo
DELETE salesCreditMemo
POST salesCreditMemo
PATCH salesCreditMemo