Desarrolladores

Referencia de la API

Todas las operaciones disponibles para un token de cliente, con su permiso, parámetros y ejemplos.

Grupos

Cómo leer la referencia

  • URL base: https://app.bm.consulting/api/v1. Todas las peticiones llevan Authorization: Bearer … (Autenticación).
  • Cada operación indica el permiso que exige. El token debe tener una concesión que lo cubra (Permisos).
  • Los importes contables son cadenas decimales, no números de coma flotante.
  • Las rutas con {companyId} trabajan sobre una sociedad de tu cuenta; si no es tuya, responden 403 o 404.
  • Los textos descriptivos de la referencia proceden del contrato OpenAPI y pueden estar en inglés.

El contrato completo, en formato OpenAPI 3.0.3, se sirve en https://app.bm.consulting/api/v1/openapi/client. Puedes importarlo en Postman, Insomnia o un generador de clientes.

Todas las operaciones

OperaciónPermisoGrupo
GET /billing
Listar documentos de venta
 sales:invoices.read Facturación
POST /billing
Crear un documento de venta
 sales:invoices.create Facturación
GET /billing/{id}
Consultar un documento de venta
 sales:invoices.read Facturación
GET /suppliers
Listar facturas recibidas
 purchases:documents.read Proveedores
GET /suppliers/items/{id}
Consultar una factura recibida
 purchases:documents.read Proveedores
GET /suppliers/items/{id}/file
Descargar el fichero de una factura recibida
 purchases:documents.read Proveedores
GET /books/{companyId}/journal-lines
Listar apuntes del libro diario
 accounting:journal.read Contabilidad
GET /books/{companyId}/accounts
Listar cuentas contables
 accounting:ledger_accounts.read Contabilidad
GET /books/{companyId}/opening-balances
Consultar el asiento de apertura
 accounting:opening_balances.read Contabilidad
POST /books/{companyId}/opening-balances
Registrar el asiento de apertura
 accounting:opening_balances.create Contabilidad
GET /books/{companyId}/consolidation
Consultar la consolidación del grupo
 accounting:reports.read Contabilidad
GET /books/{companyId}/cost-centers/allocations
Consultar el reparto por centros de coste
 accounting:reports.read Contabilidad
GET /books/{companyId}/reports/profit-loss
Cuenta de pérdidas y ganancias
 accounting:reports.read Contabilidad
GET /books/{companyId}/reports/balance-sheet
Balance de situación
 accounting:reports.read Contabilidad
GET /books/{companyId}/reports/trial-balance
Balance de sumas y saldos
 accounting:reports.read Contabilidad
GET /books/{companyId}/reports/{report}/export
Exportar un informe en CSV, XLSX o PDF
 accounting:reports.export Contabilidad
GET /tesoreria/accounts
Listar cuentas bancarias y saldos
 treasury:bank_accounts.read Tesorería
GET /contacts
Listar contactos
 contacts:contacts.read Contactos
POST /contacts
Crear un contacto
 contacts:contacts.create Contactos
GET /documents/{id}/download
Descargar un documento
 documents:files.read Documentos
GET /connectors/paddle/payouts
Listar liquidaciones de Paddle
 connectors:payouts.read Conectores
POST /connectors/paddle/payouts
Registrar una liquidación de Paddle
 connectors:payouts.create Conectores
POST /connectors/paddle/payouts/{id}/post
Contabilizar una liquidación de Paddle
 connectors:payouts.post Conectores
POST /ingest/batches
Subir un documento de compra
 documents:ingest.create Proveedores
Email
Contacto