List Contractor Invoices. Requires a token issued via the authorization_code grant (company_manager role) — not usable with a client_credentials (integration) token.

Lists Contractor Invoice records.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage invoices (invoices)View invoices (invoices:read)Manage invoices (invoices:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filters contractor invoices by status matching the value.

uuid

Filters contractor invoices by invoice schedule ID matching the value.

date

Filters contractor invoices by date greater than or equal to the value.

date

Filters contractor invoices by date less than or equal to the value.

date

Filters contractor invoices by due date greater than or equal to the value.

date

Filters contractor invoices by due date less than or equal to the value.

date

Filters contractor invoices by approved date greater than or equal to the value.

date

Filters contractor invoices by approved date less than or equal to the value.

date

Filters contractor invoices by paid out date greater than or equal to the value.

date

Filters contractor invoices by paid out date less than or equal to the value.

string
enum

Field to sort by

Allowed:
string
enum

Sort order

Allowed:
integer
≥ 1
Defaults to 1

Starts fetching records after the given page

integer
≥ 1
Defaults to 20

Number of items per page

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json