Company Debt (All Companies)
GET {{baseUrl}}/cas/companies/debts?offset={{offset}}&limit={{limit}}
This endpoint is based on the logic used in the Company Debt alert on the Companies screen. It will return the Company Debt Status for each company.
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|
| offset | number | Required | Example = 0 |
| limit | number | Required | Example = 500 |
Response Body
| Key | Type | Description |
|---|
| companyId | String | existing Company Id |
| debtNowDue | number | debt currently due |
| futureDebt | number | debt that has greater than 30 days before the due date |
| overdue0to30 | number | amounts overdue by 0-30 days |
| overdue31to60 | number | amounts overdue by 31-60 days |
| overdue61to90 | number | amounts overdue by 61-90 days |
| overdue90 | number | amounts overdue by over 90 days |
| totalOwing | number | Text |
Request Params
| Key | Datatype | Required | Description |
|---|
offset | string | | Required |
limit | string | | Required |
| Key | Datatype | Required | Description |
|---|
Authorization | string | | |
RESPONSES
status: OK
{"companyDebts":[{"companyId":"00c5cda8-a3ce-44a1-a7f4-02792f320bb2","debtNowDue":1123123,"futureDebt":0,"overdue0to30":0,"overdue31to60":0,"overdue61to90":0,"overdue90":0,"totalOwing":1123123},{"companyId":"0750ce41-53a7-49f4-9ddc-bfbe32099784","debtNowDue":0,"futureDebt":0,"overdue0to30":482,"overdue31to60":0,"overdue61to90":323,"overdue90":844,"totalOwing":1649}],"limit":2,"offset":0,"total":2}