API reference / Receivables
Receivables API
4 endpoints. Scopes: Scalar360.receivables.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.
GET
Get receivables aging
/api/v1/receivables/aging
Scope: Scalar360.receivables.READ
| Parameter | In | Type | Required |
|---|---|---|---|
customerId | query | string (uuid) | No |
curl -X GET "https://api.scalar360.com/api/v1/receivables/aging" \
-H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"GET
Get receivables by customer
/api/v1/receivables/by-customer
Scope: Scalar360.receivables.READ
| Parameter | In | Type | Required |
|---|---|---|---|
customerId | query | string (uuid) | No |
q | query | string | No |
filter | query | string (default all) | No |
sortBy | query | string | No |
sortDir | query | string (default desc) | No |
page | query | integer | No |
pageSize | query | integer | No |
startDate | query | string (date) | No |
endDate | query | string (date) | No |
curl -X GET "https://api.scalar360.com/api/v1/receivables/by-customer" \
-H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"GET
Get receivable invoices
/api/v1/receivables/invoices
Scope: Scalar360.receivables.READ
| Parameter | In | Type | Required |
|---|---|---|---|
customerId | query | string (uuid) | No |
status | query | string | No |
overdue | query | boolean | No |
curl -X GET "https://api.scalar360.com/api/v1/receivables/invoices" \
-H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"GET
Get receivables summary
/api/v1/receivables/summary
Scope: Scalar360.receivables.READ
| Parameter | In | Type | Required |
|---|---|---|---|
startDate | query | string (date) | No |
endDate | query | string (date) | No |
curl -X GET "https://api.scalar360.com/api/v1/receivables/summary" \
-H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"