Pay cycle - Onsi API

Pay cycles can be retrieved via the Get Cycles and the Get Cycle endpoints.

A pay cycle is a period of time pay is made available for members to withdraw

id

string

required

The unique identifier for a PayCycle, prefixed with pc_

Example:

"pc_<id>"

startDate

string

required

Date in ISO8601 YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2024-01-01"

endDate

string

required

Date in ISO8601 YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2024-01-15"

status

enum<string>

required

Available options:

Open,

Closed

⌘I

{
  "id": "pc_<id>",
  "startDate": "2024-01-01",
  "endDate": "2024-01-15",
  "status": "Open"
}