{"title":"purchaseCreditMemo resource type","url":"https://jonas-paprotka.de/docs/dev-itpro/api-reference/v2.0/resources/dynamics_purchasecreditmemo/","by":"JOP-AL","license":"Copyright (c) Microsoft Corporation. CC BY 4.0, https://creativecommons.org/licenses/by/4.0/; code samples MIT. From https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_purchasecreditmemo, MicrosoftDocs/dynamics365smb-devitpro-pb at 828b6ee (2026-11-19). Changed: includes filled in, links to this site, and for agents shortened without dropping a fact.","credit":"Microsoft Corporation, CC BY 4.0","origin":"https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_purchasecreditmemo","source":{"name":"Business Central developer and IT pro docs","repo":"https://github.com/MicrosoftDocs/dynamics365smb-devitpro-pb","commit":"828b6ee72fcd75755627cd6011f3d20899217ab2","date":"2026-11-19"},"checked":"2026-11-19","description":"A purchase credit memo object in Dynamics 365 Business Central.","date":"2026-08-21","meta":{"topic":"reference"},"outline":[{"level":1,"title":"purchaseCreditMemo resource type","slug":"purchasecreditmemo-resource-type","at":0,"chars":6632},{"level":2,"title":"Methods","slug":"methods","at":248,"chars":473},{"level":2,"title":"Bound actions","slug":"bound-actions","at":721,"chars":769},{"level":2,"title":"Navigation","slug":"navigation","at":1490,"chars":1035},{"level":2,"title":"Properties","slug":"properties","at":2525,"chars":2417},{"level":2,"title":"JSON representation","slug":"json-representation","at":4942,"chars":1452},{"level":2,"title":"Related information","slug":"related-information","at":6394,"chars":238}],"text":"# purchaseCreditMemo resource type\nRepresents a purchase credit memo in Business Central.\n> NOTE\n> For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central<../enabling-apis-for-dynamics-nav>.\n## Methods\nMethod|Return Type|Description\n../api/dynamics_purchasecreditmemo_get|purchaseCreditMemo|Gets a purchase credit memo object.\n../api/dynamics_purchasecreditmemo_delete|none|Deletes a purchase credit memo object.\nPOST purchaseCreditMemo<../api/dynamics_purchasecreditmemo_create>|purchaseCreditMemo|Creates a purchase credit memo object.\nPATCH purchaseCreditMemo<../api/dynamics_purchasecreditmemo_update>|purchaseCreditMemo|Updates a purchase credit memo object.\n## Bound actions\nThe purchaseCreditMemo resource type offers a bound action called cancel, which cancels the corresponding purchaseCreditMemo batch.\nThis is illustrated in the following example:\n`CANCEL https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/purchaseCreditMemos({id})/Microsoft.NAV.cancel`\nThe response has no content; the response code is 204.\nThe purchaseCreditMemo resource type offers a bound action called post, which posts the corresponding purchaseCreditMemo batch.\nThis is illustrated in the following example:\n`POST https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/purchaseCreditMemos({id})/Microsoft.NAV.post`\nThe response has no content; the response code is 204.\n## Navigation\nNavigation|Return Type|Description\ndynamics_vendor|vendor|Gets the vendor of the purchaseCreditMemo.\ndynamics_dimensionvalue|dimensionValue|Gets the dimensionvalue of the purchaseCreditMemo.\ndynamics_currency|currency|Gets the currency of the purchaseCreditMemo.\ndynamics_paymentterm|paymentTerm|Gets the paymentterm of the purchaseCreditMemo.\ndynamics_shipmentmethod|shipmentMethod|Gets the shipmentmethod of the purchaseCreditMemo.\ndynamics_customerreturnreason|customerReturnReason|Gets the customerreturnreason of the purchaseCreditMemo.\ndynamics_dimensionsetline|dimensionSetLines|Gets the dimensionsetlines of the purchaseCreditMemo.\ndynamics_purchasecreditmemoline|purchaseCreditMemoLines|Gets the purchasecreditmemolines of the purchaseCreditMemo.\ndynamics_pdfdocument|pdfDocument|Gets the pdfdocument of the purchaseCreditMemo.\ndynamics_attachment|attachments|Gets the attachments of the purchaseCreditMemo.\ndynamics_documentattachment|documentAttachments|Gets the documentattachments of the purchaseCreditMemo.\n## Properties\n|Property|Type|Description|\n|id|GUID|The unique ID of the purchase credit memo. Non-editable.|\n|number|string|Specifies the number of the purchase credit memo.|\n|creditMemoDate|date|The credit memo date.|\n|postingDate|date|The date that the purchase credit memo is posted.|\n|dueDate|date|T he date the purchase credit memo is due.|\n|vendorId|GUID|The unique ID of vendor.|\n|vendorNumber|string|Specifies vendor's number.|\n|vendorName|string|Specifies vendor's name.|\n|vendorCreditMemoNumber|string||\n|payToVendorId|GUID|Pay to vendor id.|\n|payToVendorNumber|string|Pay to vendor number.|\n|payToName|string|Pay to name of the purchase credit memo.|\n|buyFromAddressLine1|string|Buy from address line 1.|\n|buyFromAddressLine2|string|Buy from address line 2.|\n|buyFromCity|string|Buy from city.|\n|buyFromCountry|string|Buy from state.|\n|buyFromState|string|Buy from state.|\n|buyFromPostCode|string|Buy from country.|\n|payToAddressLine1|string|Pay to address line 1.|\n|payToAddressLine2|string|Pay to address line 2.|\n|payToCity|string|Pay to address line 2.|\n|payToCountry|string|Pay to country.|\n|payToState|string|Pay to state.|\n|payToPostCode|string|Pay to post code.|\n|shortcutDimension1Code|string||\n|shortcutDimension2Code|string||\n|currencyId|GUID|Specifies which currency the purchase credit memo uses.|\n|currencyCode|string|The default currency code for the purchase credit memo.|\n|paymentTermsId|GUID|Specifies which payment term the purchase credit memo uses.|\n|shipmentMethodId|GUID|Specifies which shipment method the purchase credit memo uses.|\n|purchaser|string|The purchaser in the purchase credit memo.|\n|pricesIncludeTax|boolean|Specifies whether the prices include Tax or not. Read-Only.|\n|discountAmount|decimal|The purchase credit memo discount amount.|\n|discountAppliedBeforeTax|boolean|Specifies whether the discount is applied before tax.|\n|totalAmountExcludingTax|decimal|The total amount excluding tax. Read-Only.|\n|totalTaxAmount|decimal|The total tax amount for the purchase credit memo. Read-Only.|\n|totalAmountIncludingTax|decimal|The total amount including tax. Read-Only.|\n|status|NAV.purchCrMemoEntityStatus||\n|lastModifiedDateTime|datetime|The last datetime the purchase credit memo was modified. Read-Only.|\n|invoiceId|GUID|The unique ID of invoice.|\n|invoiceNumber|string|The sales invoice number that the purchase credit memo is linked to.|\n|vendorReturnReasonId|GUID||\n## JSON representation\nHere's a JSON representation of the purchaseCreditMemo resource.\n```json\n{\n    \"id\": \"GUID\",\n    \"number\": \"string\",\n    \"creditMemoDate\": \"date\",\n    \"postingDate\": \"date\",\n    \"dueDate\": \"date\",\n    \"vendorId\": \"GUID\",\n    \"vendorNumber\": \"string\",\n    \"vendorName\": \"string\",\n    \"vendorCreditMemoNumber\": \"string\",\n    \"payToVendorId\": \"GUID\",\n    \"payToVendorNumber\": \"string\",\n    \"payToName\": \"string\",\n    \"buyFromAddressLine1\": \"string\",\n    \"buyFromAddressLine2\": \"string\",\n    \"buyFromCity\": \"string\",\n    \"buyFromCountry\": \"string\",\n    \"buyFromState\": \"string\",\n    \"buyFromPostCode\": \"string\",\n    \"payToAddressLine1\": \"string\",\n    \"payToAddressLine2\": \"string\",\n    \"payToCity\": \"string\",\n    \"payToCountry\": \"string\",\n    \"payToState\": \"string\",\n    \"payToPostCode\": \"string\",\n    \"shortcutDimension1Code\": \"string\",\n    \"shortcutDimension2Code\": \"string\",\n    \"currencyId\": \"GUID\",\n    \"currencyCode\": \"string\",\n    \"paymentTermsId\": \"GUID\",\n    \"shipmentMethodId\": \"GUID\",\n    \"purchaser\": \"string\",\n    \"pricesIncludeTax\": \"boolean\",\n    \"discountAmount\": \"decimal\",\n    \"discountAppliedBeforeTax\": \"boolean\",\n    \"totalAmountExcludingTax\": \"decimal\",\n    \"totalTaxAmount\": \"decimal\",\n    \"totalAmountIncludingTax\": \"decimal\",\n    \"status\": \"NAV.purchCrMemoEntityStatus\",\n    \"lastModifiedDateTime\": \"datetime\",\n    \"invoiceId\": \"GUID\",\n    \"invoiceNumber\": \"string\",\n    \"vendorReturnReasonId\": \"GUID\"\n}\n```\n## Related information\n../api/dynamics_purchasecreditmemo_get\n../api/dynamics_purchasecreditmemo_delete\nPOST purchaseCreditMemo<../api/dynamics_purchasecreditmemo_create>\nPATCH purchaseCreditMemo<../api/dynamics_purchasecreditmemo_update>"}