ByDomuDevelopers
Create key

Listar registros contables

GEThttps://api.bydomu.com/v1/accounting

This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.

Ingresos y egresos con filtros por tipo, estado, categoría, negocio y fecha (pageSize máximo 500).

Permission
accounting:read
Keys
Secret only (server-side)

Headers

X-API-Keystringrequired
Your secret key.

Query parameters

pageinteger
Página, desde 1 · default=1 · ≥ 1
pageSizeinteger
Registros por página (máximo 500) · default=20 · 1–500
cursorstring
Se valida pero no se aplica en esta operación
includeTotalboolean | string
Se valida pero no se aplica en esta operación
sortBystring
Campo de orden · default="createdAt"
sortOrderstring
Dirección del orden ascdesc · default="desc"
searchstring
Texto en la descripción
typestring
Ingreso o egreso INGRESOEGRESO
statusstring
Estado del registro BORRADORAPROBADOANULADO
categoryIdstring
Categoría contable
dealIdstring
Negocio
dateFromstring
Con fecha desde (ISO 8601) · nullable
dateTostring
Con fecha hasta (ISO 8601) · nullable

Responses

200Página de registros
400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.
403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.
429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.
500INTERNAL_ERROR · Error interno del servidor.
cURL
curl "https://api.bydomu.com/v1/accounting" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/accounting", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/accounting",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Response · 200 · example
{
  "data": [
    {
      "id": "clx1acc001",
      "referenceNumber": "ING-2026-0042",
      "type": "INGRESO",
      "status": "BORRADOR",
      "description": "Comisión por venta Apto Chapinero",
      "amount": "9345000.00",
      "currency": "COP",
      "entryDate": "2026-09-20T00:00:00.000Z",
      "approvedAt": "2026-09-21T09:00:00.000Z",
      "notes": "Aprobado por dirección comercial",
      "attachmentUrl": "https://cdn.bydomu.com/docs/soporte.pdf",
      "reimbursable": false,
      "categoryId": "clx1cat001",
      "dealId": "clx1deal001",
      "contactId": "clx1con001",
      "createdById": "clx1usr001",
      "approvedById": "clx1usr002",
      "voidedAt": "2026-09-22T00:00:00.000Z",
      "voidReason": "Registro duplicado",
      "createdAt": "2026-09-20T16:30:00.000Z",
      "updatedAt": "2026-09-21T09:00:00.000Z",
      "category": {
        "id": "clx1cat001",
        "name": "Comisiones",
        "color": "#10B981"
      },
      "deal": {
        "id": "clx1deal001",
        "title": "Venta Apto Chapinero"
      },
      "createdBy": {
        "id": "clx1usr001",
        "firstName": "Carlos",
        "lastName": "Rodríguez"
      }
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "pageSize": 20,
  …

The key goes in the BYDOMU_API_KEY variable. The example data belongs to no agency.