Factuarea APIDevelopers

Arxivar un contacte

Arxiva un contacte: una baixa reversible que l’aparta del dia a dia sense deixar de poder consultar-lo.

  • Arxivar està SEMPRE permès —les factures, els contractes o les ofertes de proveïdor que el referencien mai no ho bloquegen— i és idempotent: arxivar un contacte ja arxivat retorna 200 i conserva el primer archived_at.
  • El contacte conserva la seva identitat, els seus rols amb el seu estat, els perfils direccionals, els comptes bancaris, els àlies legacy i tots els seus documents, continua sent consultable per id amb is_archived: true i es pot recuperar amb PUT /contacts/{contact}/restore.
  • Requereix contacts:delete, com les altres dues baixes, perquè treu el contacte de l’operativa.
  • Perquè el contacte desaparegui de l’aplicació, fes servir DELETE /contacts/{contact}.
  • Un UUID d’una altra empresa retorna el mateix 404 contact_not_found que un UUID desconegut.
POST
/contacts/{contact}/archive
AuthorizationBearer <token>

A: header

Paràmetres de ruta

contact*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 resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json