Factuarea APIDevelopers

Actualitzar una sèrie

Actualitza parcialment una sèrie: només canvien els camps que envies (name, code, counter_reset, number_format, initial_number, invoice_kind; year_reset és l'àlies deprecat de counter_reset).

  • S'apliquen les mateixes guardes fiscals que a l'aplicació web, cadascuna com un 422 business_rule_violation amb el seu propi subcode i sense canviar res: code i number_format només mentre la sèrie no té documents (series_code_immutable_with_documents, series_format_immutable_with_documents); quan l'AEAT ha acceptat un registre d'alguna de les seves factures, code, number_format i initial_number queden bloquejats (series_locked_by_verifactu); initial_number no pot obrir un salt (series_initial_number_creates_gap); invoice_kind queda fix amb la primera factura (series_invoice_kind_locked) i la sèrie predeterminada d'un propòsit no pot canviar de propòsit (series_default_kind_change).
  • Un code ja usat per una altra sèrie del mateix tipus de document retorna 422 amb param=code; document_type no es pot canviar.
  • Retorna 200 amb la sèrie actualitzada, i 404 series_not_found si no pertany a la teva empresa.
PUT
/series/{series}
AuthorizationBearer <token>

A: header

Paràmetres de ruta

series*string

Headers

Idempotency-Key?string

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.

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json