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

get

https://gateway.remote.com/v1/contractor-invoices

Lists Contractor Invoice records.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage invoices (`invoices`)	View invoices (`invoices:read`)	Manage invoices (`invoices:write`)
Company-scoped access token (assertion)	Manage invoices (`invoices`)	View invoices (`invoices:read`)	Manage invoices (`invoices:write`)
Customer API token	Manage invoices (`invoices`)	View invoices (`invoices:read`)	Manage invoices (`invoices:write`)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

string

enum

Filters contractor invoices by status matching the value.

contractor_invoice_schedule_id

uuid

Filters contractor invoices by invoice schedule ID matching the value.

employment_id

uuid

Filters contractor invoices by the employment ID matching the value. Returns 404 when the employment does not exist or belongs to another company.

date_from

date

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

date_to

date

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

due_date_from

date

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

due_date_to

date

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

approved_date_from

date

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

approved_date_to

date

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

paid_out_date_from

date

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

paid_out_date_to

date

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

sort_by

string

enum

Field to sort by

Allowed:

order

string

enum

Sort order

Allowed:

page

integer

≥ 1

Defaults to 1

Starts fetching records after the given page

page_size

integer

≥ 1

Defaults to 20

Number of items per page

Responses

Callback

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Entity