Skip to main content
POST

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.

Path Parameters

uuid
string
required

Record id.

Body

application/json

Optional. An empty body voids the record today.

date
string<date>

Void date. Defaults to today in the business timezone. It cannot be in the future, on or before a closed period, or before the record date and any activity already posted. Stock records can only be voided today.

reason
string

Note stored on the void. Required when the record was approved and this void must be approved again.

Maximum string length: 500

Response

The record was voided, or the void was sent for approval.

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.