Skip to main content
PUT
Updates an invoice
You can update the editable fields on an invoice after creation, as long as no Tilta service is active on it. This is useful for correcting metadata errors – such as an incorrect invoice number or issuance date – before financing becomes active. Like all PUT operations, this request replaces the editable portion of the invoice with the values you provide, so include every field you want to retain.
This endpoint uses PUT semantics for the editable fields. Omitting an editable field from your request body may clear its value. To make safe partial updates, retrieve the invoice first and include all desired field values in your PUT payload.
The invoice amount, currency, buyer_external_id, merchant_external_id, and order_external_ids are immutable after creation. To correct these values, you must refund the invoice and create a new one.

Authorizations

Authorization
string
header
required

Your Tilta API key, sent as Bearer <key>.

Path Parameters

external_id
string
required

Unique identifier of an invoice.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$

Body

application/json
buyer_external_id
string
required

Unique identifier of a buyer.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
invoiced_at
number
required

Invoice creation date (unix time in seconds).

Example:

1582896122

due_at
number
required

Invoice due date (unix time in seconds).

Example:

1582896122

amount
object
required
payment_method
enum<string>
required

The code for the payment method.

Available options:
CASH,
CARD,
TRANSFER,
DEBIT
billing_address
object
required

Billing address.

contact_external_id
string | null
required

External ID of an existing buyer contact to associate with this invoice. Must belong to the same buyer. Send null to unlink.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
delivery_address
object | null
required

Delivery address. Send null to remove it.

custom_data
object | null

Free-form metadata for storing integration-specific data alongside this invoice.

Response

The invoice has been successfully updated.

external_id
string
required

Unique identifier of an invoice.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
buyer_external_id
string
required

Unique identifier of a buyer.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
merchant_external_id
string
required

Unique identifier of a merchant.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
created_at
number
required

Timestamp indicating when the invoice was created (unix time in seconds).

Example:

1582896122

updated_at
number
required

Timestamp indicating the last time the invoice was updated (unix time in seconds).

Example:

1582896122

due_at
number
required

Invoice due date (unix time in seconds).

Example:

1582896122

status
enum<string>
required

The current status of the invoice.

Available options:
OPEN,
DUE,
CLOSED,
CANCELLED
days_past_due
integer | null
required

Days past due. Only available for invoices with status DUE.

payment_method
enum<string>
required

Invoice payment method.

Available options:
CASH,
CARD,
TRANSFER,
DEBIT
invoice_number
string
required

Invoice number or reference.

invoiced_at
number
required

Invoice creation date (unix time in seconds).

Example:

1582896122

amount
object
required
contact
object | null

The buyer contact associated with this invoice (if any).

paid_at
number

Timestamp indicating when the invoice was marked as paid (unix time in seconds).

buyer
object
services
object[]

Invoice services with their current status. Returned only when expand includes services. Ordered oldest first; a service type may appear more than once after a resubmission.

credit_note_summary
object

Summary of all Credit Notes associated with this invoice.

Example:
order_external_ids
string[]

IDs of related orders.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$
line_items
object[]

Order line items.

billing_address
object

Billing address. If it is not provided, this will be filled with the buyer's business address.

delivery_address
object | null

Delivery address. If it is not provided, this will be filled with the buyer's default delivery address when set.

custom_data
object | null

Free-form metadata for storing integration-specific data alongside this invoice.