Invoices

Summarise invoices

GET
/v1/invoices/summary

What the business is owed, one row for each currency you have invoiced in, sorted by currency code. open is every invoice still open, overdue ones included; overdue is the part of it past its due date. Void invoices are not counted. An account that has never invoiced gets no rows. Every figure but the counts is net of the credit notes issued against those invoices.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Response Body

Success

application/json
  1. response

Success

data*array<>
curl -X GET "https://example.com/v1/invoices/summary"
{  "data": [    {      "currency": "USD",      "open": 2878,      "overdue": 0,      "paid": 2878,      "credited": 0,      "openCount": 2,      "overdueCount": 0,      "paidCount": 1    }  ]}