Listar Pagos

Listar Pagos

GET https://api.sperant.com/v3/payments

Permite listar la información de todos los pagos. No obstante, se debe enviar el código de proforma y/o número de contrato como parámetro obligatorio.

Query Parameters

Name	Type	Description
status	string	Estado del pago: pending, completed.
budget_code	string	Código de proforma. Consulta el endpoint Listar Proformas.
contract_num	string	Puedes enviar el número de contrato si no deseas enviar el código de proforma. Consulta el endpoint Listar Proformas.

Headers

Name	Type	Description
Authorization	string	Token entregado.

200

{
    "links": {
        "prev": "https://api.eterniasoft.com/v3?budget_code=PRE-COSTANERA-304-0005&page=1",
        "next": "https://api.eterniasoft.com/v3?budget_code=PRE-COSTANERA-304-0005&page=2",
        "last": "https://api.eterniasoft.com/v3?budget_code=PRE-COSTANERA-304-0005&page=1"
    },
    "meta": {
        "page": {
            "total": 6
        }
    },
    "data": [
        {
            "type": "payments",
            "id": "982",
            "links": {
                "self": "https://api.eterniasoft.com/v3/payments/982"
            },
            "attributes": {
                "id": 982,
                "name": "separacion ",
                "amount": 1035,
                "amount_paid": 1035,
                "status": "completed",
                "budget_id": 1465,
                "saldo": 0,
                "mora": 0,
                "tag_id": 5,
                "tag": "Separación",
                "payment_at": 1607555564388,
                "estimated_at": 1607555564388
            }
        },
        {
            "type": "payments",
            "id": "990",
            "links": {
                "self": "https://api.eterniasoft.com/v3/payments/990"
            },
            "attributes": {
                "id": 990,
                "name": "cuota inicial 1",
                "amount": 23000,
                "amount_paid": 2300,
                "status": "pending",
                "budget_id": 1465,
                "saldo": 20700,
                "mora": 0,
                "tag_id": 2,
                "tag": "Cuota Inicial",
                "payment_at": 1607555564388,
                "estimated_at": 1607555564388
            }
        }
    ]
}

Parámetros de retorno

Los parámetros de retorno serán los siguientes:

Parámetro	Tipo de Dato	Descripción
id	integer	Identificador del pago.
name	string	Nombre del pago.
amount	double	Monto programado del pago.
amount_paid	double	Monto abonado del pago.
status	string	Estado del pago. pending -> pendiente o parcial completed -> completado
budget_id	integer	Identificador de la proforma.
saldo	double	Monto pendiente del pago.
mora	double	Monto de la mora del pago.
tag_id	integer	Identificador de la etiqueta del pago.
tag	string	Nombre de la etiqueta del pago.
payment_at	timestamp	Fecha de abono del pago.
estimated_at	timpestamp	Fecha estimada para el pago.