v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get Customer Credit Histories

get/accounting/credit_history

Query parameters

pageinteger

countinteger

sort'ASC' | 'DESC'

sort_by'created_at'

filter.customer_uidstring

Filter by Customers

filter.credit_note_uidstring

Filter by Credit Notes

filter.invoice_uidstring

Filter by Invoice

filter.estimate_uidstring

Filter by Estimate/Quote

filter.type'CREDIT' | 'DEBIT' | 'REFUND' | 'DELETE'

filter.from_datestring date

filter.to_datestring date

Response

200

typestring

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "credit_history_uid": "2ede6973-7dbb-468d-8829-6274a44aa160",
      "customer": {
        "customer_uid": "b96c9de9-8fa1-42b6-a37b-d94b5c460485",
        "customer_first_name": "Credits ",
        "customer_last_name": "review",
        "customer_email": "jayasoorya.zuper@gmail.com",
        "is_active": true,
        "created_at": "2025-04-08T08:43:48.499Z",
        "updated_at": "2025-04-16T13:28:08.459Z"
      },
      "opening_balance": 272593.56,
      "closing_balance": 272693.56,
      "applied_amount": 100,
      "type": "CREDIT",
      "remarks": "Credit Refund for invoice #8085",
      "created_by": {
        "user_uid": "57a967fe-30c1-41a6-a4e5-5a04c936",
        "first_name": "ABC",
        "last_name": "DEF",
        "email": "abc@def.com",
        "designation": "Admin",
        "emp_code": "Z200",
        "hourly_labor_charge": 20,
        "is_active": true,
        "created_at": "2023-09-08T07:13:05.000Z",
        "updated_at": "2025-04-18T09:41:48.000Z"
      },
      "created_at": "2025-04-16T12:25:34.753Z",
      "updated_at": "2025-04-16T12:25:34.756Z",
      "credit_note_data": {
        "credit_note_uid": "d9260e38-b373-47f7-9cd5-24a3d9e21f19",
        "credit_note_date": "2025-04-16T00:00:00.000Z",
        "total_amount": 100,
        "remaining_amount": 100,
        "remarks": "Credit Refund for invoice #8085",
        "status": "UNAPPLIED",
        "created_at": "2025-04-16T12:25:34.718Z",
        "updated_at": "2025-04-16T12:25:34.719Z",
        "credit_note_number": 296
      }
    }
  ],
  "total_records": 1,
  "current_page": 1,
  "total_pages": 1
}