Invoices

Returns an array of invoices for the account. Company names, company ids, a date range, or paid/unpaid status can be specified to narrow the results.

Object Properties

NameTypeDescription
idUUIDUnique identifier for invoice record
invoice numberStringunique alphanumeric identifier assigned to each invoice
created_atDateTimeDatetime of creation
updated_atDateTimeDatetime of last update
company_idUUIDid of the company record
companyStringname of the company
statusStringstatus of invoice. Returns either paid or unpaid.
due_dateDateinvoice due date
itemsString[]array of price, quantity and description of each item on the invoice

GET /invoices

Parameters

NameTypeRequiredDescription
limitInteger-Maximum number of results to return (defaults to 20 and max per request is 20)
offsetInteger-Offset to start limit count from (defaults to 0)
companiesString[]-Names of companies
company_idsUUID[]-ids of companies
start_dateDate-start date of invoice due date
end_dateDate-end date of invoice due date
statusString-the status of an invoice. This parameter accepts paid or unpaid. Default response returns both paid and unpaid invoices
  • Either companies or company_ids can be provided, but not both.

Example response body:

{  
   "id": "01619bcd-dbc5-41f3-af2c-adebb3f3157f",
   "invoice_number": "XXXXXX",
   "status": "paid",
   "company_id": "661a2ae0-c1bf-43b7-a5d8-918f1936dddd",
   "created_at": "2017-05-12T10:47:06.000-07:00",
   "updated_at": "2018-05-31T08:29:01.000-07:00",
   "company": "Example A, Inc",
   "due_date": "2017-05-12T10:47:06.000-07:00",
   "paid_date": "2017-05-12T10:47:35.000-07:00",
   "items": [  
      {  
         "price": 85.0,
         "description": "Standard Nevada change registered agent filing",
         "quantity": 1
      },
      {  
         "price": 49.0,
         "description": "Registered Agent Service in Nevada",
         "quantity": 1
      }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23