Skip to main content
GET
/
payables
/
outstanding
Outstanding payables
const options = {method: 'GET'};

fetch('https://api.dolfinai.co/payables/outstanding', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "totals": {
    "supplierCount": 123,
    "billCount": 123,
    "toPayByCurrency": [
      {
        "currency": "<string>",
        "amount": 123,
        "count": 123
      }
    ],
    "notYetDueByCurrency": [
      {
        "currency": "<string>",
        "amount": 123,
        "count": 123
      }
    ],
    "overdueByCurrency": [
      {
        "currency": "<string>",
        "amount": 123,
        "count": 123
      }
    ],
    "dueWithin7DaysByCurrency": [
      {
        "currency": "<string>",
        "amount": 123,
        "count": 123
      }
    ],
    "inReviewByCurrency": [
      {
        "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
        }
      }
    }
  ],
  "suppliers": [
    {
      "supplierName": "<string>",
      "currency": "<string>",
      "supplierId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "totalToPay": 123,
      "overdueAmount": 123,
      "notYetDueAmount": 123,
      "billCount": 123,
      "maxDaysOverdue": 123,
      "oldestBill": {
        "state": "<string>",
        "billId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoiceNumber": "<string>",
        "totalAmount": 123,
        "dueDate": "2023-12-25",
        "daysOverdue": 123
      },
      "billIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

Query Parameters

asOf
string<date>

Response

200 - application/json

OK

totals
object
required
recommendation
object
required
asOf
string<date>
aging
object[]
suppliers
object[]

One row per supplier per currency — a supplier billing in multiple currencies appears once per currency. Amounts are never summed across currencies. Org default currency rows first, largest to-pay first within each currency.