XExentral
Credit Note

List credit notes

Returns a collection with all credit notes.

get/api/v1/creditNotes

Request

Query parameters

OR
{
  "id": [
    "17"
  ]
}
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'creditNote' | 'date' | 'customerName' | 'customerNumber' | 'country' | 'project' | 'paymentMethod' | 'amount' | 'currency' | 'paymentStatus' | 'status'
dir'asc' | 'desc'

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "17",
      "number": "2024-900000",
      "date": "2024-05-29",
      "status": "created",
      "amount": {
        "amount": "142.78",
        "currencyCode": "EUR"
      },
      "invoice": {
        "number": "2022-400085"
      },
      "address": {
        "id": "18",
        "name": "Richard E.",
        "customerNumber": "10011",
        "country": "DE"
      },
      "project": {
        "id": "5",
        "name": "Amazon FBM",
        "abbreviation": "FBM"
      },
      "payment": {
        "method": "shopify_payments",
        "status": "offen"
      },
      "paymentTransaction": {
        "id": "2",
        "paymentStatus": "recorded"
      },
      "updatedBy": {
        "id": "1337"
      },
      "updatedAt": "2021-12-15T11:31:44+01:00",
      "tags": [
        {
          "id": "1337",
          "name": "Active",
          "color": "ff0000"
        }
      ]
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}

Changes

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