Skip to main content
POST
Skip a payment cycle

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

Idempotency-Key
string

Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.

Path Parameters

id
string
required

The id.

Body

application/json

Mark a payment cycle's posts as cycle-skipped on a contract. The cycle is selected by cycleStart/cycleEnd, unless an explicit postIds list is supplied (which overrides the date range).

cycleStart
string
required

ISO start of the cycle to skip.

cycleEnd
string
required

ISO end of the cycle to skip.

postIds
string[]

Explicit post ids to skip (overrides the date range). Each id must belong to the contract.

Response

The cycle's posts were marked as cycle-skipped.

data
object
required