Sign in
latestOpenAPI 3.0.0Apache 2.02026-08-06199181.1 MB

e0d144609998

CreditNotes

List credit notes

List all credit notes

get/credit-notes

Query parameters

account_idinteger

Search Credit Notes by account Id

account_namestring

Search Credit Notes by account name

account_numberinteger

Search Credit Notes by account number

balance_duenumber float

Search Credit Notes by balance due

credit_note_datestring date

Search Credit Notes by credit note date

credit_note_numberstring

Search Credit Notes by credit note number

non_taxablenumber float

Search for non-taxable credit notes

organization_idstring

Search Credit Notes by organization id

refunds_madenumber float

Search Credit Notes by refunds made

statusstring

Search Credit Notes by status

sub_totalnumber float

Search Credit Notes by sub-total

sub_total_after_discountnumber float

Search Credit Notes by sub-total after discount

totalnumber float

Search Credit Notes by total

total_discountnumber float

Search Credit Notes by total discount

total_taxnumber float

Search Credit Notes by total tax

voucher_header_idinteger

Search Credit Notes by voucher header id

filtersobject

Filter Credit Notes by the above query parameters. <br /><b>Example:</b> { "total[gt]" : 6000 }

sort[asc]'balance_due' | 'credit_note_date' | 'credit_note_number' | 'refunds_made' | 'total'

Sort Credit Notes in ascending order

sort[desc]'balance_due' | 'credit_note_date' | 'credit_note_number' | 'refunds_made' | 'total'

Sort Credit Notes in descending order

pageinteger

The particular page to return

per_pageinteger

The number of items to return per page Default: 50 Limit: 200

Response

Successful operation

messagestring

Example response

{
  "message": "success.",
  "credit_note": [
    {
      "id": 358,
      "account": {
        "id": 403,
        "organization_id": "0005",
        "name": "Lexzur KSA",
        "account_label": "Lexzur KSA (SAR)",
        "account_type": "Third Party",
        "currency": "SAR",
        "organization": {
          "id": "0005",
          "name": "zatca",
          "country": "SA",
          "city": "Riyadh",
          "state": "Riyadh",
          "zip": "1000"
        }
      },
      "credit_note_number": "DRFT0000008",
      "bill_to": "Lexzur KSA",
      "credit_note_date": "2024-11-11 00:00:00",
      "paid_status": "draft",
      "total": 12369.79,
      "related_invoices": [
        {
          "id": 151,
          "invoice_date": "2024-11-11 00:00:00",
          "invoice_total": 20707.85,
          "invoice_number": "INV0000007",
          "balance_due": 20707.85
        }
      ],
      "credit_note_details": [
        {
          "id": 439,
          "item_title": "Corportation",
          "unit_price": 100,
          "quantity": 1,
          "discount_percentage": 20,
          "total": 80
        }
      ]
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 2,
    "next_page_url": "http://localhost/lexzur/api/v2/money/credit-notes?page=2",
    "total": 16,
    "count": 2
  }
}