Invoices

List invoices

List invoices with filtering and pagination

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Query Parameters

cursor?string

Pagination cursor

limit?integer

Number of items per page (1-100; higher values cap at 100)

Range1 <= value

Default20

start_date?string

Start date (YYYY-MM-DD)

end_date?string

End date (YYYY-MM-DD)

total?string

total[eq]?string

total[neq]?string

total[gt]?string

total[gte]?string

total[lt]?string

total[lte]?string

total[in]?string

total[nin]?string

subtotal?string

subtotal[eq]?string

subtotal[neq]?string

subtotal[gt]?string

subtotal[gte]?string

subtotal[lt]?string

subtotal[lte]?string

subtotal[in]?string

subtotal[nin]?string

date?string

date[eq]?string

date[neq]?string

date[gt]?string

date[gte]?string

date[lt]?string

date[lte]?string

date[in]?string

date[nin]?string

due_date?string

due_date[eq]?string

due_date[neq]?string

due_date[gt]?string

due_date[gte]?string

due_date[lt]?string

due_date[lte]?string

due_date[in]?string

due_date[nin]?string

status?string

Filter by status

Value in

"draft"
"unpaid"
"paid"
"overdue"
"cancelled"

status[eq]?string

status[neq]?string

status[gt]?string

status[gte]?string

status[lt]?string

status[lte]?string

status[in]?string

status[nin]?string

customer_id?string

customer_id[eq]?string

customer_id[neq]?string

customer_id[gt]?string

customer_id[gte]?string

customer_id[lt]?string

customer_id[lte]?string

customer_id[in]?string

customer_id[nin]?string

q?string

Search query

`application/json`

curl -X GET "https://example.com/v1/invoices"

{  "data": [    {      "id": "string",      "organization_id": "string",      "customer_id": "string",      "number": "string",      "status": "draft",      "date": "string",      "due_date": "string",      "subtotal": "string",      "tax": "string",      "total": "string",      "from_details": "string",      "to_details": "string",      "items": [        {          "line_key": "26a9f9be-034f-4698-a0b1-5a6311150885",          "name": "string",          "quantity": "string",          "price": "string",          "unit": "string",          "tax_rate": "string",          "tax_behavior": "inclusive",          "amount": "string",          "tax_amount": "string",          "tax_category": "standard",          "tax_exemption_reason": "string",          "tax_exemption_reason_code": "string",          "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",          "product_price_id": "453079f2-dfb3-4e2b-b8f6-52db9da09b0d",          "kind": "goods",          "dispatched_from": "st",          "ai": {            "description": "string",            "status": "pending"          }        }      ],      "payment_details": "string",      "notes": "string",      "created_at": "string",      "updated_at": "string",      "template": null,      "token": "string",      "reminder_sent_at": "string",      "paid_at": "string",      "reminder_sent_to": "string",      "viewed_at": "string",      "is_recurring_inflow": true,      "recurring_contract_id": "string",      "recurring_series_id": "string",      "scheduled_send_at": "string",      "document_type": "invoice",      "reference_invoice_id": "string",      "source_quote_id": "string",      "service_period_start": "string",      "service_period_end": "string",      "buyer_reference": "string",      "contract_reference": "string",      "purchase_order_reference": "string",      "tax_point_date": "string",      "tax_point_date_code": "3",      "project_reference": "string",      "tender_or_lot_reference": "string",      "invoiced_object_identifier": "string",      "invoiced_object_scheme": "string",      "buyer_accounting_reference": "string",      "delivery_date": "string",      "correction_reason": "string",      "country_extensions": {        "it": {          "regime_fiscale": "RF01",          "natura": "N1"        },        "pl": {          "annotations": {            "cash_method": true,            "self_invoicing": true,            "reverse_charge": true,            "split_payment": true          }        }      },      "external_invoice_id": "string",      "client_id": "string",      "metadata": {        "property1": null,        "property2": null      },      "currency": "string",      "fiscal_document_id": "79bf4701-726a-4939-ac1c-e7552a1d6c5a",      "downloads": {        "pdf": "string",        "ubl": "string",        "bundle": "string"      },      "customer": {        "id": "string",        "reference_id": "string",        "name": "string",        "email": "string",        "website": "string"      }    }  ],  "meta": {    "count": 0,    "next_cursor": "string"  }}

Create invoice

Create a new invoice draft

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Optional idempotency key (sent as the Idempotency-Key header; case-insensitive). Reusing the same key with an identical body replays the original response; reusing it with a different body returns 409. Keys are retained for 24 hours.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customer_id?string|null

customer?

number?string

status?string

Value in

"draft"
"unpaid"
"paid"
"overdue"
"cancelled"

date?string

due_date?string

subtotal?number

tax?number

total?number

tax_behavior?string

Value in

"inclusive"
"exclusive"
"unspecified"

from_details?string

to_details?string

items?array<>

payment_details?string|null

notes?string|null

template?|null

template_id?string|null

external_invoice_id?string|null

metadata?|null

paid_at?string|null

recurring_series_id?string|null

scheduled_send_at?string|null

service_period_start?string|null

service_period_end?string|null

buyer_reference?string|null

contract_reference?string|null

purchase_order_reference?string|null

tax_point_date?string|null

tax_point_date_code?|

Value in

"3"
"35"
"432"
null

project_reference?string|null

tender_or_lot_reference?string|null

invoiced_object_identifier?string|null

invoiced_object_scheme?string|null

buyer_accounting_reference?string|null

delivery_date?string|null

country_extensions?

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoices" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "string",    "organization_id": "string",    "customer_id": "string",    "number": "string",    "status": "draft",    "date": "string",    "due_date": "string",    "subtotal": "string",    "tax": "string",    "total": "string",    "from_details": "string",    "to_details": "string",    "items": [      {        "line_key": "26a9f9be-034f-4698-a0b1-5a6311150885",        "name": "string",        "quantity": "string",        "price": "string",        "unit": "string",        "tax_rate": "string",        "tax_behavior": "inclusive",        "amount": "string",        "tax_amount": "string",        "tax_category": "standard",        "tax_exemption_reason": "string",        "tax_exemption_reason_code": "string",        "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",        "product_price_id": "453079f2-dfb3-4e2b-b8f6-52db9da09b0d",        "kind": "goods",        "dispatched_from": "st",        "ai": {          "description": "string",          "status": "pending"        }      }    ],    "payment_details": "string",    "notes": "string",    "created_at": "string",    "updated_at": "string",    "template": null,    "token": "string",    "reminder_sent_at": "string",    "paid_at": "string",    "reminder_sent_to": "string",    "viewed_at": "string",    "is_recurring_inflow": true,    "recurring_contract_id": "string",    "recurring_series_id": "string",    "scheduled_send_at": "string",    "document_type": "invoice",    "reference_invoice_id": "string",    "source_quote_id": "string",    "service_period_start": "string",    "service_period_end": "string",    "buyer_reference": "string",    "contract_reference": "string",    "purchase_order_reference": "string",    "tax_point_date": "string",    "tax_point_date_code": "3",    "project_reference": "string",    "tender_or_lot_reference": "string",    "invoiced_object_identifier": "string",    "invoiced_object_scheme": "string",    "buyer_accounting_reference": "string",    "delivery_date": "string",    "correction_reason": "string",    "country_extensions": {      "it": {        "regime_fiscale": "RF01",        "natura": "N1"      },      "pl": {        "annotations": {          "cash_method": true,          "self_invoicing": true,          "reverse_charge": true,          "split_payment": true        }      }    },    "external_invoice_id": "string",    "client_id": "string",    "metadata": {      "property1": null,      "property2": null    },    "currency": "string",    "fiscal_document_id": "79bf4701-726a-4939-ac1c-e7552a1d6c5a",    "downloads": {      "pdf": "string",      "ubl": "string",      "bundle": "string"    },    "customer": {      "id": "string",      "reference_id": "string",      "name": "string",      "email": "string",      "website": "string"    }  }}

List invoice templates

List all invoice templates for the current organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/invoices/templates"

{  "data": [    {      "id": "string",      "name": "string",      "currency": "string",      "tax_rate": 0,      "tax_type": "string",      "invoice_number_prefix": "string",      "created_at": "string"    }  ]}

Create invoice template

Create a new invoice template (document_template + invoice settings).

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 255

currency?string

Match^[A-Za-z]{3}$

Length3 <= length <= 3

tax_rate?|

Range0 <= value <= 100

tax_type?string

Value in

"standard"
"reduced"
"zero"
"exempt"
"reverse_charge"
"intra_eu"
"export"
"out_of_scope"

date_format?string

Value in

"MM/dd/yyyy"
"dd/MM/yyyy"
"yyyy-MM-dd"

invoice_format?string

Value in

"a4"
"letter"

include_decimals?boolean

include_units?boolean

business_id?string

Formatuuid

payment_bank_account_id?|

Formatuuid

from_details?string|null

payment_details?string|null

notes?string|null

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoices/templates" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "data": {    "id": "string"  }}

Preview invoice

Calculate a provider-ready invoice without creating an invoice, customer, token, idempotency reservation, or artifact.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customer_id?string|null

customer?

number?string

status?string

Value in

"draft"
"unpaid"
"paid"
"overdue"
"cancelled"

date?string

due_date?string

subtotal?number

tax?number

total?number

tax_behavior?string

Value in

"inclusive"
"exclusive"
"unspecified"

from_details?string

to_details?string

items?array<>

payment_details?string|null

notes?string|null

template?|null

template_id?string|null

external_invoice_id?string|null

metadata?|null

paid_at?string|null

recurring_series_id?string|null

scheduled_send_at?string|null

service_period_start?string|null

service_period_end?string|null

buyer_reference?string|null

contract_reference?string|null

purchase_order_reference?string|null

tax_point_date?string|null

tax_point_date_code?|

Value in

"3"
"35"
"432"
null

project_reference?string|null

tender_or_lot_reference?string|null

invoiced_object_identifier?string|null

invoiced_object_scheme?string|null

buyer_accounting_reference?string|null

delivery_date?string|null

country_extensions?

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoices/preview" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "object": "invoice_preview",    "organization_id": "string",    "customer_id": "string",    "number": "string",    "status": "draft",    "date": "string",    "due_date": "string",    "subtotal": 0,    "tax": 0,    "total": 0,    "from_details": "string",    "to_details": "string",    "items": [      {        "line_key": "26a9f9be-034f-4698-a0b1-5a6311150885",        "name": "string",        "quantity": 0,        "price": 0,        "unit": "string",        "tax_rate": 0,        "tax_behavior": "inclusive",        "amount": 0,        "tax_amount": 0,        "tax_category": "standard",        "tax_exemption_reason": "string",        "tax_exemption_reason_code": "string",        "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",        "product_price_id": "453079f2-dfb3-4e2b-b8f6-52db9da09b0d",        "kind": "goods",        "dispatched_from": "st"      }    ],    "payment_details": "string",    "notes": "string",    "template": null,    "template_id": "string",    "paid_at": "string",    "recurring_series_id": "string",    "scheduled_send_at": "string",    "document_type": "invoice",    "service_period_start": "string",    "service_period_end": "string",    "buyer_reference": "string",    "contract_reference": "string",    "purchase_order_reference": "string",    "tax_point_date": "string",    "tax_point_date_code": "3",    "project_reference": "string",    "tender_or_lot_reference": "string",    "invoiced_object_identifier": "string",    "invoiced_object_scheme": "string",    "buyer_accounting_reference": "string",    "delivery_date": "string",    "country_extensions": {      "it": {        "regime_fiscale": "RF01",        "natura": "N1"      },      "pl": {        "annotations": {          "cash_method": true,          "self_invoicing": true,          "reverse_charge": true,          "split_payment": true        }      }    },    "external_invoice_id": "string",    "client_id": "string",    "metadata": {      "property1": null,      "property2": null    },    "customer": {      "id": "string",      "reference_id": "string",      "name": "string",      "email": "string",      "website": "string"    }  }}

Get invoice

Get a single invoice by ID, with its fiscal record when one exists

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/invoices/string"

{  "data": {    "id": "string",    "organization_id": "string",    "customer_id": "string",    "number": "string",    "status": "draft",    "date": "string",    "due_date": "string",    "subtotal": "string",    "tax": "string",    "total": "string",    "from_details": "string",    "to_details": "string",    "items": [      {        "line_key": "26a9f9be-034f-4698-a0b1-5a6311150885",        "name": "string",        "quantity": "string",        "price": "string",        "unit": "string",        "tax_rate": "string",        "tax_behavior": "inclusive",        "amount": "string",        "tax_amount": "string",        "tax_category": "standard",        "tax_exemption_reason": "string",        "tax_exemption_reason_code": "string",        "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",        "product_price_id": "453079f2-dfb3-4e2b-b8f6-52db9da09b0d",        "kind": "goods",        "dispatched_from": "st",        "ai": {          "description": "string",          "status": "pending"        }      }    ],    "payment_details": "string",    "notes": "string",    "created_at": "string",    "updated_at": "string",    "template": null,    "token": "string",    "reminder_sent_at": "string",    "paid_at": "string",    "reminder_sent_to": "string",    "viewed_at": "string",    "is_recurring_inflow": true,    "recurring_contract_id": "string",    "recurring_series_id": "string",    "scheduled_send_at": "string",    "document_type": "invoice",    "reference_invoice_id": "string",    "source_quote_id": "string",    "service_period_start": "string",    "service_period_end": "string",    "buyer_reference": "string",    "contract_reference": "string",    "purchase_order_reference": "string",    "tax_point_date": "string",    "tax_point_date_code": "3",    "project_reference": "string",    "tender_or_lot_reference": "string",    "invoiced_object_identifier": "string",    "invoiced_object_scheme": "string",    "buyer_accounting_reference": "string",    "delivery_date": "string",    "correction_reason": "string",    "country_extensions": {      "it": {        "regime_fiscale": "RF01",        "natura": "N1"      },      "pl": {        "annotations": {          "cash_method": true,          "self_invoicing": true,          "reverse_charge": true,          "split_payment": true        }      }    },    "external_invoice_id": "string",    "client_id": "string",    "metadata": {      "property1": null,      "property2": null    },    "currency": "string",    "fiscal_document_id": "79bf4701-726a-4939-ac1c-e7552a1d6c5a",    "downloads": {      "pdf": "string",      "ubl": "string",      "bundle": "string"    },    "customer": {      "id": "string",      "reference_id": "string",      "name": "string",      "email": "string",      "website": "string"    },    "fiscal": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "schema_version": "string",      "engine_version": "string",      "effective_date": "string",      "digest": "string",      "rule_packs": [        {          "id": "string",          "version": "string"        }      ],      "correction": null,      "preceding_documents": null,      "artifacts": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "fiscal_document_id": "79bf4701-726a-4939-ac1c-e7552a1d6c5a",          "transmission_id": "da08139c-7a56-4672-93e2-85353adf4d76",          "role": "canonical",          "format": "string",          "variant": "string",          "profile": "string",          "adapter_id": "string",          "adapter_version": "string",          "context": {            "property1": null,            "property2": null          },          "metadata": {            "property1": null,            "property2": null          },          "inputs": [            {              "artifact_id": "b7bd6bbb-c7f1-4314-8742-2aeeeece9d12",              "purpose": "string"            }          ],          "validation": {            "validator_id": "string",            "validator_version": "string",            "valid": true,            "diagnostics": [              {                "property1": null,                "property2": null              }            ],            "validated_at": "string"          },          "content_hash": "string",          "size_bytes": 0,          "mime_type": "string",          "created_at": "string",          "download_url": "string"        }      ],      "artifact_inputs": [        {          "artifact_id": "b7bd6bbb-c7f1-4314-8742-2aeeeece9d12",          "input_artifact_id": "a4134709-460b-44b6-99b2-2d637f889159",          "purpose": "string"        }      ],      "validations": [        {          "validator_id": "string",          "validator_version": "string",          "valid": true,          "diagnostics": [            {              "property1": null,              "property2": null            }          ],          "validated_at": "string",          "artifact_id": "b7bd6bbb-c7f1-4314-8742-2aeeeece9d12"        }      ],      "transmissions": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",          "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",          "channel": "string",          "format": "string",          "fiscal_document_id": "79bf4701-726a-4939-ac1c-e7552a1d6c5a",          "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",          "wire_artifact_id": "1133c6f0-26f2-43cb-b468-a2b54c2ebfc8",          "environment": "string",          "notification": "string",          "gateway_provider": "string",          "gateway_document_id": "string",          "attempt": 0,          "idempotency_key": "string",          "payload_hash": "string",          "next_retry_at": "string",          "legal_deadline_at": "string",          "tax_authority_id": "string",          "tax_authority_status": "string",          "tax_authority_status_at": "string",          "submitted_at": "string",          "delivered_at": "string",          "failed_at": "string",          "failure_reason": "string",          "created_at": "string",          "updated_at": "string",          "state": "string",          "events": [            {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "transmission_id": "da08139c-7a56-4672-93e2-85353adf4d76",              "type": "string",              "state": "string",              "provider_status_code": "string",              "provider_document_id": "string",              "authority_document_id": "string",              "metadata": {                "property1": null,                "property2": null              },              "receipt_artifact_id": "fc620f8e-020b-4e5c-8b39-e38502aefdab",              "occurred_at": "string",              "created_at": "string"            }          ]        }      ]    }  }}

Update invoice

Update invoice fields

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customer_id?string|null

number?string

status?string

Value in

"draft"
"unpaid"
"paid"
"overdue"
"cancelled"

date?string

due_date?string

subtotal?number

tax?number

total?number

from_details?string

to_details?string

items?array<>

payment_details?string|null

notes?string|null

template?|null

reminder_sent_at?string|null

paid_at?string|null

reminder_sent_to?string|null

viewed_at?string|null

is_recurring_inflow?boolean

recurring_contract_id?string|null

recurring_series_id?string|null

scheduled_send_at?string|null

service_period_start?string|null

service_period_end?string|null

buyer_reference?string|null

contract_reference?string|null

purchase_order_reference?string|null

tax_point_date?string|null

tax_point_date_code?|

Value in

"3"
"35"
"432"
null

project_reference?string|null

tender_or_lot_reference?string|null

invoiced_object_identifier?string|null

invoiced_object_scheme?string|null

buyer_accounting_reference?string|null

delivery_date?string|null

correction_reason?string

Length3 <= length <= 1024

country_extensions?

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/invoices/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "string",    "organization_id": "string",    "customer_id": "string",    "number": "string",    "status": "draft",    "date": "string",    "due_date": "string",    "subtotal": "string",    "tax": "string",    "total": "string",    "from_details": "string",    "to_details": "string",    "items": [      {        "line_key": "26a9f9be-034f-4698-a0b1-5a6311150885",        "name": "string",        "quantity": "string",        "price": "string",        "unit": "string",        "tax_rate": "string",        "tax_behavior": "inclusive",        "amount": "string",        "tax_amount": "string",        "tax_category": "standard",        "tax_exemption_reason": "string",        "tax_exemption_reason_code": "string",        "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",        "product_price_id": "453079f2-dfb3-4e2b-b8f6-52db9da09b0d",        "kind": "goods",        "dispatched_from": "st",        "ai": {          "description": "string",          "status": "pending"        }      }    ],    "payment_details": "string",    "notes": "string",    "created_at": "string",    "updated_at": "string",    "template": null,    "token": "string",    "reminder_sent_at": "string",    "paid_at": "string",    "reminder_sent_to": "string",    "viewed_at": "string",    "is_recurring_inflow": true,    "recurring_contract_id": "string",    "recurring_series_id": "string",    "scheduled_send_at": "string",    "document_type": "invoice",    "reference_invoice_id": "string",    "source_quote_id": "string",    "service_period_start": "string",    "service_period_end": "string",    "buyer_reference": "string",    "contract_reference": "string",    "purchase_order_reference": "string",    "tax_point_date": "string",    "tax_point_date_code": "3",    "project_reference": "string",    "tender_or_lot_reference": "string",    "invoiced_object_identifier": "string",    "invoiced_object_scheme": "string",    "buyer_accounting_reference": "string",    "delivery_date": "string",    "correction_reason": "string",    "country_extensions": {      "it": {        "regime_fiscale": "RF01",        "natura": "N1"      },      "pl": {        "annotations": {          "cash_method": true,          "self_invoicing": true,          "reverse_charge": true,          "split_payment": true        }      }    },    "external_invoice_id": "string",    "client_id": "string",    "metadata": {      "property1": null,      "property2": null    },    "currency": "string",    "fiscal_document_id": "79bf4701-726a-4939-ac1c-e7552a1d6c5a",    "downloads": {      "pdf": "string",      "ubl": "string",      "bundle": "string"    },    "customer": {      "id": "string",      "reference_id": "string",      "name": "string",      "email": "string",      "website": "string"    }  }}

Delete invoice

Delete a non-finalized draft or cancelled invoice by ID. Finalized fiscal records must be retained.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/invoices/string"

Empty

Download invoice

Download issued invoice artifacts as PDF, UBL XML, or ZIP, or a watermarked review PDF of a draft. A 202 means the PDF exists but is not ready yet: wait for the invoices.presentation_ready realtime event matching preview, or retry after the Retry-After seconds. A 409 means the draft cannot be rendered as it stands.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Query Parameters

format?string

Default"pdf"

Value in

"pdf"
"ubl"
"pdf+ubl"

Response Body

`application/json`

curl -X GET "https://example.com/v1/invoices/string/download"

"string"

Download invoice artifact

Download a verified canonical, wire, receipt, or validation artifact.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

artifactId*string

Formatuuid

Response Body

`/`

`application/json`

curl -X GET "https://example.com/v1/invoices/string/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08"

"string"

Finalize invoice

Finalize a draft invoice — freezes the business / template snapshot, allocates a gap-free number from the document sequence, and transitions status from draft to unpaid.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoices/string/finalize"

{  "data": {    "id": "string",    "organization_id": "string",    "customer_id": "string",    "number": "string",    "status": "draft",    "date": "string",    "due_date": "string",    "subtotal": "string",    "tax": "string",    "total": "string",    "from_details": "string",    "to_details": "string",    "items": [      {        "line_key": "26a9f9be-034f-4698-a0b1-5a6311150885",        "name": "string",        "quantity": "string",        "price": "string",        "unit": "string",        "tax_rate": "string",        "tax_behavior": "inclusive",        "amount": "string",        "tax_amount": "string",        "tax_category": "standard",        "tax_exemption_reason": "string",        "tax_exemption_reason_code": "string",        "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",        "product_price_id": "453079f2-dfb3-4e2b-b8f6-52db9da09b0d",        "kind": "goods",        "dispatched_from": "st",        "ai": {          "description": "string",          "status": "pending"        }      }    ],    "payment_details": "string",    "notes": "string",    "created_at": "string",    "updated_at": "string",    "template": null,    "token": "string",    "reminder_sent_at": "string",    "paid_at": "string",    "reminder_sent_to": "string",    "viewed_at": "string",    "is_recurring_inflow": true,    "recurring_contract_id": "string",    "recurring_series_id": "string",    "scheduled_send_at": "string",    "document_type": "invoice",    "reference_invoice_id": "string",    "source_quote_id": "string",    "service_period_start": "string",    "service_period_end": "string",    "buyer_reference": "string",    "contract_reference": "string",    "purchase_order_reference": "string",    "tax_point_date": "string",    "tax_point_date_code": "3",    "project_reference": "string",    "tender_or_lot_reference": "string",    "invoiced_object_identifier": "string",    "invoiced_object_scheme": "string",    "buyer_accounting_reference": "string",    "delivery_date": "string",    "correction_reason": "string",    "country_extensions": {      "it": {        "regime_fiscale": "RF01",        "natura": "N1"      },      "pl": {        "annotations": {          "cash_method": true,          "self_invoicing": true,          "reverse_charge": true,          "split_payment": true        }      }    },    "external_invoice_id": "string",    "client_id": "string",    "metadata": {      "property1": null,      "property2": null    },    "currency": "string",    "fiscal_document_id": "79bf4701-726a-4939-ac1c-e7552a1d6c5a",    "downloads": {      "pdf": "string",      "ubl": "string",      "bundle": "string"    },    "customer": {      "id": "string",      "reference_id": "string",      "name": "string",      "email": "string",      "website": "string"    }  }}

Send invoice

Deliver the invoice over its decided channel — a clearance/network rail or email, queued for the worker. A draft is finalized first (number allocation + completeness gate + e-invoice preflight), matching one-click issue-and-send.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoices/string/send"

{  "data": {    "id": "string",    "organization_id": "string",    "customer_id": "string",    "number": "string",    "status": "draft",    "date": "string",    "due_date": "string",    "subtotal": "string",    "tax": "string",    "total": "string",    "from_details": "string",    "to_details": "string",    "items": [      {        "line_key": "26a9f9be-034f-4698-a0b1-5a6311150885",        "name": "string",        "quantity": "string",        "price": "string",        "unit": "string",        "tax_rate": "string",        "tax_behavior": "inclusive",        "amount": "string",        "tax_amount": "string",        "tax_category": "standard",        "tax_exemption_reason": "string",        "tax_exemption_reason_code": "string",        "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",        "product_price_id": "453079f2-dfb3-4e2b-b8f6-52db9da09b0d",        "kind": "goods",        "dispatched_from": "st",        "ai": {          "description": "string",          "status": "pending"        }      }    ],    "payment_details": "string",    "notes": "string",    "created_at": "string",    "updated_at": "string",    "template": null,    "token": "string",    "reminder_sent_at": "string",    "paid_at": "string",    "reminder_sent_to": "string",    "viewed_at": "string",    "is_recurring_inflow": true,    "recurring_contract_id": "string",    "recurring_series_id": "string",    "scheduled_send_at": "string",    "document_type": "invoice",    "reference_invoice_id": "string",    "source_quote_id": "string",    "service_period_start": "string",    "service_period_end": "string",    "buyer_reference": "string",    "contract_reference": "string",    "purchase_order_reference": "string",    "tax_point_date": "string",    "tax_point_date_code": "3",    "project_reference": "string",    "tender_or_lot_reference": "string",    "invoiced_object_identifier": "string",    "invoiced_object_scheme": "string",    "buyer_accounting_reference": "string",    "delivery_date": "string",    "correction_reason": "string",    "country_extensions": {      "it": {        "regime_fiscale": "RF01",        "natura": "N1"      },      "pl": {        "annotations": {          "cash_method": true,          "self_invoicing": true,          "reverse_charge": true,          "split_payment": true        }      }    },    "external_invoice_id": "string",    "client_id": "string",    "metadata": {      "property1": null,      "property2": null    },    "currency": "string",    "fiscal_document_id": "79bf4701-726a-4939-ac1c-e7552a1d6c5a",    "downloads": {      "pdf": "string",      "ubl": "string",      "bundle": "string"    },    "customer": {      "id": "string",      "reference_id": "string",      "name": "string",      "email": "string",      "website": "string"    }  },  "delivery": {    "state": "queued",    "channel": "string",    "transmission_id": "string",    "warning": "string"  }}

List invoice transmissions

The append-only transmission history for this invoice — every rail submission and email delivery attempt, newest first. After a queued send, poll here for the authority verdict.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/invoices/string/transmissions"

{  "data": [    {      "id": "string",      "channel": "string",      "format": "string",      "state": "queued",      "attempt": 0,      "gateway_provider": "string",      "tax_authority_id": "string",      "failure_reason": "string",      "created_at": "string",      "submitted_at": "string",      "delivered_at": "string",      "failed_at": "string"    }  ]}

Preview invoice delivery

The channel and format a send would use for this invoice as it stands — without sending anything. A null channel with a warning means the preferred route cannot be taken yet.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/invoices/string/delivery-preview"

{  "data": {    "channel": "string",    "format": "string",    "via_gateway": true,    "gateway_provider": "string",    "warning": "unsupported_country"  }}

200application/json

403application/json

201application/json

400application/json

403application/json

404application/json

409application/json

422application/json

500application/json

503application/json

200application/json

403application/json

201application/json

403application/json

200application/json

400application/json

403application/json

404application/json

409application/json

422application/json

500application/json

200application/json

403application/json

404application/json

200application/json

400application/json

403application/json

404application/json

409application/json

204

400application/json

403application/json

404application/json

409application/json

200application/pdf

202application/json

403application/json

404application/json

409application/json

200*/*

403application/json

404application/json

200application/json

400application/json

403application/json

404application/json

409application/json

200application/json

400application/json

403application/json

404application/json

409application/json

200application/json

403application/json

404application/json

200application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`/`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`