GET /invoices/:id
The following macros are not currently supported in the header:
  • style

GET /invoices/:id

Get Invoice

Resource URL

GET /invoices/:id

Parameters

Table of allowed parameters.

_fields

partial string

Allows you to specify optional fields and linked objects to include in the response.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.

id

unsigned

 

amount

decimal

 

subject

string

 

notes

string

 

currency_id

unsigned int

 

owner_id

unsigned int

 

creator_id

unsigned int

 

affiliation_id

unsigned int

 

tax

decimal

 

outstanding

decimal

 

date_raised

unix timestamp

 

date_due

unix timestamp

 

date_modified

unix timestamp

 

contact()

object

Contact and affiliation object.

created_by()

object

Staff how created the invoice.

modified_by()

object

Staff who last modified the invoice.

created_by

unsigned int

ID of staff who created the invoice.

modified_by

unsigned int

ID of staff who last modified the invoice.