Add a dated pay-rate revision
Add a dated pay-rate revision. Append an hourly pay-rate revision effective from a date. Revisions are never edited: correct a rate with another revision on the same date (the newest wins). Rejected when it would change approved work. Open drafts covering later dates must be re-previewed before approval (see warnings). Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `write` scope. Requires an Idempotency-Key. Money values are exact decimal strings; dates are ISO calendar dates.
Authorization
BearerAuth Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.
In: header
Path Parameters
Header Parameters
Caller-generated UUID/ULID. Same key + same body replays the original response; the key also derives the durable operation identity, so a retried payment, reversal or draft is never applied twice.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/team-payouts/payees/497f6eca-6276-4993-bfeb-53cbbbba6f08/rates" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "effectiveFrom": "2019-08-24", "hourlyRate": "string", "currency": "str" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "effectiveFrom": "2019-08-24", "hourlyRate": "string", "currency": "string", "createdAt": "2019-08-24T14:15:22Z" }, "warnings": [ "string" ]}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}get Team Profitability
Read-only. Owner/Admin tokens with read scope only. Agency plan required. Generic member endpoints never expose compensation. Dates are ISO calendar transport values; money is a decimal string. Links require an authenticated Owner/Admin app session. Unknown and repeated query parameters return 422.
List fixed-pay agreements
Read-only. Fixed-pay agreements (oldest start first, up to 500), optionally for one payee, with status relative to today. Unknown or repeated query parameters return 422. Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `read` scope. Money values are exact decimal strings; dates are ISO calendar dates.