Sign in
Reports

Aged debtors report

Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time.

get/companies/{companyId}/reports/agedDebtor

Query parameters

reportDatestring date
Example:2022-12-31

Date the report is generated up to.

numberOfPeriodsinteger
Example:12

Number of periods to include in the report.

periodLengthDaysinteger
Example:30

The length of period in days.

Response

OK

generatedstring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

reportDatestring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

dataAgedDebtor[] — unresolved $ref

Array of aged debtors.

Example response

{
  "generated": "2022-10-23T00:00:00Z",
  "reportDate": "2022-10-23T00:00:00Z",
  "data": [
    {
      "customerId": "f594cefb-7750-4c3a-bab2-b5322026dee9",
      "customerName": "John Doe",
      "agedCurrencyOutstanding": [
        {
          "currency": "GBP",
          "agedOutstandingAmounts": [
            {
              "fromDate": "2022-10-01T00:00:00Z",
              "toDate": "2022-10-31T00:00:00Z",
              "amount": 1547.5,
              "details": [
                {
                  "name": "Invoices",
                  "amount": 1547.5
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Changes

Changed in 1 of the 51 revisions of this API.7

  • 4bfab0afa6ca7See the full diff
    • ○

      added the optional property validation to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 402 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 503 status

      response-optional-property-added