XExentral
Credit Note

View Credit Note Balance

Returns balance information (documents, payments) for a single credit note

get/api/v1/creditNotes/{id}/balance

Request

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

Example response

{
  "data": {
    "documents": {
      "invoices": [
        {
          "id": "87",
          "amount": {
            "amount": "1483.63",
            "currency": "EUR"
          },
          "date": "2024-03-08T00:00:00+01:00"
        }
      ],
      "creditNotes": [
        {
          "id": "2",
          "amount": {
            "amount": "24.99",
            "currency": "EUR"
          },
          "date": "2024-06-17T00:00:00+02:00"
        }
      ]
    },
    "payments": []
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.