Obtener Cuentas por Pagar

Descripción

Recupera una lista de cuentas por pagar registradas en el sistema. El endpoint permite aplicar diversos filtros para refinar los resultados según fechas, montos, estado y datos bancarios.

OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.

🔑 Parámetros de Consulta (Query Params)

Este endpoint soporta filtros opcionales mediante parámetros de consulta para refinar los resultados.

Parámetro	Tipo	Obligatorio	Descripción
description	string	No	Filtra por la descripción de la cuenta.
dateInputStart	date-time	No	Filtra cuentas con fecha de registro a partir de una fecha (YYYY-MM-DD).
dateInputEnd	date-time	No	Filtra cuentas con fecha de registro hasta una fecha (YYYY-MM-DD).
dueDateStart	date-time	No	Filtra cuentas con fecha de vencimiento a partir de una fecha (YYYY-MM-DD).
dueDateEnd	date-time	No	Filtra cuentas con fecha de vencimiento hasta una fecha (YYYY-MM-DD).
datePaymentStart	date-time	No	Filtra cuentas con fecha de pago a partir de una fecha (YYYY-MM-DD).
datePaymentEnd	date-time	No	Filtra cuentas con fecha de pago hasta una fecha (YYYY-MM-DD).
compentenceStart	date-time	No	Filtra cuentas con fecha de competencia contable a partir de una fecha (YYYY-MM-DD).
competenceEnd	date-time	No	Filtra cuentas con fecha de competencia contable hasta una fecha (YYYY-MM-DD).
bankAccount	string	No	Filtra por cuentas bancarias asociadas. Se pueden usar múltiples IDs separados por coma, ej: 2,215.
ammountStart	number	No	Filtra cuentas con monto mínimo a pagar.
ammountEnd	number	No	Filtra cuentas con monto máximo a pagar.
accountStatus	string	No	Filtra por estado de la cuenta. Use IDs separados por coma: 1 - Abierta, 2 - Pagada, 3 - Cancelada.
take	int32	No	Número total de registros a retornar. Valor por defecto: 50. Máximo permitido: 50.
skip	int32	No	Número de registros a omitir (para paginación). Valor por defecto: 0.

📤 Estructura de la Respuesta

La respuesta devuelve una lista de cuentas por pagar registradas, incluyendo información financiera, fechas de control, centro de costo, estado, destino, cuenta bancaria y datos complementarios.

Campo	Tipo	Descripción
`idPayable`	int32	Identificador único de la cuenta por pagar.
`description`	string	Descripción de la cuenta por pagar.
`recipient`	string	Destinatario del pago.
`costCenter`	object	Centro de costo asociado a la cuenta por pagar. Ver más abajo.
`inputDate`	date-time	Fecha de registro de la cuenta por pagar.
`dueDate`	date-time	Fecha de vencimiento de la cuenta por pagar.
`paymentDate`	date-time	Fecha en que se realizó el pago.
`competenceDate`	date-time	Fecha de competencia contable de la cuenta.
`cancellationDate`	date-time	Fecha de cancelación de la cuenta por pagar, si aplica.
`ammount`	number	Monto total de la cuenta por pagar.
`ammountPaid`	number	Monto efectivamente pagado.
`status`	object	Estado actual de la cuenta. Ver más abajo.
`destination`	object	Destino financiero del pago. Ver más abajo.
`bankAccount`	object	Cuenta bancaria utilizada para el pago. Ver más abajo.
`beneficiary`	string	Beneficiario del pago.
`categories`	string	Categoría(s) asociada(s) a la cuenta por pagar.
`observation`	string	Observaciones adicionales sobre la cuenta.

🧩 Estructura del Objeto `costCenter`

Campo	Tipo	Descripción
`id`	int32	Identificador del centro de costo.
`name`	string	Nombre del centro de costo.

🧩 Estructura del Objeto `status`

Campo	Tipo	Descripción
`id`	int32	Identificador del estado de la cuenta.
`name`	string	Nombre o descripción del estado.

🧩 Estructura del Objeto `destination`

Campo	Tipo	Descripción
`id`	int32	Identificador del destino financiero.
`name`	string	Nombre del destino financiero.

🧩 Estructura del Objeto `bankAccount`

Campo	Tipo	Descripción
`id`	int32	Identificador de la cuenta bancaria.
`name`	string	Nombre o descripción de la cuenta.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "idPayable": 0,
    "description": "string",
    "recipient": "string",
    "costCenter": {
        "id": 0,
        "name": "string"
    },
    "inputDate": "2019-08-24T14:15:22.123Z",
    "dueDate": "2019-08-24T14:15:22.123Z",
    "paymentDate": "2019-08-24T14:15:22.123Z",
    "competenceDate": "2019-08-24T14:15:22.123Z",
    "cancellationDate": "2019-08-24T14:15:22.123Z",
    "ammount": 0,
    "ammountPaid": 0,
    "status": {
        "id": 0,
        "name": "string"
    },
    "destination": {
        "id": 0,
        "name": "string"
    },
    "bankAccount": {
        "id": 0,
        "name": "string"
    },
    "beneficiary": "string",
    "categories": "string",
    "observation": "string"
}

🟠400Bad Request

Get payables

Obtener Cuentas por Pagar#

Descripción#

🔑 Parámetros de Consulta (Query Params)#

📤 Estructura de la Respuesta#

🧩 Estructura del Objeto costCenter#

🧩 Estructura del Objeto status#

🧩 Estructura del Objeto destination#

🧩 Estructura del Objeto bankAccount#

Requisição