Estás en: Documentación › Facturación › Pagos de una factura
Pagos de una factura
Parámetros que acepta este endpoint y campos que devuelve.
GET
/v1/invoices/{id}/paymentsPermiso necesario en la clave: invoices: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
Van en la dirección, detrás de ? y separados por &. Todos son opcionales.
| Nombre | Tipo | Obligatorio | Qué hace | Ejemplo |
|---|---|---|---|---|
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 del cobro. |
ref | texto | Referencia del cobro. |
invoice_id | número entero | Factura a la que pertenece. |
date | fecha AAAA-MM-DD | Fecha del cobro (AAAA-MM-DD). |
amount | número | Importe. |
method | texto | Medio de pago. |
is_refund | sí / no | true si es una devolución. |
created_at | fecha y hora ISO 8601 | Alta. Fecha y hora ISO 8601 en UTC. |