Saltar al contenido principal
GET
Saldo por tercero

Autorizaciones

X-API-Key
string
header
requerido

API Key de la integración (Integraciones → Nueva Integración).

Parámetros de consulta

end_date
string<date>
requerido

Fecha de corte (YYYY-MM-DD).

start_date
string<date>

Opcional: lo anterior a esta fecha se acumula como saldo inicial (opening).

third_party_type
enum<string>

Opcional: customer, provider o employee. Solo el tipo lista todos los terceros de ese tipo.

Opciones disponibles:
customer,
provider,
employee
third_party_id
string<uuid>

Opcional, requiere third_party_type: un solo tercero (de otro negocio → 404; sin tipo → 422).

account_codes[]
string[]

Opcional (repetible; también acepta códigos separados por comas): solo esas cuentas.

category_ids[]
string<uuid>[]

Opcional (repetible; también acepta ids separados por comas): solo cuentas de esas categorías de cuentas y, por defecto, sus subcategorías. Sin cuentas en ellas, el reporte sale vacío.

include_children
boolean
predeterminado:true

Con category_ids, incluye las cuentas de sus subcategorías (por defecto true).

branch_id
string

Opcional: limita a una sucursal.

format
enum<string>
predeterminado:json

json (por defecto), pdf (application/pdf) o excel (.xlsx). Con pdf/excel la respuesta es el archivo.

Opciones disponibles:
json,
pdf,
excel

Respuesta

Éxito

status
boolean
requerido
Ejemplo:

true

data
object
requerido