Skip to content
Hoursmith Docs
APIReferenceTeam payouts

Archive a fixed-pay agreement

Archive a fixed-pay agreement. Irreversible: coverage ends before the archive day — today in the workspace payout calendar, or the day after the last period an approved bill already covers, if that is later; the response's archivedOn is that effective day. Complete earlier periods stay payable. Archiving an archived agreement changes nothing. Body: {} or empty. 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/fixed-agreements/{id}/archive

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/team-payouts/fixed-agreements/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive" \  -H "Idempotency-Key: string"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed",    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",    "projectName": "string",    "cadence": "PROJECT",    "description": "string",    "amount": "string",    "currency": "string",    "startsOn": "2019-08-24",    "endsOn": "2019-08-24",    "archivedAt": "2019-08-24T14:15:22Z",    "archivedOn": "2019-08-24",    "status": "ACTIVE",    "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?