Crear un horari de treball

Crea un horari de treball setmanal per a l'empresa autenticada (resolta des de l'API key, mai des del payload).

name i week_pattern són obligatoris; mode pren per defecte validated.
El week_pattern és una llista de dies de la setmana (ISO 8601 1..7) cadascun amb les seves franges horàries HH:MM ordenades i sense solapar-se (un ranges buit significa dia de descans).
Retorna l'horari creat amb el seu id generat (UUID v7); weekly_hours es deriva del patró.

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que fa segurs els reintents: la primera resposta es cacheja i es reprodueix a les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'Idempotency.

Longitud1 <= length <= 255

Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la petició

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

name*string

Nom de l'horari setmanal.

Longitudlength <= 120

mode*string

Mode de l'horari: validated (s'assumeix complert) o real_clocking (calculat a partir dels fitxatges reals).

Valor a"validated" | "real_clocking"

week_pattern*array<>

Patró setmanal: llista de dies amb les seves franges horàries.

Elements1 <= items <= 7

Cos de la resposta

`application/json`

Exemple de petició

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/work-schedules", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-work_schedules-create"} },  body: JSON.stringify({  "name": "Jornada estándar oficina",  "mode": "validated",  "week_pattern": [    {      "day": 1,      "ranges": [        {          "start": "09:00",          "end": "14:00"        },        {          "start": "15:00",          "end": "18:00"        }      ]    },    {      "day": 2,      "ranges": [        {          "start": "09:00",          "end": "14:00"        },        {          "start": "15:00",          "end": "18:00"        }      ]    },    {      "day": 3,      "ranges": [        {          "start": "09:00",          "end": "14:00"        },        {          "start": "15:00",          "end": "18:00"        }      ]    },    {      "day": 4,      "ranges": [        {          "start": "09:00",          "end": "14:00"        },        {          "start": "15:00",          "end": "18:00"        }      ]    },    {      "day": 5,      "ranges": [        {          "start": "08:00",          "end": "15:00",          "flexible": true,          "required_minutes": 360        }      ]    },    {      "day": 6,      "ranges": []    },    {      "day": 7,      "ranges": []    }  ]}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "data": {
    "id": "01933a20-9d32-7c4e-8a5b-2b3c4d5e6f01",
    "object": "work_schedule",
    "name": "Jornada partida",
    "mode": "validated",
    "week_pattern": [
      {
        "day": 1,
        "ranges": [
          {
            "start": "09:00",
            "end": "14:00"
          },
          {
            "start": "15:00",
            "end": "18:00"
          }
        ]
      },
      {
        "day": 5,
        "ranges": [
          {
            "start": "08:00",
            "end": "15:00"
          }
        ]
      }
    ],
    "weekly_hours": 40,
    "status": "active",
    "created_at": "2024-09-01T10:00:00Z",
    "updated_at": "2024-09-01T10:00:00Z"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_4f262e19361631f207069b576a"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'work_schedules:write'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_0ddd813dd40c86f2e846fa9bf9"
  }
}

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_c016db15709bfdff64c61ad1d7"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo name es obligatorio.",
    "param": "name",
    "errors": [
      {
        "param": "name",
        "code": "parameter_missing",
        "message": "El campo name es obligatorio."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_bbd7666e09012dd78ae6f35dc0"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_a19ecc28ed8d4ba8040fbfe5d7"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_dd56ee674f30e0b14dcbc42d20"
  }
}

Crear un horari de treball

Authorization

Headers

Cos de la petició

Cos de la resposta

201application/json

401application/json

403application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`