Skip to navigation
TIANKII API - API KeyPayment RequestsInvoices

Update invoice

View as Markdown

Update invoice

Updates an invoice (INVOICE type) by :id. Accepts any subset of the create fields (all optional). The invoice must belong to the store resolved from the API key.

Authentication

Merchant API key in x-api-key. Requires scope Merchant.payment_link.update. Optionally scope with x-application-account-id.

Path parameters

  • id — invoice (payment request) id.

Body (application/json)

Partial invoice — any of: amount, currency, title, frecuency, frecuencyData, customerId, invoiceNumber, invoiceDate, dueDate, salesTax, quantity, items[], repeat, poNumber, memo, appId.

Returns the updated invoice (BillingInvoiceResponseDto).

Notas: Handler: billingInvoicesService.update. Lifecycle/status changes use the shared /v1/payment-requests routes.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired

Id of the invoice (payment request).

Headers

x-application-account-idstringOptional

Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.

Request

This endpoint expects an object.
dueDatedatetimeOptional
salesTaxintegerOptional
memostringOptional