Edit

Share via

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

Method Return Type Description
GET purchaseCreditMemo purchaseCreditMemo Gets a purchase credit memo object.
DELETE purchaseCreditMemo none Deletes a purchase credit memo object.
POST purchaseCreditMemo purchaseCreditMemo Creates a purchase credit memo object.
PATCH purchaseCreditMemo purchaseCreditMemo Updates 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.

Navigation Return Type Description
vendor vendor Gets the vendor of the purchaseCreditMemo.
dimensionValue dimensionValue Gets the dimensionvalue of the purchaseCreditMemo.
currency currency Gets the currency of the purchaseCreditMemo.
paymentTerm paymentTerm Gets the paymentterm of the purchaseCreditMemo.
shipmentMethod shipmentMethod Gets the shipmentmethod of the purchaseCreditMemo.
customerReturnReason customerReturnReason Gets the customerreturnreason of the purchaseCreditMemo.
dimensionSetLines dimensionSetLines Gets the dimensionsetlines of the purchaseCreditMemo.
purchaseCreditMemoLines purchaseCreditMemoLines Gets the purchasecreditmemolines of the purchaseCreditMemo.
pdfDocument pdfDocument Gets the pdfdocument of the purchaseCreditMemo.
attachments attachments Gets the attachments of the purchaseCreditMemo.
documentAttachments documentAttachments Gets the documentattachments of the purchaseCreditMemo.

Properties

Property Type Description
id GUID The unique ID of the purchase credit memo. Non-editable.
number string Specifies the number of the purchase credit memo.
creditMemoDate date The credit memo date.
postingDate date The date that the purchase credit memo is posted.
dueDate date T he date the purchase credit memo is due.
vendorId GUID The unique ID of vendor.
vendorNumber string Specifies vendor's number.
vendorName string Specifies vendor's name.
vendorCreditMemoNumber string
payToVendorId GUID Pay to vendor id.
payToVendorNumber string Pay to vendor number.
payToName string Pay to name of the purchase credit memo.
buyFromAddressLine1 string Buy from address line 1.
buyFromAddressLine2 string Buy from address line 2.
buyFromCity string Buy from city.
buyFromCountry string Buy from state.
buyFromState string Buy from state.
buyFromPostCode string Buy from country.
payToAddressLine1 string Pay to address line 1.
payToAddressLine2 string Pay to address line 2.
payToCity string Pay to address line 2.
payToCountry string Pay to country.
payToState string Pay to state.
payToPostCode string Pay to post code.
shortcutDimension1Code string
shortcutDimension2Code string
currencyId GUID Specifies which currency the purchase credit memo uses.
currencyCode string The default currency code for the purchase credit memo.
paymentTermsId GUID Specifies which payment term the purchase credit memo uses.
shipmentMethodId GUID Specifies which shipment method the purchase credit memo uses.
purchaser string The purchaser in the purchase credit memo.
pricesIncludeTax boolean Specifies whether the prices include Tax or not. Read-Only.
discountAmount decimal The purchase credit memo discount amount.
discountAppliedBeforeTax boolean Specifies whether the discount is applied before tax.
totalAmountExcludingTax decimal The total amount excluding tax. Read-Only.
totalTaxAmount decimal The total tax amount for the purchase credit memo. Read-Only.
totalAmountIncludingTax decimal The total amount including tax. Read-Only.
status NAV.purchCrMemoEntityStatus
lastModifiedDateTime datetime The last datetime the purchase credit memo was modified. Read-Only.
invoiceId GUID The unique ID of invoice.
invoiceNumber string The sales invoice number that the purchase credit memo is linked to.
vendorReturnReasonId GUID

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