Factuarea APIDevelopers

Facturar el temps d'un projecte

Converteix el temps facturable seleccionat en una factura ESBORRANY per al contacte de facturació del projecte, agrupada segons grouping, i marca aquestes imputacions com a facturades.

  • Requereix el scope invoices:write (crea una factura), no un scope de projectes.
  • L'esborrany es numera en emetre's des de l'API de factures.
  • Les imputacions ja facturades retornen 422 task_time_entry_invoiced; si el pla ha esgotat les seves factures o els seus documents anuals, 402 limit_exceeded i no es crea res.
  • Enviar de nou el mateix batch_id amb la mateixa petició retorna la mateixa factura; reutilitzar un batch_id amb una altra selecció de projecte, una altra agrupació o altres imputacions (o després d'eliminar-ne la factura) retorna 409 idempotency_key_reused.
  • Eliminar l'esborrany de factura allibera les imputacions.
POST
/projects/{project}/time-invoices
AuthorizationBearer <token>

A: header

Paràmetres de ruta

project*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

application/json