Issued invoices, newest period first

GET

https://billing.ezghcloud.com/v1/organizations/{orgId}/invoices

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
format: uuid

Query parameters

limitoptionalinteger
maximum: 100, minimum: 1
Default: 20
cursoroptionalstring
A previous page's nextCursor.

Returns

200

JSON

invoicesarray ofobjectrequired
Newest period first.
19 properties
- idstringrequired
- numberstring | nullrequired
  Assigned when the invoice is issued.
- statusstringrequired
  open, paid, void or uncollectible. Treat other values as unknown.
- overduebooleanrequired
  Open, not carried forward, and past its due date.
- carriedForwardbooleanrequired
  Below the minimum charge: added to the next invoice instead.
- carriedIntoInvoiceIdstring | nullrequired
  The invoice it was carried into, once there is one.
- periodStartstringrequired
  format: date-time
- periodEndstringrequired
  format: date-time
- currencystringrequired
- collectionMethodstring | nullrequired
  charge_automatically (the default card) or send_invoice.
- totalCentsstringrequired
  Cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- startingBalanceCentsstringrequired
  Carried from earlier invoices, in cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- amountDueCentsstringrequired
  Cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- amountPaidCentsstringrequired
  Cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- amountRemainingCentsstringrequired
  Cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- dueAtstring | nullrequired
  format: date-time
- issuedAtstring | nullrequired
  When it was issued and numbered.
  
  format: date-time
- finalizedAtstring | nullrequired
  The same as issuedAt.
  
  format: date-time
- paidAtstring | nullrequired
  format: date-time
nextCursorstring | nullrequired
Pass as cursor for the next page; null on the last.

400

invalid_request: the request is malformed (with issues), or invalid_cursor.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

401

unauthenticated: no valid credential.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

403

access_denied: the caller isn't allowed to (the message names the action); forbidden_origin: a cookie-authenticated write from another site.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

404

not_found: the organization (or one the caller doesn't belong to), or the resource, doesn't exist.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

429

too_many_requests: slow down.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

503

unavailable, ledger_unavailable or payments_unavailable: retry later.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired