AlmondTill/G3N API

On this page

arAging

query · in the family Reading your records

What it does

The aging report — who owes what, and for how long (30/60/90 buckets).

The receivables aging report: the 5 fixed buckets (not_yet_due / 1-30 / 31-60 / 61-90 / 90+ days past dueAt — raw-UTC day math, the LIVE posture) over OPEN charges via the O(open) frontier walk (the head at its cached partial, later charges at face), each {count, totalMinor}, + asOf + arCurrency + the cached balance (Σ buckets == arBalanceMinor BY CONSTRUCTION). With arLedger this IS the lock's aging/statements DATA plane (statement DOCUMENTS + dunning =). Requires authentication; tenant-scoped server-side.

What happens

Reads only.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
orgCustomerIdID ID!yesNo further notes.

Returns

ArAgingReport ArAgingReport! — The arAging report.

Example request

query ExampleArAging($orgCustomerId: ID!) {
  arAging(orgCustomerId: $orgCustomerId) {
    orgCustomerId
    asOf
    arCurrency
    arBalanceMinor
  }
}

Variables:

{
  "orgCustomerId": "01900000-0000-7000-8000-ba56ff800000"
}

Example response

{
  "data": {
    "arAging": {
      "orgCustomerId": "01900000-0000-7000-8000-ba56ff800000",
      "asOf": "<as of>",
      "arCurrency": "<ar currency>",
      "arBalanceMinor": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in