Edit

Share via

Get purchaseCreditMemos

  • Article

Retrieves the properties and relationships of a purchase credit memo object for Business Central.

HTTP request

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

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

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

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

Example

Request

Here is an example of the request.

GET https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseCreditMemos({id})

Response

Here is an example of the response.

{
    "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
DELETE purchaseCreditMemo
POST purchaseCreditMemo
PATCH purchaseCreditMemo