Skip to content
Hoursmith Docs
APIReferenceTeam payouts

Create or update a payee profile

Create or update a payee profile. Upsert a member's payout identity by userId (201 when created, 200 when updated). A startDate before today requires confirmReviewedHistory=true, sent only after the user agrees to include past time. Never creates a bill or payment. 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.

POST
/team-payouts/payees

Authorization

BearerAuth
AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Header Parameters

Idempotency-Key*string

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" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",    "name": "string",    "email": "user@example.com",    "startDate": "2019-08-24"  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",    "name": "string",    "email": "string",    "address": "string",    "taxReference": "string",    "activeMember": true,    "startDate": "2019-08-24",    "rates": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "effectiveFrom": "2019-08-24",        "hourlyRate": "string",        "currency": "string",        "createdAt": "2019-08-24T14:15:22Z"      }    ],    "fixedAgreements": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed",        "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",        "projectName": "string",        "cadence": "PROJECT",        "description": "string",        "currency": "string",        "amount": "string",        "startsOn": "2019-08-24",        "endsOn": "2019-08-24",        "archivedAt": "2019-08-24T14:15:22Z",        "archivedOn": "2019-08-24"      }    ],    "credits": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "currency": "string",        "amount": "string",        "remaining": "string",        "reason": "string"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "links": {      "app": "string",      "payee": "string"    }  },  "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"  }}
Was this page helpful?