Create a credit note

Credits an invoice by an amount and creates a credit note.

POST /credit_notes

cURL

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/credit_notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "credit_note": {
      "invoice_id": "INV-0001",
      "amount": 5
    }
  }'

400

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Creates a credit note for an invoice. The body takes only invoice_id and amount under credit_note; any other key returns 400. The amount is drawn from the invoice’s active payments, oldest first. Creating a credit note schedules the CREDIT_NOTE_ISSUED communication.

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

credit_note · object · required

Show child attributes

Response

201

The credit note is created.