Estás en: Documentación › Facturación › Obtener una proforma

Obtener una proforma

Parámetros que acepta este endpoint y campos que devuelve.

GET/v1/proformas/{id}

Permiso necesario en la clave: proformas:read (o *).

Parámetros de ruta

Nombre	Tipo	Obligatorio	Qué es	Ejemplo
`{id}`	número entero	Sí	Identificador numérico del registro, el campo «id» que devuelve el listado.	`32`

Parámetros de consulta

Este endpoint no admite filtros.

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.
`lines[].id`	número entero	Línea: identificador.
`lines[].position`	número entero	Línea: orden.
`lines[].type`	texto	Línea: tipo (mano_obra, recambio…).
`lines[].description`	texto	Línea: descripción.
`lines[].quantity`	número	Línea: cantidad.
`lines[].unit_price`	número	Línea: precio unitario sin impuestos.
`lines[].discount_percent`	número	Línea: descuento en %.
`lines[].tax_rate`	número	Línea: tipo impositivo en %.
`lines[].total_net`	número	Línea: base.
`lines[].total_tax`	número	Línea: impuesto.
`lines[].total_gross`	número	Línea: total.
`lines[].product_id`	número entero	Línea: producto del catálogo, si lo hay.

{ "data": { "id": 32, "ref": "FA26000001", "status": "validated", "date": "2026-04-30", "validated_on": "2026-06-24", "due_date": null, "customer": { "id": 341, "code": "CLI00008", "name": "DISTRIBUCIONES DEL SUR SA", "tax_id": "A41987654" }, "vehicle_id": null, "work_order_id": null, "origin_id": 19, "origin_type": "quote", "origin_ref": "PR26000019", "currency": "EUR", "tax_type": "IGIC", "total_net": 44, "total_tax": 3.08, "total_gross": 47.08, "discount_percent": 0, "discount_amount": 0, "tax_breakdown": [ { "rate": 7, "base": 44, "tax": 3.08 } ], "notes": "REVISION MOTOR", "created_at": "2026-04-30T04:52:04Z", "updated_at": "2026-06-24T08:26:38Z", "lines": [ { "id": 101, "position": 1, "type": "recambio", "description": "Filtro de aceite", "quantity": 1, "unit_price": 20, "discount_percent": 0, "tax_rate": 7, "total_net": 20, "total_tax": 1.4, "total_gross": 21.4, "product_id": 55 } ] }, "meta": { "request_id": "req_5215ac4ddec0d940" } }

Código

Significa

401

Falta la clave o es incorrecta.

403

La clave no tiene el permiso necesario.

404

No existe ese registro.

422

Un parámetro no es válido.

429

Demasiadas peticiones: espera y reintenta.

502 / 503

El taller no responde. Prueba más tarde.