Get invoice by ID

GET /api/v1/documents/contracts/invoices/{invoice_id}

Get invoice by ID

cURL

curl --request GET \
  --url https://api.example.com/api/v1/documents/contracts/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "currency": "USD",
  "status": "draft",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "onchainTransactionId": "<string>",
  "transaction": {
    "onchainTransactionId": "<string>",
    "amount": 123,
    "txHash": "<string>",
    "type": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "discount": "<string>",
  "comment": "<string>",
  "emailMessage": "<string>",
  "invoiceNumber": "<string>",
  "periodNumber": 123,
  "issuedDate": "2023-12-25",
  "dueDate": "2023-12-25",
  "items": [
    {}
  ],
  "paymentMethods": [
    {
      "bankName": "<string>",
      "accountHolderType": "individual",
      "beneficiaryName": "<string>",
      "bankAddress": {
        "addressLine1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
      },
      "currency": "<string>",
      "accountHolderFirstName": "<string>",
      "accountHolderLastName": "<string>",
      "accountHolderBusinessName": "<string>",
      "accountHolderAddress": {
        "streetAddress": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "AF",
        "zip": "<string>"
      },
      "relationship": "employee",
      "businessIndustry": "<string>",
      "paymentReference": "<string>",
      "accountType": "sepa",
      "ibanNumber": "<string>",
      "bic": "<string>"
    }
  ],
  "client": {
    "email": "<string>",
    "displayName": "<string>",
    "address": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "AF",
      "zip": "<string>"
    }
  },
  "contractor": {
    "email": "<string>",
    "displayName": "<string>",
    "address": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "AF",
      "zip": "<string>"
    }
  },
  "contract": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "service",
    "status": "active",
    "isRecurring": true,
    "period": "<string>",
    "activationAt": "2023-11-07T05:31:56Z",
    "expirationAt": "2023-11-07T05:31:56Z"
  },
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "key": "<string>"
    }
  ],
  "paidAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Path Parameters

invoice_id · string<uuid> · required

Response

200

application/json

Successful Response

Invoice response.

Carries no download link: the PDF is rendered on request at GET /public/invoices/{id}/pdf. Add ?details=<index into paymentMethods> for the copy naming that payment method; without it the copy carries no payment details.

id · string<uuid> · required

amount · string · required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

currency · enum<string> · required

Supported invoice/contract currencies. G10 majors + AED/HKD, plus popular crypto tokens.

Available options: USD, EUR, GBP, JPY, CHF, CAD, AUD, NZD, SEK, NOK, AED, HKD, BRL, MXN, USDC, USDT, DAI, SOL, BTC, ETH, NEAR, BNB, XRP, ADA, DOGE, TRX, GRAM, AVAX, MATIC, DOT, LTC, LINK, ARB, OP, SUI

status · enum<string> · required

Invoice status.

Available options: draft, sent, paid, cancelled, client_paid, client_declined

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

onchainTransactionId · string | null

transaction · InvoiceTransactionInfo · object | null

Minimal transaction info embedded in invoice response.

Show child attributes

discount · string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

comment · string | null

emailMessage · string | null

invoiceNumber · string | null

periodNumber · integer | null

issuedDate · string<date> | null

dueDate · string<date> | null

items · Items · object[]

paymentMethods · (IBANAccountDetails · object | USExternalAccountDetails · object | SwiftAccountDetails · object | PixAccountDetails · object | LocalRailAccountDetails · object | ProviderUsdAccountDetails · object | ContactWalletResponse · object | EmailAccountInput · object)[]

IBAN (SEPA) external account.

IBANAccountDetails

USExternalAccountDetails

SwiftAccountDetails

PixAccountDetails

LocalRailAccountDetails

ProviderUsdAccountDetails

ContactWalletResponse

EmailAccountInput

Show child attributes

client · InvoiceParticipant · object | null

Minimal participant info for invoice response.

Show child attributes

contractor · InvoiceParticipant · object | null

Minimal participant info for invoice response.

Show child attributes

contract · InvoiceContractInfo · object | null

Minimal contract info embedded in invoice response.

Show child attributes

documents · InvoiceDocumentInfo · object[]

Show child attributes

paidAt · string<date-time> | null