Set the contracted additional tax ID seats

Set the contracted additional tax ID seats of the account to an absolute contracted_seats. - A higher value buys the missing seats now (402 payment_method_required or additional_nif_charge_failed buys nothing); a lower one is a reduction applied at renewal, without refund. - Going below the occupied seats needs deactivate with exactly the surplus (422 contracted_seats_selection_required); breaking an offer package needs accept_offer_package_loss. - Idempotency-Key is mandatory.

Above the cap: 422 additional_nif_limit_reached.

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

account*string

Public identifier (UUID v7) of your account. Get it from GET /v1/me (data.account.id).

Formatuuid

Headers

Idempotency-Key*string

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.

Length1 <= length <= 255

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contracted_seats*integer

Contracted seats wanted (absolute value, 0 or more).

Range0 <= value <= 1000

deactivate?array<>|

IDs (UUID v7) of the employees or tax IDs to deactivate at the renewal when going below the occupied seats. Exactly occupied minus the new total, all occupying a seat of the account; otherwise 422 contracted_seats_selection_required.

Itemsitems <= 1000

accept_offer_package_loss?|

Confirms losing the applied offer package that the reduction breaks (default false). Without it the reduction is rejected with 422 offer_package_loss_unconfirmed.

Response Body

`application/json`

Request example

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/accounts/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/additional-nif-seats", {  method: "PATCH",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-additional-nif-seats-update"} },  body: JSON.stringify({  "contracted_seats": 5}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

PATCH /v1/accounts/{account}/additional-nif-seats · 200

{
  "data": {
    "object": "additional_nif_seats",
    "subscribed": true,
    "quantity": 3,
    "seats_billable": true,
    "max_additional_nifs": null,
    "seats": {
      "contracted": 3,
      "occupied": 2,
      "free": 1,
      "agreed_minimum": 0,
      "agreed_minimum_ends_at": null,
      "reducible_to": 0,
      "pending_reduction": null,
      "enforced": true
    }
  }
}

PATCH /v1/accounts/{account}/additional-nif-seats · 200 reduction scheduled at renewal

{
  "data": {
    "object": "additional_nif_seats",
    "subscribed": true,
    "quantity": 3,
    "seats_billable": true,
    "max_additional_nifs": null,
    "seats": {
      "contracted": 3,
      "occupied": 2,
      "free": 1,
      "agreed_minimum": 0,
      "agreed_minimum_ends_at": null,
      "reducible_to": 0,
      "pending_reduction": {
        "contracted": 1,
        "effective_at": "2026-12-01T00:00:00+00:00",
        "deactivations": [
          {
            "id": "0198f2d4-1b7e-7c3a-9d41-6a5e8b2c4f21",
            "name": "Taller Norte, S.L."
          }
        ],
        "offer_package_loss": null
      },
      "enforced": true
    }
  }
}

Retired X-Active-Profile header sent

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "subcode": "retired_active_profile_header",
    "message": "La cabecera 'X-Active-Profile' fue retirada de la API v1: la empresa efectiva se indica en el segmento de empresa de la ruta.",
    "param": "X-Active-Profile",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01J8Y3M2Q40000000000000001"
  }
}

Malformed Factuarea-Version header

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_format",
    "message": "El header 'Factuarea-Version' debe tener formato YYYY-MM-DD.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_format",
    "request_id": "req_01J8Y3M2Q40000000000000002"
  }
}

Unsupported Factuarea-Version

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_api_version",
    "message": "La versión de API '2020-01-01' no está soportada.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#unsupported_api_version",
    "request_id": "req_01J8Y3M2Q40000000000000003"
  }
}

{
  "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_61a5c0d17e2b94f3a8d05c1e72"
  }
}

{
  "error": {
    "type": "payment_required_error",
    "code": "payment_method_required",
    "message": "Comprar plazas de NIF adicional cobra de inmediato y la cuenta opera en modo real sin método de pago configurado.",
    "doc_url": "https://docs.factuarea.com/guides/errors#payment_method_required",
    "request_id": "req_e29418f073ad1bf48eb57c62bd"
  }
}

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

Resource not found

{
  "error": {
    "type": "not_found_error",
    "code": "resource_not_found",
    "message": "El recurso solicitado no existe o pertenece a otra empresa.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_not_found",
    "request_id": "req_01HKQS5NEQ6X1R4N9B0C5DWTPG"
  }
}

Account not found or not the account of the API key

{
  "error": {
    "type": "not_found_error",
    "code": "account_not_found",
    "message": "La cuenta indicada no existe o no es la de tu credencial.",
    "param": "account",
    "doc_url": "https://docs.factuarea.com/guides/errors#account_not_found",
    "request_id": "req_01J8Y3M2Q40000000000000006"
  }
}

Employee operation outcome unknown

{
  "error": {
    "type": "conflict_error",
    "code": "employee_seat_mutation_outcome_unknown",
    "subcode": "employee_seat_mutation_outcome_unknown",
    "message": "La operación de empleados sigue pendiente de comprobación. No repitas el cargo; contacta con soporte indicando la referencia de la operación.",
    "details": {
      "operation_id": "01990c3a-5b2e-7c41-9d3f-2a6b8e1f4c13",
      "operation_kind": "legacy_employee"
    },
    "doc_url": "https://docs.factuarea.com/guides/errors#employee_seat_mutation_outcome_unknown",
    "request_id": "req_01J8Y3M2Q4CF0000000000ESM1"
  }
}

Employee operation in progress

{
  "error": {
    "type": "conflict_error",
    "code": "employee_seat_operation_in_progress",
    "subcode": "employee_seat_operation_in_progress",
    "message": "Hay una operación de empleados pendiente. Consulta su estado antes de iniciar otra.",
    "details": {
      "operation_id": "01990c3a-5b2e-7c41-9d3f-2a6b8e1f4c14"
    },
    "doc_url": "https://docs.factuarea.com/guides/errors#employee_seat_operation_in_progress",
    "request_id": "req_01J8Y3M2Q4CF0000000000ESO1"
  }
}

Scheduled conditions block the seat change

{
  "error": {
    "type": "conflict_error",
    "code": "employee_seat_phase_incompatible",
    "subcode": "employee_seat_phase_incompatible",
    "message": "La suscripción tiene condiciones programadas que requieren revisión antes de cambiar sus plazas.",
    "param": "quantity",
    "details": {
      "reason": "phase_incompatible"
    },
    "doc_url": "https://docs.factuarea.com/guides/errors#employee_seat_phase_incompatible",
    "request_id": "req_01J8Y3M2Q4CF0000000000ESP1"
  }
}

Billing operation still being verified

{
  "error": {
    "type": "conflict_error",
    "code": "customer_offer_legacy_outcome_unknown",
    "message": "Estamos confirmando con el procesador de pagos el resultado de una operación anterior. Espera unos minutos y vuelve a intentarlo; si el aviso continúa, contacta con soporte.",
    "details": {
      "operation_id": "01990c3a-5b2e-7c41-9d3f-2a6b8e1f4c11"
    },
    "doc_url": "https://docs.factuarea.com/guides/errors#customer_offer_legacy_outcome_unknown",
    "request_id": "req_01J8Y3M2Q4CF0000000000COL1"
  }
}

Another operation is in progress

{
  "error": {
    "type": "conflict_error",
    "code": "customer_offer_operation_in_progress",
    "subcode": "customer_offer_operation_in_progress",
    "message": "Hay otra operación de facturación en curso para tu empresa. Espera unos minutos y vuelve a intentarlo; si el aviso continúa, contacta con soporte.",
    "doc_url": "https://docs.factuarea.com/guides/errors#customer_offer_operation_in_progress",
    "request_id": "req_01J8Y3M2Q4CF0000000000COP1"
  }
}

Private price cannot be verified

{
  "error": {
    "type": "conflict_error",
    "code": "customer_offer_price_mapping_conflict",
    "subcode": "customer_offer_price_mapping_conflict",
    "message": "No se puede acreditar el precio particular de esta compra.",
    "doc_url": "https://docs.factuarea.com/guides/errors#customer_offer_price_mapping_conflict",
    "request_id": "req_01J8Y3M2Q4CF0000000000COM1"
  }
}

Operation state does not allow the action

{
  "error": {
    "type": "conflict_error",
    "code": "customer_offer_state_conflict",
    "subcode": "customer_offer_state_conflict",
    "message": "La operación no admite esta acción. Consulta su estado actual.",
    "doc_url": "https://docs.factuarea.com/guides/errors#customer_offer_state_conflict",
    "request_id": "req_01J8Y3M2Q4CF0000000000COS1"
  }
}

Idempotency key bound to another batch

{
  "error": {
    "type": "idempotency_error",
    "code": "employee_batch_idempotency_conflict",
    "subcode": "employee_batch_idempotency_conflict",
    "message": "La clave ya corresponde a otra intención. Conserva la operación actual o prepara una intención nueva.",
    "doc_url": "https://docs.factuarea.com/guides/errors#employee_batch_idempotency_conflict",
    "request_id": "req_01J8Y3M2Q4CF0000000000EBI1"
  }
}

Action not compatible with the batch state

{
  "error": {
    "type": "conflict_error",
    "code": "employee_batch_state_conflict",
    "subcode": "employee_batch_state_conflict",
    "message": "Esta acción no es compatible con el estado del lote. Consulta su estado actual.",
    "doc_url": "https://docs.factuarea.com/guides/errors#employee_batch_state_conflict",
    "request_id": "req_01J8Y3M2Q4CF0000000000EBS1"
  }
}

Acquired seat conditions cannot be preserved

{
  "error": {
    "type": "conflict_error",
    "code": "customer_offer_phase_incompatible",
    "subcode": "customer_offer_phase_incompatible",
    "message": "Las condiciones adquiridas del asiento requieren revisión antes de añadir empresas gestionadas.",
    "param": "quantity",
    "details": {
      "reason": "phase_incompatible"
    },
    "doc_url": "https://docs.factuarea.com/guides/errors#customer_offer_phase_incompatible",
    "request_id": "req_01J8Y3M2Q4CF0000000000CSI1"
  }
}

PATCH /v1/accounts/{account}/additional-nif-seats · 422 contracted_seats_selection_required

{
  "error": {
    "type": "invalid_request_error",
    "code": "business_rule_violation",
    "message": "Elige exactamente 1 empresas para desactivar en la renovación.",
    "subcode": "contracted_seats_selection_required",
    "param": "deactivate",
    "details": {
      "product": "additional-nifs",
      "requested": 1,
      "occupied": 2,
      "required": 1,
      "selected": 0,
      "invalid": 0
    },
    "doc_url": "https://docs.factuarea.com/guides/errors#business_rule_violation",
    "request_id": "req_f3a529f184be2c059fc68d73ce"
  }
}

PATCH /v1/accounts/{account}/additional-nif-seats · 422 offer_package_loss_unconfirmed

{
  "error": {
    "type": "invalid_request_error",
    "code": "business_rule_violation",
    "message": "Reducir las plazas hará que termine el paquete de oferta «Paquete de lanzamiento»: todos sus precios volverán al de catálogo. Confirma la pérdida para continuar.",
    "subcode": "offer_package_loss_unconfirmed",
    "param": "accept_offer_package_loss",
    "details": {
      "product": "additional-nifs",
      "package_id": "0198f2d4-1b7e-7c3a-9d41-6a5e8b2c4f10",
      "name": "Paquete de lanzamiento",
      "effective_at": "2026-12-01T00:00:00+00:00",
      "lines": [
        {
          "from_price": 200,
          "to_price": 250,
          "interval": "month",
          "concept": "gestoria-seats"
        }
      ]
    },
    "doc_url": "https://docs.factuarea.com/guides/errors#business_rule_violation",
    "request_id": "req_04b63aa295cf3d16a0d79e84df"
  }
}

PATCH /v1/accounts/{account}/additional-nif-seats · 422 additional_nif_limit_reached

{
  "error": {
    "type": "invalid_request_error",
    "code": "business_rule_violation",
    "message": "La cuenta ha alcanzado su límite de NIF adicionales.",
    "subcode": "additional_nif_limit_reached",
    "doc_url": "https://docs.factuarea.com/guides/errors#business_rule_violation",
    "request_id": "req_15c74bb3a6d04e27b1e8af95e0"
  }
}

Idempotency key reused with a different payload

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "La Idempotency-Key 'order-2026-0001' ya se usó con un payload distinto.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_01J8Y3M2Q40000000000000007"
  }
}

Invalid Idempotency-Key format

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_format",
    "message": "La Idempotency-Key debe tener entre 1 y 255 caracteres ASCII printable.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_format",
    "request_id": "req_01J8Y3M2Q40000000000000008"
  }
}

Idempotency-Key missing on an external-effect write

{
  "error": {
    "type": "invalid_request_error",
    "code": "idempotency_key_required",
    "message": "La operación «public-api.v1.invoices.send» exige la cabecera Idempotency-Key desde el 2026-10-01. Envía una clave única por operación (un UUID sirve) y, si reintenta, repite exactamente la misma clave para que la operación no se ejecute dos veces.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_required",
    "request_id": "req_01J8Y3M2Q40000000000000009"
  }
}

{
  "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_8c3e52fa1d46b79e2e5f1c0b74"
  }
}

{
  "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_9d4f63ab2e57c8af3f602d1c85"
  }
}

Set the contracted additional tax ID seats

Authorization

Path Parameters

Headers

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`