Líneas de compensaciones
Qué se compensó: un pedido o la deuda de la cuenta corriente del cliente y un comprobante del proveedor, con las cancelaciones que creó la compensación.
Líneas de compensaciones
Objetos
SettlementOffsetLine
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
settlement_offset_idintegerobligatorioID de la compensación (/v1/settlement-offsets).
sidestringobligatorioreceivable: deuda del cliente con la tienda (un pedido o la deuda de la cuenta corriente); payable: deuda de la tienda con el proveedor (un comprobante).
- Valores:
receivablepayable
positionintegerobligatorioPosición en el orden: la menor va primero.
amountintegerobligatorioImporte compensado.
currencystringobligatorioMoneda de los importes, código ISO 4217: la moneda de la tienda.
- Valores:
ARSUSDBRLCLPCOPMXNPENRUB
order_idinteger o nullobligatorioID del pedido cuya deuda se compensó (/v1/orders); null en las demás líneas.
customer_account_entry_idinteger o nullobligatorioID del movimiento de tipo offset de la cuenta corriente con el que la compensación redujo la deuda del cliente (/v1/customer-account-entries); null en las demás líneas. Al anularla se registra su reversión.
payment_idinteger o nullobligatorioID del pago del pedido que creó la compensación (/v1/payments); null en las demás líneas y después de anularla.
supplier_bill_idinteger o nullobligatorioID del comprobante de proveedor (/v1/supplier-bills); null en las líneas del cliente. Si la deuda por entrega se reemplazó por una factura, la factura.
supplier_bill_payment_idinteger o nullobligatorioID del pago del comprobante que creó la compensación (/v1/supplier-bill-payments); null en las líneas del cliente y después de anularla.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
Endpoints
Líneas de compensaciones: deudas del cliente y comprobantes de proveedores compensados
get/settlement-offset-lines
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})$
settlement_offset_idintegerSolo líneas de esta compensación.
- Mínimo:
- 1
order_idintegerSolo líneas que cancelaron la deuda de este pedido.
- 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-offset-lines" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"settlement_offset_id": 0,
"side": "receivable",
"position": 0,
"amount": 0,
"currency": "ARS",
"order_id": 0,
"customer_account_entry_id": 0,
"payment_id": 0,
"supplier_bill_id": 0,
"supplier_bill_payment_id": 0,
"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"
}Línea de compensación
get/settlement-offset-lines/{settlement_offset_line}
Scope: procurement:read
Parámetros
Ruta
settlement_offset_lineintegerobligatorioID de la línea de compensación.
Respuestas
200Éxito
application/json
Devuelve SettlementOffsetLine
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-offset-lines/{settlement_offset_line}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"settlement_offset_id": 0,
"side": "receivable",
"position": 0,
"amount": 0,
"currency": "ARS",
"order_id": 0,
"customer_account_entry_id": 0,
"payment_id": 0,
"supplier_bill_id": 0,
"supplier_bill_payment_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}