Compensaciones
Documento de compensación: lo que un cliente le debe a la tienda contra lo que la tienda le debe a un proveedor. Si se anula, queda con estado voided.
Compensaciones
Objetos
SettlementOffset
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
numberstringobligatorioNúmero del documento de compensación.
statusstringobligatorioposted: registrada; voided: anulada, se quitaron las cancelaciones que creó la compensación y las deudas vuelven a estar abiertas.
- Valores:
postedvoided
kindstringobligatoriobilateral: compensación bilateral; tripartite: tripartita, según el acuerdo agreement_id.
- Valores:
bilateraltripartite
legal_entity_idintegerobligatorioRazón social de la tienda que registró la compensación (/v1/legal-entities).
supplier_idintegerobligatorioID del proveedor (/v1/suppliers).
agreement_idinteger o nullobligatorioID del acuerdo de compensación (/v1/settlement-agreements); null en una compensación bilateral sin acuerdo.
customer_idinteger o nullID del cliente (/v1/customers); null si el cliente fue borrado. Solo con acceso a clientes.
customer_namestringNombre del cliente al registrar la compensación. Solo con acceso a clientes.
occurred_onstring (date)obligatorioFecha de la compensación, AAAA-MM-DD en la zona horaria de la tienda.
totalintegerobligatorioImporte de la compensación: se compensa lo mismo contra las deudas del cliente y contra los comprobantes del proveedor.
currencystringobligatorioMoneda de los importes, código ISO 4217: la moneda de la tienda.
- Valores:
ARSUSDBRLCLPCOPMXNPENRUB
notestring o nullobligatorioNota del personal; null si no hay.
posted_atstring (date-time)obligatorioCuándo se registró la compensación.
voided_atstring (date-time) o nullobligatorioCuándo se anuló la compensación; null si está registrada.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
Endpoints
Compensaciones: deudas recíprocas de un cliente y un proveedor canceladas con un documento de compensación
get/settlement-offsets
Scope: procurement: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})$
supplier_idintegerSolo documentos de este proveedor.
- Mínimo:
- 1
agreement_idintegerSolo compensaciones de este acuerdo.
- Mínimo:
- 1
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/settlement-offsets" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"number": "string",
"status": "posted",
"kind": "bilateral",
"legal_entity_id": 0,
"supplier_id": 0,
"agreement_id": 0,
"customer_id": 0,
"customer_name": "string",
"occurred_on": "2026-01-15",
"total": 0,
"currency": "ARS",
"note": "string",
"posted_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"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"
}Compensación
get/settlement-offsets/{settlement_offset}
Scope: procurement:read
Parámetros
Ruta
settlement_offsetintegerobligatorioID de la compensación.
Respuestas
200Éxito
application/json
Devuelve SettlementOffset
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/settlement-offsets/{settlement_offset}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"status": "posted",
"kind": "bilateral",
"legal_entity_id": 0,
"supplier_id": 0,
"agreement_id": 0,
"customer_id": 0,
"customer_name": "string",
"occurred_on": "2026-01-15",
"total": 0,
"currency": "ARS",
"note": "string",
"posted_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}