Retrieve a credit note application through an invoice

Returns one credit note application by its id.

GET /invoices/{invoice_id}/credit_note_applications/{credit_note_application_id}

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/invoices/INV-0001/credit_note_applications/CNA-0001" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "credit_note_application": {
    "amount": 123,
    "created_by": {
      "id": "<string>",
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "credit_note": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "href": "<string>",
    "id": "<string>",
    "issue_date": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "object": "<string>",
    "payment": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "primaryId": 123,
    "refund": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "remaining_balance": 123,
    "status": "<string>",
    "version": 123
  }
}

Fetches a credit note application under credit_note_application. The server does not check that the application belongs to the invoice: any application is returned under any invoice that exists.

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.

Authorizations

Authorization · string · header · required

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

Path Parameters

invoice_id · string · required

The invoice's id, such as INV-0001. Not its uuid.

credit_note_application_id · string · required

The credit note application's id.

Response

200 - application/json

The credit note application, under credit_note_application.

credit_note_application · object

Show child attributes