Cuentas corrientes de clientes
La cuenta corriente de cada cliente: saldo, límite de crédito, plazo de pago y resumen de un período con los vencimientos.
Cuentas corrientes de clientes
Objetos
CustomerAccount
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
statusstringobligatorioEstado: suspended — las nuevas ventas a cuenta están cerradas; la deuda sigue y se puede cobrar. Con el otro valor el cliente compra a cuenta dentro del límite.
- Valores:
activesuspended
currencystringobligatorioMoneda de los importes, código ISO 4217: la moneda de la tienda.
- Valores:
ARSUSDBRLCLPCOPMXNPENRUB
balanceintegerobligatorioSaldo en unidades mínimas de la moneda: positivo si el cliente debe, negativo si pagó de más. Es la suma de amount de todos los movimientos de la cuenta (/v1/customer-account-entries).
credit_limitinteger o nullobligatorioLímite de crédito en unidades mínimas de la moneda; null: sin límite. Por encima del límite o con deuda vencida, la venta a cuenta pide la aprobación de un encargado.
payment_terms_daysintegerobligatorioPlazo de pago de una venta a cuenta, en días: el vencimiento del cargo (due_on) es el día de la venta más este plazo.
customer_idintegerID del cliente (/v1/customers). Solo con acceso a los clientes.
notestring o nullNota del personal sobre el cliente; null si no hay. Solo con acceso a los clientes: se borra al eliminar al cliente.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
CustomerAccountStatement
customer_account_idintegerobligatorioID de la cuenta corriente (/v1/customer-accounts).
currencystringobligatorioMoneda de los importes, código ISO 4217: la moneda de la tienda.
- Valores:
ARSUSDBRLCLPCOPMXNPENRUB
fromstringobligatorioPrimer día del período, AAAA-MM-DD en la zona horaria de la tienda; sin from en la consulta, el día de la primera operación de la cuenta.
tostringobligatorioÚltimo día del período, AAAA-MM-DD en la zona horaria de la tienda.
opening_balanceintegerobligatorioDeuda al inicio del período: suma de las operaciones anteriores a from.
closing_balanceintegerobligatorioDeuda al cierre del período: opening_balance más las líneas del período.
chargedintegerobligatorioTotal de aumentos de la deuda en el período.
reducedintegerobligatorioTotal de bajas de la deuda en el período, como número positivo.
linesarray de objectobligatorioMovimientos del período en orden de operación (occurred_at) con saldo acumulado.
Campos · 8
entry_idintegerobligatorioID del movimiento (/v1/customer-account-entries).
kindstringobligatorioTipo de movimiento, los mismos valores que kind de un movimiento de la cuenta.
- Valores:
chargeopening_balanceopening_creditpaymentreturnwrite_offoffsetwithholdingreversal
occurred_atstring (date-time)obligatorioMomento de la operación.
order_idinteger o nullobligatorioID del pedido (/v1/orders); null si no hay pedido.
due_onstring (date) o nullobligatorioVencimiento del cargo; null en los movimientos que bajan la deuda.
notestring o nullobligatorioNota del personal; null si no hay.
amountintegerobligatorioImporte con signo: positivo si la deuda creció, negativo si bajó.
balanceintegerobligatorioDeuda después de esta línea.
open_itemsarray de objectobligatorioCargos sin cancelar al cierre del período, por vencimiento. Qué cobro canceló qué cargo lo decide la imputación FIFO dentro de cada razón social.
Campos · 7
entry_idintegerobligatorioID del cargo (/v1/customer-account-entries).
kindstringobligatoriocharge — venta a cuenta; opening_balance — deuda del registro anterior.
- Valores:
chargeopening_balance
occurred_atstring (date-time)obligatorioMomento de la operación.
order_idinteger o nullobligatorioID del pedido (/v1/orders); null si no hay pedido.
due_onstring (date) o nullobligatorioVencimiento del cargo, AAAA-MM-DD en la zona horaria de la tienda.
open_amountintegerobligatorioParte impaga del cargo al cierre del período.
overduebooleanobligatorioEl vencimiento pasó antes de to: al cierre del período la deuda está vencida.
Endpoints
Cuentas corrientes de clientes: saldo, límite de crédito y plazo de pago
get/customer-accounts
Scope: finance:read
Parámetros
Query
limitintegerTamaño de página: hasta 250 registros; 50 por defecto.
- Mínimo:
- 1
- Máximo:
- 250
cursorstringCursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.
- Largo máximo:
- 4096
updated_sincestring (date-time)Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.
- Patrón:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
Respuestas
200Éxito
application/json
Registros de la página.
deletedarray de objectobligatorioRegistros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.
Campos · 2
idintegerobligatorioID del registro borrado.
deleted_atstring (date-time)obligatorioCuándo se borró el registro.
next_cursorstring o nullobligatorioCursor de la página siguiente; null en la última.
has_morebooleanobligatoriotrue si hay una página siguiente.
sync_cursorstring o nullobligatorioEn la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/customer-accounts" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"status": "active",
"currency": "ARS",
"balance": 0,
"credit_limit": 0,
"payment_terms_days": 0,
"customer_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Cuenta corriente de un cliente
get/customer-accounts/{customer_account}
Scope: finance:read
Parámetros
Ruta
customer_accountintegerobligatorioID de la cuenta corriente del cliente.
Respuestas
200Éxito
application/json
Devuelve CustomerAccount
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/customer-accounts/{customer_account}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"status": "active",
"currency": "ARS",
"balance": 0,
"credit_limit": 0,
"payment_terms_days": 0,
"customer_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Resumen de la cuenta corriente de un cliente en un período: saldo inicial y final, movimientos con saldo acumulado y deudas abiertas con vencimiento
get/customer-accounts/{customer_account}/statement
Scope: finance:read
Parámetros
Ruta
customer_accountintegerobligatorioID de la cuenta corriente del cliente.
Query
fromstring (date)Primer día del período, AAAA-MM-DD en la zona horaria de la tienda; por defecto, el día de la primera operación de la cuenta.
tostring (date)Último día del período, AAAA-MM-DD en la zona horaria de la tienda; por defecto, hoy.
Respuestas
200Éxito
application/json
Devuelve CustomerAccountStatement
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/customer-accounts/{customer_account}/statement" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"customer_account_id": 0,
"currency": "ARS",
"from": "string",
"to": "string",
"opening_balance": 0,
"closing_balance": 0,
"charged": 0,
"reduced": 0,
"lines": [
{
"entry_id": 0,
"kind": "charge",
"occurred_at": "2026-01-15T12:00:00Z",
"order_id": 0,
"due_on": "2026-01-15",
"note": "string",
"amount": 0,
"balance": 0
}
],
"open_items": [
{
"entry_id": 0,
"kind": "charge",
"occurred_at": "2026-01-15T12:00:00Z",
"order_id": 0,
"due_on": "2026-01-15",
"open_amount": 0,
"overdue": true
}
]
}Registrar un cobro de cuenta corriente con dinero ya recibido: entrada en la cuenta corriente con certificados de retención
post/customer-accounts/{customer_account}/payments
Scope: finance:write
Parámetros
Ruta
customer_accountintegerobligatorioID de la cuenta corriente del cliente.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Cuerpo de la solicitud application/json
amountintegerobligatorioCuánto dinero entró a cuenta de la deuda, en unidades mínimas de la moneda de la tienda.
- Mínimo:
- 1
- Máximo:
- 10000000000
payment_methodstringobligatorioMedio con el que entró el dinero: tiene que cancelar deuda y confirmarse a mano, por ejemplo efectivo o el medio manual.
- Valores:
cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_package
manual_payment_method_idinteger o nullID del medio de pago manual (/v1/manual-payment-methods) con payment_method=manual, por ejemplo una transferencia bancaria.
- Mínimo:
- 1
location_idintegerobligatorioID del local de la tienda.
legal_entity_idinteger o nullID de la razón social de la tienda (/v1/legal-entities) cuya deuda se cancela: hace falta cuando el cliente le debe a varias.
withholdingsarray de objectCertificados de retención que el cliente agente entregó con el dinero: cancelan la deuda igual que el dinero.
- Mínimo de elementos:
- 1
- Máximo de elementos:
- 2000
Campos · 4
regimestringobligatorioImpuesto retenido: vat, turnover, income y otros códigos de TaxRegime.
jurisdictionstring o nullJurisdicción de un impuesto provincial o municipal, por ejemplo AR-B; null en los impuestos nacionales.
- Largo máximo:
- 8
- Patrón:
^[A-Z]{2}-[A-Z0-9]{1,5}$
amountintegerobligatorioImporte retenido en unidades mínimas de la moneda de la tienda.
- Mínimo:
- 1
certificate_numberstringobligatorioNúmero del certificado de retención.
- Largo máximo:
- 64
withheld_onstring (date)Día de la retención, YYYY-MM-DD: ubica el certificado en un período fiscal y un período cerrado se rechaza.
withholding_agent_tax_idstringCUIT del cliente agente que retuvo el impuesto.
- Largo máximo:
- 20
Respuestas
201Creado
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve CustomerAccountEntry
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/customer-accounts/{customer_account}/payments" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"amount": 1,
"payment_method": "cash",
"manual_payment_method_id": 1,
"location_id": 0,
"legal_entity_id": 0,
"withholdings": [
{
"regime": "string",
"jurisdiction": "string",
"amount": 1,
"certificate_number": "string"
}
],
"withheld_on": "2026-01-15",
"withholding_agent_tax_id": "string"
}{
"id": 0,
"customer_account_id": 0,
"kind": "charge",
"amount": 0,
"currency": "ARS",
"legal_entity_id": 0,
"due_on": "2026-01-15",
"occurred_at": "2026-01-15T12:00:00Z",
"order_id": 0,
"payment_id": 0,
"refund_id": 0,
"reverses_entry_id": 0,
"settlement_offset_id": 0,
"tax_withholding_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z"
}