Edit

Share via

Create purchaseCreditMemos

  • Article

Creates a purchase credit memo in Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

POST businesscentralPrefix/companies({id})/purchaseCreditMemos({id})

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json
If-Match Required. When this request header is included and the eTag provided does not match the current tag on the purchaseCreditMemo, the purchaseCreditMemo will not be updated.

Request body

In the request body, supply a JSON representation of a purchaseCreditMemo object.

Response

If successful, this method returns 201 Created response code and a purchaseCreditMemo object in the response body.

Example

Request

Here is an example of the request.

POST https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseCreditMemos({id})
Content-type: application/json
{
    "id" : "",
    "number" : "",
    "creditMemoDate" : "",
    "postingDate" : "",
    "dueDate" : "",
    "vendorId" : "",
    "vendorNumber" : "",
    "vendorName" : "",
    "payToVendorId" : "",
    "payToVendorNumber" : "",
    "payToName" : "",
    "buyFromAddressLine1" : "",
    "buyFromAddressLine2" : "",
    "buyFromCity" : "",
    "buyFromCountry" : "",
    "buyFromState" : "",
    "buyFromPostCode" : "",
    "payToAddressLine1" : "",
    "payToAddressLine2" : "",
    "payToCity" : "",
    "payToCountry" : "",
    "payToState" : "",
    "payToPostCode" : "",
    "shortcutDimension1Code" : "",
    "shortcutDimension2Code" : "",
    "currencyId" : "",
    "currencyCode" : "",
    "paymentTermsId" : "",
    "shipmentMethodId" : "",
    "purchaser" : "",
    "pricesIncludeTax" : "",
    "discountAmount" : "",
    "discountAppliedBeforeTax" : "",
    "totalAmountExcludingTax" : "",
    "totalTaxAmount" : "",
    "totalAmountIncludingTax" : "",
    "status" : "",
    "lastModifiedDateTime" : "",
    "invoiceId" : "",
    "invoiceNumber" : "",
    "vendorReturnReasonId" : ""
}

Response

Here is an example of the response.

HTTP/1.1 201 Created
Content-type: application/json
{
    "id" : "",
    "number" : "",
    "creditMemoDate" : "",
    "postingDate" : "",
    "dueDate" : "",
    "vendorId" : "",
    "vendorNumber" : "",
    "vendorName" : "",
    "payToVendorId" : "",
    "payToVendorNumber" : "",
    "payToName" : "",
    "buyFromAddressLine1" : "",
    "buyFromAddressLine2" : "",
    "buyFromCity" : "",
    "buyFromCountry" : "",
    "buyFromState" : "",
    "buyFromPostCode" : "",
    "payToAddressLine1" : "",
    "payToAddressLine2" : "",
    "payToCity" : "",
    "payToCountry" : "",
    "payToState" : "",
    "payToPostCode" : "",
    "shortcutDimension1Code" : "",
    "shortcutDimension2Code" : "",
    "currencyId" : "",
    "currencyCode" : "",
    "paymentTermsId" : "",
    "shipmentMethodId" : "",
    "purchaser" : "",
    "pricesIncludeTax" : "",
    "discountAmount" : "",
    "discountAppliedBeforeTax" : "",
    "totalAmountExcludingTax" : "",
    "totalTaxAmount" : "",
    "totalAmountIncludingTax" : "",
    "status" : "",
    "lastModifiedDateTime" : "",
    "invoiceId" : "",
    "invoiceNumber" : "",
    "vendorReturnReasonId" : ""
}

Tips for working with the APIs
purchaseCreditMemo
GET purchaseCreditMemo
DELETE purchaseCreditMemo
PATCH purchaseCreditMemo