APIAR Agings

The AR Aging object

An extracted accounts receivable aging report, in summary or detail form.

The retrieve endpoint returns this object on its own. The list endpoint returns one per document, wrapped as { "borrower_id": …, "agings": [ { "extracted_document_id", "document_category", "report_data" } ] }, and takes ?form=summary or ?form=detail to keep one form.

Attributes

  • document_type and report_subtype: the aging’s form, summary or detail.
  • company_name, as_of_date, currency: whose aging it is, as of when, and in what currency.
  • customers: one row per customer, carrying the aging buckets as printed (current, bucket_1_30, bucket_31_60, bucket_61_90, bucket_91_plus) and the row total.
  • grand_totals: the totals the document prints.
  • computed_totals: the same totals SpreadSpace recomputes from the rows, so printed and computed can be compared.
  • bucket_columns: the document’s own bucket layout, when it differs from the standard buckets.
  • status: the state of this extraction.
  • anomalies: notes SpreadSpace recorded about this document.

Typical document_category values: accounts_receivable_summary, accounts_receivable_detail.

Money and date values follow the export value conventions, documented under Getting Started.