Estás en: Documentación › Facturación › Listar proformas
Listar proformas
Parámetros que acepta este endpoint y campos que devuelve.
GET
/v1/proformasPermiso necesario en la clave: proformas:read (o *).
Parámetros de ruta
Este endpoint no tiene parámetros de ruta.
Parámetros de consulta
Van en la dirección, detrás de ? y separados por &. Todos son opcionales.
| Nombre | Tipo | Obligatorio | Qué hace | Ejemplo |
|---|---|---|---|---|
status | texto (lista) | No | Estado del registro. Solo se admiten los valores de la lista. Valores: draft (borrador), validated (validado), sent (enviado), accepted (aceptado), rejected (rechazado), billed (facturado), cancelled (anulado).draftvalidatedsentacceptedrejectedbilledcancelled | draft |
customer_id | número entero | No | Identificador del cliente (campo «id» de /customers). | 341 |
date_from | fecha AAAA-MM-DD | No | Fecha inicial, inclusive. Formato AAAA-MM-DD. Para un trimestre: 2026-04-01. | 2026-04-01 |
date_to | fecha AAAA-MM-DD | No | Fecha final, inclusive. Formato AAAA-MM-DD. Para un trimestre: 2026-06-30. | 2026-06-30 |
updated_since | fecha y hora ISO 8601 | No | Solo registros creados o modificados desde ese momento (ISO 8601 UTC). Sirve para sincronizar solo cambios. | 2026-11-01T00:00:00Z |
limit | número entero | No | Cuántos registros devuelve cada página (1 a 100). Por defecto 25. | 50 |
page | número entero | No | Número de página, empezando en 1. Con meta.has_more = true hay más páginas. | 1 |
Campos de la respuesta
| Campo | Tipo | Qué contiene |
|---|---|---|
id | número entero | Identificador interno del documento. |
ref | texto | Número visible del documento. |
status | texto (lista) | draft, validated, sent, accepted, rejected, billed o cancelled. |
date | fecha AAAA-MM-DD | Fecha del documento (AAAA-MM-DD). |
validated_on | fecha AAAA-MM-DD | Fecha de validación. |
due_date | fecha AAAA-MM-DD | Vencimiento. Es null si el taller no lo informa. |
customer.id | número entero | Cliente: identificador. |
customer.code | texto | Cliente: código. |
customer.name | texto | Cliente: nombre o razón social. |
customer.tax_id | texto | Cliente: NIF / CIF. |
vehicle_id | número entero | Vehículo, si lo hay. |
work_order_id | número entero | Orden de trabajo, si la hay. |
origin_id | número entero | Documento del que procede (por ejemplo, el presupuesto). |
origin_type | texto (lista) | Tipo del documento de origen: quote, proforma o invoice. |
origin_ref | texto | Número visible del documento de origen. |
currency | texto | Moneda. |
tax_type | texto | Impuesto del taller: IVA, IGIC o IPSI. Null si no está configurado. |
total_net | número | Base imponible. |
total_tax | número | Importe del impuesto (IVA, IGIC o IPSI según tax_type). |
total_gross | número | Total con impuestos. |
discount_percent | número | Descuento en %. |
discount_amount | número | Descuento en importe. |
tax_breakdown[].rate | número | Desglose: tipo impositivo en %. |
tax_breakdown[].base | número | Desglose: base de ese tipo. |
tax_breakdown[].tax | número | Desglose: cuota de ese tipo. |
notes | texto | Observaciones públicas del documento. |
created_at | fecha y hora ISO 8601 | Alta. Fecha y hora ISO 8601 en UTC. |
updated_at | fecha y hora ISO 8601 | Última modificación. Fecha y hora ISO 8601 en UTC. |