Skip to main content
POST
Save

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

payrollId
string<uuid>
required

The unique identifier for the payroll

Query Parameters

includeFxRates
boolean
default:false

When true, the response is 200 OK with the captured FX rates in the body, keyed as <funding>-<salary> currency pairs. Any other value (or omitting the parameter) returns 204 No Content.

Body

application/json
payrollDate
string<date>
required

payroll date

payPeriod
object
required
entries
object[]
required
fxRateExpiresAt
string<date-time>

Maximum time the quoted FX rates are valid (RFC 3339). If omitted, spot rates are used.

Example:

"2025-06-15T23:59:59Z"

customFees
object[]

Optional custom fee line items that supplement the standard per-seat subscription fees.

tags
object

Any custom data you want to store

Response

FX rates captured at save time. Returned only when includeFxRates=true. Keys are <funding>-<salary> currency pairs; each value is the number of salary-currency units per unit of funding currency. Salary-currency amounts are divided by the rate to get the funding-currency debit.

fxRates
object

Map of <funding>-<salary> currency pair to the captured rate.