Create a per diem
Crew module
POST/per-diemsperDiems.create
A per diem allowance for an engagement. Creates a per diem. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability crew.rate_card.write.
- OAuth scopes: crew.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: PerDiemCreate
| Field | Type | Required | Description |
|---|---|---|---|
| engagement_id | string (uuid) | null | No | Identifier of the engagement. |
| project_id | string (uuid) | Yes | Identifier of the project worked. |
| membership_id | string (uuid) | null | No | Identifier of the membership of the person paid; null for external crew, who carry an engagement. |
| day | string (date) | Yes | Day the allowance covers. |
| amount_minor | integer (int64) | Yes | Allowance for the day. Integer minor units of the row's currency.Constraints: range 0 to any |
| currency_code | string | Yes | ISO 4217 currency.Constraints: pattern ^[A-Z]{3}$ |
{
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"day": "2026-10-08",
"amount_minor": 6500,
"currency_code": "USD"
}Response 201: PerDiem
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the per diem. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| engagement_id | string (uuid) | null | Yes | Identifier of the engagement. |
| project_id | string (uuid) | Yes | Identifier of the project worked. |
| membership_id | string (uuid) | null | Yes | Identifier of the membership of the person paid; null for external crew, who carry an engagement. |
| day | string (date) | Yes | Day the allowance covers. |
| amount_minor | integer (int64) | null | Yes | Allowance for the day. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | Yes | ISO 4217 currency.Constraints: pattern ^[A-Z]{3}$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"day": "2026-10-08",
"amount_minor": 6500,
"currency_code": "USD"
}Code samples
curl -X POST "$XOS_BASE_URL/per-diems" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","day":"2026-10-08","amount_minor":6500,"currency_code":"USD"}'const { data } = await xos.perDiems.create({
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"day": "2026-10-08",
"amount_minor": 6500,
"currency_code": "USD"
});response = xos.per_diems.create({"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "day": "2026-10-08", "amount_minor": 6500, "currency_code": "USD"})xos per-diems create --data '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","day":"2026-10-08","amount_minor":6500,"currency_code":"USD"}'