Get Public Invoice

Public invoice details — no auth required.

GET /api/v1/public/invoices/{invoice_id}

Get Public Invoice

cURL

curl --request GET \
  --url https://api.example.com/api/v1/public/invoices/{invoice_id}

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency": "<string>",
  "status": "draft",
  "items": [
    {
      "name": "<string>",
      "quantity": 123,
      "price": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "comment": "<string>",
  "invoiceNumber": "<string>",
  "issuedDate": "2023-12-25",
  "dueDate": "2023-12-25",
  "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>"
    }
  },
  "paymentMethods": [],
  "contract": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "documentName": "<string>",
    "documentLink": "<string>"
  },
  "documents": []
}

Path Parameters

invoice_id · string<uuid> · required

Response

200

application/json

Successful Response

id · string<uuid> · required

amount · number · required

currency · string · required

status · enum<string> · required

Invoice status.

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

items · PublicInvoiceItem · object[] · required

Show child attributes

createdAt · string<date-time> · required

invoiceId · string<uuid> · required · read-only

Alias clients read instead of id; the two can never disagree.

comment · string | null

invoiceNumber · string | null

issuedDate · string<date> | null

dueDate · string<date> | null

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

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

contract · PublicInvoiceContractInfo · object | null

Show child attributes

documents · InvoiceDocumentInfo · object[]

Show child attributes