v1

latestOpenAPI 3.0.32026-07-24398641.3 MB

Cuentas de banco

Listado de cuentas bancarias

get/bank-accounts

Query parameters

startinteger

A partir de cual cuenta bancaria se desea consultar. Por ejemplo para consultar desde la cuenta bancaria número 20, se envía start=20.

limitinteger

Cantidad de cuentas bancarias a consultar. Por defecto tiene valor 30 y es el máximo valor que acepta. En caso de un valor superior se obtendrá un error en el response.

order_direction'DESC' | 'ASC'

Orden ascendente o descendente para el listado de cuentas bancarias

order_field'id' | 'date'

Campo por el cual se desea ordenar, las opciones posibles son: id, date

fields'deletable' | 'journal' | 'lastMovementDate' | 'category'

Es utilizado para obtener información adicional como:

Para obtener el campo para validar si las cuenta bancaria pueden ser eliminadas se debe enviar el valor deletable en el parámetro fields. Ejemplo: /bank-accounts?fields=deletable.
Para obtener la información de los asientos contables de las cuentas bancarias se debe enviar el valor journal en el parámetro fields. Ejemplo: /bank-accounts?fields=journal.
Para obtener la fecha del último movimiento de las cuentas bancarias se debe enviar el valor lastMovementDate en el parámetro fields. Ejemplo: /bank-accounts?fields=lastMovementDate.
Para obtener las categorías de las cuentas bancarias se debe enviar el valor category en el parámetro fields. Ejemplo: /bank-accounts?fields=category.

includeInactiveboolean

Permite incluir las cuentas bancarias que se encuentran inactivas

includeBalanceboolean

Permite incluir los balances de las cuentas bancarias

metadataboolean

Incluye en la respuesta del request el total de cuentas bancarias.

Response

Successful operation

idstring

namestring

numberstring

descriptionstring

type'credit-card' | 'bank' | 'cash'

status'active' | 'inactive'

initialBalancenumber

initialBalanceDatestring date

Example response

[
  {
    "id": "3",
    "name": "Banco 1",
    "number": "100294",
    "description": "Banco principal",
    "type": "bank",
    "status": "active",
    "initialBalance": 200,
    "initialBalanceDate": "2022-04-01",
    "decimalPrecision": "2",
    "calculationScale": "2"
  },
  {
    "id": "1",
    "name": "Tarjeta de credito",
    "number": "3849939393939393",
    "description": "Tarjeta coorporativa",
    "type": "credit-card",
    "status": "active",
    "initialBalance": -100,
    "initialBalanceDate": "2022-02-01",
    "decimalPrecision": "2",
    "calculationScale": "2"
  }
]