Skip to navigation
TIANKII API - API KeyCheckout Invoice

List invoice events

View as Markdown

List invoice events

Returns the audit trail of lifecycle events for the invoice identified by :id (creation, payment-method changes, refunds, reopen/cancel, notifications, terminal status changes).

Auth

x-api-key header with Merchant.invoice.read (default @HibridAdminUserEndpoint methods — JWT user + API key).

Path params

  • id (required): the invoice id.

Filtering conventions

  • Type uses enum-filter syntax over InvoiceEventType (e.g. in:CREATED,PAID).
  • Message / Actor use field-filter operators: like, contains, startsWith, endsWith (e.g. contains:refund).
  • sort over Type, Message, Actor, Timestamp.
  • Pagination via page / per_page.

Notas: FilterInvoiceEventsDto extends PaginationDto. This endpoint uses the default @HibridAdminUserEndpoint auth methods (no explicit methods override).

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
Id of the invoice whose events are listed.

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.

Query parameters

pageintegerOptionalDefaults to 1
Page number to return.
per_pageintegerOptionalDefaults to 10
Number of records per page.
TypestringOptional

Filter by event type.

Allowed values: CREATED, PAYMENT_METHOD_UPDATED, REFUNDED, REOPENED, CANCELLED, MANUALLY_MARKED_AS_PAID, WEBHOOK_NOTIFICATION_SENT, EMAIL_NOTIFICATION_SENT, TELEGRAM_NOTIFICATION_SENT, IOT_NOTIFICATION_SENT, INTEGRATION_ACTION_TRIGGERED, PAID, EXPIRED, INVALID

Allowed operators: equals, in, not, notIn

Formats: value (defaults to equals), operator:value, operator|value, a comma-separated list for in / notIn (in:a,b), or a JSON object ({"in":["a","b"]}).

MessagestringOptional

Filter by the event message.

Allowed operators: like, contains, startsWith, endsWith

Formats: value (defaults to equals), operator:value, operator|value, or a JSON object ({"contains":"text","mode":"insensitive"}).

ActorstringOptional

Filter by the actor that produced the event (for example API_USER).

Allowed operators: like, contains, startsWith, endsWith

Formats: value (defaults to equals), operator:value, operator|value, or a JSON object ({"contains":"text","mode":"insensitive"}).

sortstringOptional

Sort by one or more fields, comma-separated.

Allowed fields: Type, Message, Actor, Timestamp

Formats: field (ascending by default), +field, -field, field:asc, field:desc (| also works as the separator).