Skip to main content
GET
Fetch invoice by provider ID

Authorizations

X-API-KEY
string
header
required

API Key Authentication.

Path Parameters

providerId
string
required

The identifier assigned to the invoice by the external provider it was synced to (e.g. the ERP document id).

Response

Default Response

invoice
object
required

The invoice, including its line item groups and standalone line items.

payments
object[]
required

Payment charges registered for the invoice at the payment provider, when any.

statusHistory
object[]
required

Status transitions of the invoice, from the most recent to the oldest.

customer
object
required

The customer the invoice bills.

contract
object | null
required

Summary of the contract that generated the invoice. Null for invoices not generated from a contract.

artifacts
object[]
required

Files generated for the invoice (e.g. the invoice PDF).