Liquidaciones de consignación
Rendición al proveedor de la mercadería en consignación vendida en un período, base de su factura: secciones, líneas y totales.
Liquidaciones de consignación
Objetos
ConsignmentSettlement
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
numberstringobligatorioNúmero de la liquidación.
statusstringobligatoriodraft — el período está armado para revisar, las ventas todavía no quedan fijadas y el período puede cambiar; posted — acordada con el proveedor: las ventas del período quedan fijadas en ella y se le puede emitir un comprobante; void — anulada: sus ventas se liberan y entran en la próxima liquidación.
- Valores:
draftpostedvoid
supplier_idintegerobligatorioID del proveedor (/v1/suppliers).
legal_entity_idinteger o nullobligatorioRazón social de la tienda a la que factura el proveedor (/v1/legal-entities); null en liquidaciones antiguas: la razón social predeterminada.
supplier_bill_idinteger o nullobligatorioComprobante emitido por la liquidación (/v1/supplier-bills); null — todavía sin comprobante o el comprobante se anuló y la liquidación se puede volver a facturar. El comprobante anulado conserva el vínculo en su consignment_settlement_id.
currencystringobligatorioMoneda de la liquidación, ISO 4217 — la de los precios de compra: en ella están los precios e importes de las líneas y el total.
period_fromstringobligatorioPrimer día del período, YYYY-MM-DD.
period_tostringobligatorioÚltimo día del período, YYYY-MM-DD.
subtotalintegerobligatorioTotal de la liquidación en su moneda — la suma de las líneas, lo que factura el proveedor.
base_subtotalintegerobligatorioEl mismo total en la moneda de la tienda.
sectionsarray de objectobligatorioSubtotales por sección en el orden del documento; las secciones vacías no aparecen.
Campos · 2
kindstringobligatoriosale — vendido; loss — mercadería vencida o faltante que la tienda paga según la política del proveedor; price_adjustment — diferencia por un precio corregido en la recepción después de devengar la mercadería.
- Valores:
salelossprice_adjustment
subtotalintegerobligatorioSubtotal de la sección en la moneda de la liquidación.
linesarray de objectobligatorioLíneas de la liquidación en el orden del documento: variante × recepción × precio.
Campos · 14
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
positionintegerobligatorioNúmero de línea en el documento.
kindstringobligatorioSección de la línea, con los códigos de sections[].kind.
- Valores:
salelossprice_adjustment
variant_idinteger o nullobligatorioID de la variante del producto (/v1/variants).
lot_idinteger o nullobligatorioLote de la línea (/v1/lots); null en un producto sin lotes.
goods_receipt_idinteger o nullobligatorioRecepción con la que llegó la mercadería (/v1/goods-receipts).
namestringobligatorioNombre del artículo como figura en el documento: se toma al armar la liquidación y no cambia si después se renombra el producto.
skustring o nullobligatorioSKU de la variante tomado junto con el nombre; null si no tiene.
unitstring o nullobligatorioUnidad base de la cantidad de la línea: pcs — unidades, g — gramos, ml — mililitros.
quantitystring o nullobligatorioCantidad vendida, dada de baja o reajustada, como cadena decimal en la unidad base; una venta anulada dentro del período se descuenta.
unit_costinteger o nullobligatorioPrecio de compra en la moneda de la liquidación por cost_per_quantity; en una línea price_adjustment — el precio nuevo. null — la recepción no tiene precio y la línea se devenga en cero.
cost_per_quantitystring o nullobligatorioCantidad en la unidad base a la que corresponde el precio: "1000" en un producto pesable significa por kilogramo.
amountintegerobligatorioImporte de la línea en la moneda de la liquidación; en una línea price_adjustment — la diferencia con lo ya devengado. Las líneas suman subtotal.
base_amountintegerobligatorioImporte de la línea en la moneda de la tienda.
notestring o nullobligatorioNota del personal; null si no hay.
posted_atstring (date-time) o nullobligatorioCuándo se registró la liquidación; null en un borrador.
voided_atstring (date-time) o nullobligatorioCuándo se anuló la liquidación; null si está vigente.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
Endpoints
Liquidaciones de consignación: mercadería en consignación vendida, dada de baja a cargo de la tienda y reajustada en un período
get/consignment-settlements
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
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/consignment-settlements" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"number": "string",
"status": "draft",
"supplier_id": 0,
"legal_entity_id": 0,
"supplier_bill_id": 0,
"currency": "string",
"period_from": "string",
"period_to": "string",
"subtotal": 0,
"base_subtotal": 0,
"sections": [
{
"kind": "sale",
"subtotal": 0
}
],
"lines": [
{
"id": 0,
"position": 0,
"kind": "sale",
"variant_id": 0,
"lot_id": 0,
"goods_receipt_id": 0,
"name": "string",
"sku": "string",
"unit": "string",
"quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"amount": 0,
"base_amount": 0
}
],
"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"
}Liquidación de consignación
get/consignment-settlements/{consignment_settlement}
Scope: procurement:read
Parámetros
Ruta
consignment_settlementintegerobligatorioID de la liquidación de consignación.
Respuestas
200Éxito
application/json
Devuelve ConsignmentSettlement
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/consignment-settlements/{consignment_settlement}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"status": "draft",
"supplier_id": 0,
"legal_entity_id": 0,
"supplier_bill_id": 0,
"currency": "string",
"period_from": "string",
"period_to": "string",
"subtotal": 0,
"base_subtotal": 0,
"sections": [
{
"kind": "sale",
"subtotal": 0
}
],
"lines": [
{
"id": 0,
"position": 0,
"kind": "sale",
"variant_id": 0,
"lot_id": 0,
"goods_receipt_id": 0,
"name": "string",
"sku": "string",
"unit": "string",
"quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"amount": 0,
"base_amount": 0
}
],
"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"
}