Preview a Contractor Invoice

Returns a base64-encoded PDF preview of a contractor invoice built from the given parameters.

The document is a draft and is not persisted.

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 typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage 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 tokenManage 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…
Path Params
uuid
required

Employment identifier

Body Params

Preview parameters

Payload shape used to preview a contractor invoice before it's created.

string | null
required

Currency code in ISO 4217 format.

items
array of objects
required
length between 1 and 10

List of invoice items that composes the overall invoice amount.

items*
string | null

Custom defined note.

string | null

Invoice identifier.

date
required

UTC date in ISO 8601 format

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