Billing

Customer account statement (dated activity ledger, balances, and aging) for a period

post/api/v1/billing.customers.statement.get

Request

  • Base URL: https://api.partly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.partly.com/api/v1/billing.customers.statement.get
  • Auth: none declared. Required headers: authorization

Headers

authorizationstring required

UTF-8 encoded string

Request body

customer_idstring uuid required

UUID value type

period_endstring date-time required

Exclusive end of the statement period (UTC). Activity is reported up to but not including this instant; must be strictly after period_start.

period_startstring date-time required

Inclusive start of the statement period (UTC).

Response

200 OK

as_atstring date-time required

The instant the statement is drawn up to: min(period_end, now). For the current period this truncates activity and aging to "to date".

customer_idstring uuid required

UUID value type

period_endstring date-time required

Exclusive end of the reported period (echoed from the request).

period_startstring date-time required

Inclusive start of the reported period (echoed from the request).

Changes

No recorded changes to this operation across all 1 revision of this API.