Show the Contractor Invoice Sequence

Shows the company's contractor invoice sequence: the pattern its contractor invoice numbers follow.

Returns 404 when the company has no sequence, or when its sequence is turned off. In that case invoice
numbers aren't generated from a sequence, and the number sent when creating an invoice schedule is used.
When the sequence is enabled, invoice numbers come from it and a number sent on a schedule is not used.

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…
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