Saltar al contenido

Update a per diem

Módulo Crew

PATCH/per-diems/{id}perDiems.update

A per diem allowance for an engagement. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad crew.rate_card.write.
  • Alcances de OAuth: crew.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

perDiems.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the per diem.

Cuerpo de la solicitud: PerDiemUpdate

perDiems.update: PerDiemUpdate
CampoTipoObligatorioDescripción
engagement_idstring (uuid) | nullNoIdentifier of the engagement.
project_idstring (uuid)NoIdentifier of the project worked.
membership_idstring (uuid) | nullNoIdentifier of the membership of the person paid; null for external crew, who carry an engagement.
daystring (date)NoDay the allowance covers.
amount_minorinteger (int64)NoAllowance for the day. Integer minor units of the row's currency.Restricciones: range 0 to any
currency_codestringNoISO 4217 currency.Restricciones: 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"
}

Respuesta 200: PerDiem

perDiems.update: PerDiem
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the per diem.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
engagement_idstring (uuid) | nullSíIdentifier of the engagement.
project_idstring (uuid)SíIdentifier of the project worked.
membership_idstring (uuid) | nullSíIdentifier of the membership of the person paid; null for external crew, who carry an engagement.
daystring (date)SíDay the allowance covers.
amount_minorinteger (int64) | nullSíAllowance for the day. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringSíISO 4217 currency.Restricciones: 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"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/per-diems/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -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, etag } = await xos.perDiems.update("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"
  }, { ifMatch: etag });
response = xos.per_diems.update("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"}, if_match=etag)
xos per-diems update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --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"}' --if-match auto