Skip to main content
POST
Record a settlement

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Headers

Idempotency-Key
string

Retry-safe key; a repeat of the same request replays the first response

Maximum string length: 255

Body

application/json
clubId
integer
required
date
string<date>
required

The day it is reported on.

amount
number
required

What was collected, tax included.

revenueAccountId
integer
required

The account the revenue posts to; its tax rate applies.

payment
object
required
contactId
integer

The customer the whole sum belongs to, if there is one.

description
string

Defaults to your key's name.

Maximum string length: 500

Response

Settlement recorded

A billing transaction with amounts, payment status, and links to the originating booking or membership.

id
integer
uuid
string<uuid>

Stable unguessable identifier. Prefer this over id when storing a reference.

description
string | null

What the transaction is for, in English, built from what it links to: the part of the booking it pays for and the visit, the plan and the period it pays for, the product or the check-in; a reversal reads Reversal: ... with the share it gives back. For a settlement, or anything else linked to none of those, it is the text it was created with. Read it as a label, not as an identifier: it follows the records' current names.

transactionType
string | null

TransactionType enum value (e.g. booking_creation, membership_creation, product_sale, membership_recurrence, etc.). A settlement recorded with POST /v1/platform/transactions is settlement.

bookingId
integer | null
membershipId
integer | null
contactId
integer | null

The customer charged, when there is one.

clubId
integer | null

Set on a settlement only; other transactions take their club from their booking or membership.

createdAt
string<date-time>
date
string<date-time>

The day the charge counts on in every money report: when it was sold, a booking's visit, or the start of the membership period it pays for.

dueDate
string<date-time> | null

The day an unpaid charge falls due (midnight UTC naming the calendar day), set only where that is later than date: a Season Pass sold ahead is dated at its sale and owed from the day it starts. Null means it is due on date.

paymentStatus
enum<string>
Available options:
pending,
paid,
void,
failed,
settled,
overdue,
partially_paid,
refunded,
cancelled
amount
string

Pre-tax amount as a decimal string (e.g. "25.00"). Serialized as a string to preserve precision.

taxAmount
string

Tax portion as a decimal string.

totalAmount
string

Total billed amount as a decimal string (amount + taxAmount).