Factuarea APIDevelopers

Registrar una representació

Registra la representació que permet a Factuarea remetre els teus registres VeriFactu a l'AEAT amb el seu propi certificat.

  • Envia multipart/form-data amb kind (social_collaboration_annex_i o aeat_power_of_attorney), signer_name, signer_tax_id, granted_on i l'evidència: l'annex I signat com a document (PDF, fins a 5 MB, validat per magic bytes) per a la col·laboració social, i el justificant de l'apoderament com a document o la seva referència a power_of_attorney_reference per a un apoderament.
  • El document es custodia xifrat i compta per a la teva quota d'emmagatzematge (402 storage_quota_exceeded).
  • Si ja hi havia una representació vigent, es revoca i es conserva a l'historial, i la nova passa a ser la vigent.
  • L'opcional valid_until fixa l'últim dia de vigència (no abans de granted_on, com a màxim 5 anys després); sense ell, la representació no caduca, i un cop passat aquest dia deixa d'habilitar la remissió per tercer (se t'avisa 30 i 7 dies abans i en caducar).
  • Si la teva empresa ja remet per un mode de tercer, registrar una representació de l'ALTRE tipus mou el mode al que aquest tipus demana (annex I → social_collaborator, apoderament → power_of_attorney), o de tornada a own_certificate quan aquest mode no es pot fer servir, perquè aquesta instància no ofereix el col·laborador social o la nova representació ja està caducada, i es reactiven els registres que estaven bloquejats esperant-la.
  • Amb own_certificate no canvia res: canvia de mode explícitament amb PUT /v1/verifactu/settings, que exigeix aquesta representació.
  • Retorna 201 amb data (la nova representació) i remission_mode, el mode de remissió resultant, més una capçalera Location; una càrrega invàlida retorna 422 (param anomena el camp; l'evidència absent o que no és un PDF vàlid és business_rule_violation / invalid_representation).
POST
/verifactu/representation
AuthorizationBearer <token>

A: header

Headers

Idempotency-Key*string

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que permet reintents segurs: la primera resposta s'emmagatzema i es reprodueix en les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'idempotència. Obligatòria en aquesta operació: repetir-la produeix un efecte irreversible (un correu enviat, un fitxer generat, una crida a un tercer o un càrrec), per la qual cosa una petició sense aquesta capçalera es rebutja amb 422 idempotency_key_required abans d'executar lògica de negoci.

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ó

multipart/form-data

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