Outstanding receivables
const options = {method: 'GET'};
fetch('https://api.dolfinai.co/receivables/outstanding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"totals": {
"customerCount": 123,
"invoiceCount": 123,
"outstandingByCurrency": [
{
"currency": "<string>",
"amount": 123,
"count": 123
}
],
"notYetDueByCurrency": [
{
"currency": "<string>",
"amount": 123,
"count": 123
}
],
"overdueByCurrency": [
{
"currency": "<string>",
"amount": 123,
"count": 123
}
]
},
"recommendation": {
"headline": "<string>",
"action": "<string>",
"nextTool": "<string>"
},
"asOf": "2023-12-25",
"aging": [
{
"currency": "<string>",
"buckets": {
"current": {
"amount": 123,
"count": 123
},
"d1To30": {
"amount": 123,
"count": 123
},
"d31To60": {
"amount": 123,
"count": 123
},
"d61To90": {
"amount": 123,
"count": 123
},
"d90Plus": {
"amount": 123,
"count": 123
}
}
}
],
"customers": [
{
"customerName": "<string>",
"currency": "<string>",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalOutstanding": 123,
"overdueAmount": 123,
"notYetDueAmount": 123,
"invoiceCount": 123,
"maxDaysOverdue": 123,
"oldestInvoice": {
"status": "<string>",
"invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceNumber": "<string>",
"totalAmount": 123,
"outstanding": 123,
"dueDate": "2023-12-25",
"daysOverdue": 123
},
"invoiceIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
]
}Outstanding receivables
Everything the organisation is owed (issued, not fully paid), aged into buckets and grouped by customer, with per-currency totals and a recommendation.
GET
/
receivables
/
outstanding
Outstanding receivables
const options = {method: 'GET'};
fetch('https://api.dolfinai.co/receivables/outstanding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"totals": {
"customerCount": 123,
"invoiceCount": 123,
"outstandingByCurrency": [
{
"currency": "<string>",
"amount": 123,
"count": 123
}
],
"notYetDueByCurrency": [
{
"currency": "<string>",
"amount": 123,
"count": 123
}
],
"overdueByCurrency": [
{
"currency": "<string>",
"amount": 123,
"count": 123
}
]
},
"recommendation": {
"headline": "<string>",
"action": "<string>",
"nextTool": "<string>"
},
"asOf": "2023-12-25",
"aging": [
{
"currency": "<string>",
"buckets": {
"current": {
"amount": 123,
"count": 123
},
"d1To30": {
"amount": 123,
"count": 123
},
"d31To60": {
"amount": 123,
"count": 123
},
"d61To90": {
"amount": 123,
"count": 123
},
"d90Plus": {
"amount": 123,
"count": 123
}
}
}
],
"customers": [
{
"customerName": "<string>",
"currency": "<string>",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalOutstanding": 123,
"overdueAmount": 123,
"notYetDueAmount": 123,
"invoiceCount": 123,
"maxDaysOverdue": 123,
"oldestInvoice": {
"status": "<string>",
"invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceNumber": "<string>",
"totalAmount": 123,
"outstanding": 123,
"dueDate": "2023-12-25",
"daysOverdue": 123
},
"invoiceIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
]
}Query Parameters
Response
200 - application/json
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
One row per customer per currency — a customer invoicing in multiple currencies appears once per currency. Amounts are never summed across currencies. Org default currency rows first, largest outstanding first within each currency.
Show child attributes
Show child attributes
⌘I