v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get All Credit Notes

get/accounting/credit_notes

Query parameters

pageinteger

countinteger

sort'ASC' | 'DESC'

sort_by'created_at' | 'credit_note_date'

filter.keywordstring

Keyword search for credit_note_number and remarks

filter.customer_uidstring

Filter by customers

filter.status'UNAPPLIED' | 'PARTIALLY_APPLIED' | 'APPLIED'

filter.from_datestring date

filter.end_datestring date

Response

200

typestring

total_remaining_credit_amountsnumber

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "credit_note_uid": "d2100749-3f19-4442-ae3a-219cd64b0e87",
      "credit_note_date": "2025-04-18T00:00:00.000Z",
      "module_name": "INVOICE",
      "total_amount": 31.4,
      "remaining_amount": 31.4,
      "status": "UNAPPLIED",
      "created_by": {
        "user_uid": "4c80fba6-ee19-47ce-9058-51479308f2",
        "first_name": "Jayasoorya",
        "last_name": "R",
        "email": "jayasoorya.r@zuper.co",
        "designation": "SE",
        "emp_code": "Z311",
        "prefix": "Z22",
        "hourly_labor_charge": 20,
        "is_active": true,
        "created_at": "2024-06-12T08:55:40.000Z",
        "updated_at": "2025-04-18T03:52:42.000Z"
      },
      "created_at": "2025-04-18T04:16:59.848Z",
      "updated_at": "2025-04-18T04:16:59.856Z",
      "credit_note_number": 333,
      "module_data": {
        "invoice_uid": "40313fa4-d035-4a8b-a4be-fa89cc7e5af1",
        "invoice_date": "2025-04-15T18:30:00.000Z",
        "invoice_status": "PARTIALLY_PAID",
        "created_at": "2025-04-16T12:16:21.089Z",
        "updated_at": "2025-04-18T04:16:59.938Z",
        "invoice_no": 8155
      }
    }
  ],
  "total_remaining_credit_amounts": 28456200.2637,
  "total_records": 250,
  "current_page": 1,
  "total_pages": 25
}