Create a purchase credit note

Credits a purchase invoice and returns the new credit note under purchase_credit_note.

POST /purchase_credit_notes

cURL

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/purchase_credit_notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "purchase_credit_note": {
      "purchase_invoice_id": "PI-0001",
      "amount": "1.00"
    }
  }'

201

{
  "purchase_credit_note": {
    "activity_logs": [
      "<unknown>"
    ],
    "code": "<string>",
    "href": "<string>",
    "id": "<string>",
    "initial_amount": "<string>",
    "issue_date": "<string>",
    "object": "<string>",
    "remaining_amount": "<string>",
    "status": {
      "key": "<string>",
      "value": "<string>"
    },
    "version": 123
  }
}

Creates a purchase credit note against a purchase invoice, wrapped in purchase_credit_note with the invoice’s purchase_invoice_id and the amount. The credit is drawn from the invoice’s payments. The response is shorter than a read, and its status is an object with key and value.

Once created, a purchase credit note cannot be removed without extra permission, and the payment it draws on can no longer be deleted.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Body

application/json

purchase_credit_note · object · required

Show child attributes

Response

201 - application/json

The new purchase credit note, under purchase_credit_note.

purchase_credit_note · object

Show child attributes