purchaseCreditMemo resource type

Represents a purchase 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 purchaseCreditMemopurchaseCreditMemoGets a purchase credit memo object.
DELETE purchaseCreditMemononeDeletes a purchase credit memo object.
POST purchaseCreditMemopurchaseCreditMemoCreates a purchase credit memo object.
PATCH purchaseCreditMemopurchaseCreditMemoUpdates a purchase credit memo object.

Bound actions

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

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

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

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

NavigationReturn TypeDescription
vendorvendorGets the vendor of the purchaseCreditMemo.
dimensionValuedimensionValueGets the dimensionvalue of the purchaseCreditMemo.
currencycurrencyGets the currency of the purchaseCreditMemo.
paymentTermpaymentTermGets the paymentterm of the purchaseCreditMemo.
shipmentMethodshipmentMethodGets the shipmentmethod of the purchaseCreditMemo.
customerReturnReasoncustomerReturnReasonGets the customerreturnreason of the purchaseCreditMemo.
dimensionSetLinesdimensionSetLinesGets the dimensionsetlines of the purchaseCreditMemo.
purchaseCreditMemoLinespurchaseCreditMemoLinesGets the purchasecreditmemolines of the purchaseCreditMemo.
pdfDocumentpdfDocumentGets the pdfdocument of the purchaseCreditMemo.
attachmentsattachmentsGets the attachments of the purchaseCreditMemo.
documentAttachmentsdocumentAttachmentsGets the documentattachments of the purchaseCreditMemo.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the purchase credit memo. Non-editable.
numberstringSpecifies the number of the purchase credit memo.
creditMemoDatedateThe credit memo date.
postingDatedateThe date that the purchase credit memo is posted.
dueDatedateT he date the purchase credit memo is due.
vendorIdGUIDThe unique ID of vendor.
vendorNumberstringSpecifies vendor's number.
vendorNamestringSpecifies vendor's name.
vendorCreditMemoNumberstring
payToVendorIdGUIDPay to vendor id.
payToVendorNumberstringPay to vendor number.
payToNamestringPay to name of the purchase credit memo.
buyFromAddressLine1stringBuy from address line 1.
buyFromAddressLine2stringBuy from address line 2.
buyFromCitystringBuy from city.
buyFromCountrystringBuy from state.
buyFromStatestringBuy from state.
buyFromPostCodestringBuy from country.
payToAddressLine1stringPay to address line 1.
payToAddressLine2stringPay to address line 2.
payToCitystringPay to address line 2.
payToCountrystringPay to country.
payToStatestringPay to state.
payToPostCodestringPay to post code.
shortcutDimension1Codestring
shortcutDimension2Codestring
currencyIdGUIDSpecifies which currency the purchase credit memo uses.
currencyCodestringThe default currency code for the purchase credit memo.
paymentTermsIdGUIDSpecifies which payment term the purchase credit memo uses.
shipmentMethodIdGUIDSpecifies which shipment method the purchase credit memo uses.
purchaserstringThe purchaser in the purchase credit memo.
pricesIncludeTaxbooleanSpecifies whether the prices include Tax or not. Read-Only.
discountAmountdecimalThe purchase 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 purchase credit memo. Read-Only.
totalAmountIncludingTaxdecimalThe total amount including tax. Read-Only.
statusNAV.purchCrMemoEntityStatus
lastModifiedDateTimedatetimeThe last datetime the purchase credit memo was modified. Read-Only.
invoiceIdGUIDThe unique ID of invoice.
invoiceNumberstringThe sales invoice number that the purchase credit memo is linked to.
vendorReturnReasonIdGUID

JSON representation

Here's a JSON representation of the purchaseCreditMemo resource.

{
    "id": "GUID",
    "number": "string",
    "creditMemoDate": "date",
    "postingDate": "date",
    "dueDate": "date",
    "vendorId": "GUID",
    "vendorNumber": "string",
    "vendorName": "string",
    "vendorCreditMemoNumber": "string",
    "payToVendorId": "GUID",
    "payToVendorNumber": "string",
    "payToName": "string",
    "buyFromAddressLine1": "string",
    "buyFromAddressLine2": "string",
    "buyFromCity": "string",
    "buyFromCountry": "string",
    "buyFromState": "string",
    "buyFromPostCode": "string",
    "payToAddressLine1": "string",
    "payToAddressLine2": "string",
    "payToCity": "string",
    "payToCountry": "string",
    "payToState": "string",
    "payToPostCode": "string",
    "shortcutDimension1Code": "string",
    "shortcutDimension2Code": "string",
    "currencyId": "GUID",
    "currencyCode": "string",
    "paymentTermsId": "GUID",
    "shipmentMethodId": "GUID",
    "purchaser": "string",
    "pricesIncludeTax": "boolean",
    "discountAmount": "decimal",
    "discountAppliedBeforeTax": "boolean",
    "totalAmountExcludingTax": "decimal",
    "totalTaxAmount": "decimal",
    "totalAmountIncludingTax": "decimal",
    "status": "NAV.purchCrMemoEntityStatus",
    "lastModifiedDateTime": "datetime",
    "invoiceId": "GUID",
    "invoiceNumber": "string",
    "vendorReturnReasonId": "GUID"
}

GET purchaseCreditMemo DELETE purchaseCreditMemo POST purchaseCreditMemo PATCH purchaseCreditMemo