GET
/
ext
/
v1
/
credit-notes
List credit notes
curl --request GET \
  --url https://api.light.inc/rest/ext/v1/credit-notes
{
  "total": 123,
  "records": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "businessPartnerName": "<string>",
      "businessPartnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "DRAFT",
      "description": "<string>",
      "currency": "USD",
      "postingDate": "2023-12-25",
      "documentDate": "2023-12-25",
      "valuationDate": "2023-12-25",
      "areLinesWithTax": true,
      "lines": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "creditNoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "grossTransactionAmount": {
            "amount": 123,
            "dcSign": "D"
          },
          "netTransactionAmount": {
            "amount": 123,
            "dcSign": "D"
          },
          "description": "<string>",
          "ledgerTaxId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "taxTransactionAmount": {
            "amount": 123,
            "dcSign": "D"
          },
          "ledgerAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "costCenterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "senderEmail": "<string>",
      "documentName": "<string>"
    }
  ]
}

Query Parameters

​
sort
string
Example:

"amount:desc,createdAt:asc"

​
filter
string
Example:

"state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500"

​
limit
integer
​
offset
integer
​
searchTerm
string

Response

default - application/json;charset=UTF-8

default response

The response is of type object.