Skip to content
Internal preview — Billtyme does not issue or send invoices yet.See what's included
Billtyme
Esc
↑↓navigate↵open⌘Jpreview

List invoices

Lists invoice summaries for one company, with cursor pagination and exact status, customer, and external-reference filters.

GET/v1/companies/{company_id}/invoices
Authorization
AuthorizationBearer token (JWT) · headerrequired
WorkOS AuthKit user, service, or agent access token
Path parameters
company_idstring<uuid>required
Query parameters
afterstring
min length 1 · max length 512 · matches ^[A-Za-z0-9_-]+$
limitinteger
min 1 · max 100 · default: 20
customer_idstring<uuid>
external_referencestring
min length 1 · max length 255
statusstring
Allowed:draftissuedvoid
Responses
200Invoice collection
dataobject[]required
Show properties
Array of object
company_idstring<uuid>required
created_atstring<date-time>required
currencystringrequired
matches ^[A-Z]{3}$
customer_idstring<uuid>required
customer_namestringrequired
min length 1 · max length 200
due_datestring<date> | nullrequired
external_referencestring
min length 1 · max length 255
idstring<uuid>required
issue_datestring<date>required
issued_atstring<date-time> | nullrequired
numberstring | nullrequired
statusstringrequired
Allowed:draftissuedvoid
subtotal_minorintegerrequired
min 0 · max 9007199254740991
tax_minorintegerrequired
min 0 · max 9007199254740991
total_minorintegerrequired
min 0 · max 9007199254740991
updated_atstring<date-time>required
versionintegerrequired
void_reasonstring | nullrequired
voided_atstring<date-time> | nullrequired
paginationobjectrequired
Show properties
next_cursorstring | nullrequired
min length 1 · max length 512 · matches ^[A-Za-z0-9_-]+$
401Authentication failed
errorobjectrequired
Show properties
codestringrequired
detailsobject[]
Show properties
Array of object
messagestringrequired
pathstringrequired
messagestringrequired
request_idstringrequired
403Permission denied
errorobjectrequired
Show properties
codestringrequired
detailsobject[]
Show properties
Array of object
messagestringrequired
pathstringrequired
messagestringrequired
request_idstringrequired
404Resource not found
errorobjectrequired
Show properties
codestringrequired
detailsobject[]
Show properties
Array of object
messagestringrequired
pathstringrequired
messagestringrequired
request_idstringrequired
422Request validation failed
errorobjectrequired
Show properties
codestringrequired
detailsobject[]
Show properties
Array of object
messagestringrequired
pathstringrequired
messagestringrequired
request_idstringrequired
500Unexpected server error
errorobjectrequired
Show properties
codestringrequired
detailsobject[]
Show properties
Array of object
messagestringrequired
pathstringrequired
messagestringrequired
request_idstringrequired
Request
curl -X GET "/v1/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/invoices" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "data": [
    {
      "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
      "customer_name": "string",
      "due_date": "2019-08-24",
      "external_reference": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "issue_date": "2019-08-24",
      "issued_at": "2019-08-24T14:15:22Z",
      "number": "string",
      "status": "draft",
      "subtotal_minor": 9007199254740991,
      "tax_minor": 9007199254740991,
      "total_minor": 9007199254740991,
      "updated_at": "2019-08-24T14:15:22Z",
      "version": 0,
      "void_reason": "string",
      "voided_at": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "next_cursor": "string"
  }
}