Arxivar una sèrie
Arxiva una sèrie perquè deixi d'aparèixer com a disponible per a nous documents. Falla amb 409 si la sèrie és la predeterminada i l'única sèrie activa del seu tipus. Retorna 204 en cas d'èxit.
A: header
Paràmetres de ruta
Paràmetres de capçalera
Clau única generada pel client per garantir la idempotència en els reintents. Et permet reenviar de manera segura la mateixa petició: la primera resposta es cacheja i es retorna sense tornar a executar la mutació. És una cadena opaca per al servidor; qualsevol valor únic de fins a 64 caràcters és vàlid (UUID v7, UUID v4, ULID, nanoid, etc.). Es recomana UUID v7 per coherència amb els identificadors de l'API. La mateixa clau reutilitzada amb un body diferent retorna 409 idempotency_key_reused.
1 <= length <= 64Cos de la resposta
application/json
application/json
application/json
application/json
application/json
{
"error": {
"type": "authentication_error",
"code": "missing_api_key",
"message": "No se ha proporcionado una API key válida en el header Authorization.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
"request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
}
}{
"error": {
"type": "authorization_error",
"code": "insufficient_scope",
"message": "Esta API key no tiene el scope requerido para esta operación.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
"request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
}
}{
"error": {
"type": "idempotency_error",
"code": "idempotency_key_reused",
"message": "La cabecera `Idempotency-Key` ya se usó con un body distinto. Usa una clave nueva o reenvía exactamente el mismo body.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
"request_id": "req_01HKQS5NHT9A4U7R2E3F8GZWTJ"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
"request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
}
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
"request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
}
}Llista la línia temporal d'activitat de la sèrie
Retorna la línia de temps d'auditoria d'una sèrie combinant els seus propis esdeveniments de domini (creació, arxivament/desarxivament, canvis de predeterminat, consum de numeració). Paginada amb un cursor de número de pàgina (`starting_after` és el número de la pàgina següent).
Crea una sèrie
Crear una sèrie de numeració de documents. El `number_format` opcional fixa la màscara de numeració (padding + token d'any + separador, p. ex. `{code}-{YYYY}-{00000}`); una màscara malformada retorna 422. El `initial_number` opcional (>= 1) inicia el comptador en un valor donat per continuar una numeració existent en migrar (per defecte 1). El mateix codi pot reutilitzar-se entre tipus de document (multi-sèrie). Un cop creada, una sèrie és immutable per compliment de l'AEAT (el mètode `PUT` retorna 405), de manera que `number_format` i `initial_number` només poden fixar-se aquí.