Proveedores
Directorio de proveedores: datos fiscales, moneda de compra, plazo de pago y modo de liquidación, con saldo y conciliación. Sin persona de contacto ni notas.
Proveedores
Objetos
Supplier
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
versionintegerobligatorioVersión del registro: crece con cada cambio. Para cambiar el registro, envíela como ETag en If-Match.
external_idstring o nullobligatorioID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
namestringobligatorioNombre del proveedor como lo ve la tienda.
legal_namestring o nullobligatorioRazón social; null si no está cargada.
tax_idstring o nullobligatorioNúmero fiscal como lo cargó la tienda (CUIT en Argentina); null si no está cargado.
tax_id_countrystring o nullobligatorioPaís del número fiscal, ISO 3166-1 alfa-2; null si el número no está cargado.
is_activebooleanobligatoriofalse: el proveedor está desactivado; no se le hacen pedidos nuevos y los documentos quedan.
currencystringobligatorioMoneda de compra con el proveedor, ISO 4217: en ella están min_order_amount y los precios de sus pedidos.
payment_term_daysinteger o nullobligatorioPlazo de pago en días: con él se calcula el vencimiento due_on del comprobante. null: sin plazo.
prices_include_taxboolean o nullobligatoriotrue: el proveedor cotiza con impuestos; false: sin impuestos; null: según la regla de la tienda.
settlement_modestringobligatorioon_receipt: compra común, la deuda nace con la recepción; on_sale: consignación, la tienda paga lo vendido según la liquidación de consignación.
- Valores:
on_receipton_sale
consignment_loss_policystringobligatorioQuién paga la mercadería en consignación vencida o faltante: return_to_supplier: a cargo del proveedor, con devolución de la mercadería; our_cost: pérdida de la tienda.
- Valores:
return_to_supplierour_cost
lead_time_daysinteger o nullobligatorioPlazo de entrega en días desde el pedido; null si no está cargado.
min_order_amountinteger o nullobligatorioMonto mínimo de pedido en unidades mínimas de currency; null: sin mínimo.
customer_idinteger o nullID de la misma contraparte como cliente (/v1/customers): con él la tienda compensa deudas cruzadas. null si no hay vínculo. Solo con acceso a clientes.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
SupplierBalance
supplier_idintegerobligatorioID del proveedor (/v1/suppliers).
legal_entity_idinteger o nullobligatorioRazón social de la tienda a la que se limita el saldo; null: todas.
as_ofstringobligatorioDía de la tienda para el que se abre el vencido, AAAA-MM-DD.
currencystringobligatorioMoneda de los importes, código ISO 4217: la moneda de la tienda.
- Valores:
ARSUSDBRLCLPCOPMXNPENRUB
total_dueintegerobligatorioTotal de la deuda: bills_outstanding + settled_pending_bill + accrued_unsettled + received_unbilled − returns_expected − advances_unapplied − payments_unapplied.
has_open_itemsbooleanobligatorioSi hay partidas abiertas: el total puede ser cero cuando se compensan entre sí.
bills_outstandingintegerobligatorioComprobantes registrados sin cancelar: lo que se puede pagar ahora; las notas de crédito lo reducen.
overdueintegerobligatorioParte de bills_outstanding vencida; por antigüedad del vencimiento se abre en overdue_1_30, overdue_31_60, overdue_61_90 y overdue_90_plus, que suman overdue.
overdue_1_30integerobligatorioTramo de antigüedad del vencimiento de overdue; sus límites en días del calendario de la tienda están en el nombre del campo.
overdue_31_60integerobligatorioTramo de antigüedad del vencimiento de overdue; sus límites en días del calendario de la tienda están en el nombre del campo.
overdue_61_90integerobligatorioTramo de antigüedad del vencimiento de overdue; sus límites en días del calendario de la tienda están en el nombre del campo.
overdue_90_plusintegerobligatorioÚltimo tramo de antigüedad del vencimiento de overdue: todo lo anterior a overdue_61_90.
not_dueintegerobligatorioParte de bills_outstanding que todavía no vence (hoy o después).
due_soonintegerobligatorioParte de not_due que vence en la próxima semana.
no_due_dateintegerobligatorioParte de bills_outstanding sin vencimiento.
settled_pending_billintegerobligatorioReconocido por una liquidación de consignación, todavía sin comprobante registrado.
accrued_unsettledintegerobligatorioVendido en consignación y todavía sin liquidar.
received_unbilledintegerobligatorioRecibido en entregas que no cubre ningún comprobante registrado: deuda sin documento.
returns_expectedintegerobligatorioReclamo por devoluciones despachadas todavía sin compensar; reduce la deuda.
advances_unappliedintegerobligatorioAnticipos de órdenes de compra todavía sin aplicar a comprobantes; reducen la deuda.
payments_unappliedintegerobligatorioPagos del libro de dinero todavía sin aplicar a comprobantes, menos el dinero que devolvió el proveedor; reducen la deuda.
SupplierStatement
supplier_idintegerobligatorioID del proveedor (/v1/suppliers).
legal_entity_idinteger o nullobligatorioRazón social de la tienda para la que se arma la conciliación; null: todas.
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 solicitud, el día de la primera línea de la conciliación.
tostringobligatorioÚltimo día del período, AAAA-MM-DD en la zona horaria de la tienda.
opening_balanceintegerobligatorioDeuda al inicio del período: la suma de las líneas anteriores a from.
closing_balanceintegerobligatorioDeuda al final del período: opening_balance más las líneas del período. Para hoy coincide con total_due del saldo.
increase_totalintegerobligatorioSuma de los aumentos de la deuda en el período.
decrease_totalintegerobligatorioSuma de las reducciones de la deuda en el período, en positivo.
linesarray de objectobligatorioLíneas del período por fecha: en un mismo día, primero lo que crea deuda y después lo que la cancela.
Campos · 9
datestringobligatorioFecha de la línea, AAAA-MM-DD en la zona horaria de la tienda.
kindstringobligatoriobill: factura o nota de débito registrada; credit_note: nota de crédito; payment: pago con dinero desde el comprobante; offset: compensación; out_of_band_payment: pago fuera del sistema; journal_payment: pago del libro de dinero; supplier_refund: dinero que devolvió el proveedor; advance: anticipo de una orden de compra; fx_difference: diferencia de cambio; unbilled_receipt: entrega sin comprobante registrado; settlement: liquidación de consignación sin comprobante registrado; accrual: vendido y todavía sin liquidar; return_claim: devolución despachada sin compensar.
- Valores:
billcredit_notepaymentoffsetout_of_band_paymentjournal_paymentsupplier_refundadvancefx_differenceunbilled_receiptsettlementaccrualreturn_claim
amountintegerobligatorioImporte de la línea con signo: más, la deuda creció; menos, bajó.
balanceintegerobligatorioDeuda después de la línea.
documentobject o nullobligatorioDocumento de la línea; null en lo devengado por consignación.
Campos · 3
typestringobligatorioTipo de documento: supplier_bill, money_transaction, purchase_order, goods_receipt, consignment_settlement o supplier_return.
- Valores:
supplier_billmoney_transactionpurchase_ordergoods_receiptconsignment_settlementsupplier_return
idintegerobligatorioID del documento.
numberstring o nullobligatorioNúmero del documento; null si no tiene.
supplier_bill_payment_idinteger o nullobligatorioID del pago del comprobante (/v1/supplier-bill-payments) en una línea payment; null en las demás.
money_transaction_idinteger o nullobligatorioID del movimiento del libro de dinero (/v1/money-transactions) que pagó el anticipo, en una línea advance; null en las demás.
settlement_offset_idinteger o nullobligatorioID de la compensación (/v1/settlement-offsets) en una línea offset; null en las demás.
document_amountobject o nullobligatorioImporte en la moneda del documento cuando no es la moneda de la tienda; null: moneda de la tienda.
Campos · 2
currencystringobligatorioMoneda del documento, ISO 4217.
amountintegerobligatorioImporte en unidades menores de la moneda del documento.
Endpoints
Proveedores de la tienda: datos fiscales y condiciones de pago
get/suppliers
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})$
include_deletedbooleantrue — devolver también los registros eliminados: los archivados con deleted_at y los borrados de la base como marcas de eliminación {id, deleted_at} en la continuación por el cursor de sincronización. Activalo para sincronizar.
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/suppliers" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"version": 0,
"external_id": "string",
"name": "string",
"legal_name": "string",
"tax_id": "string",
"tax_id_country": "string",
"is_active": true,
"currency": "string",
"payment_term_days": 0,
"prices_include_tax": true,
"settlement_mode": "on_receipt",
"consignment_loss_policy": "return_to_supplier",
"lead_time_days": 0,
"min_order_amount": 0,
"customer_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"
}Crear un proveedor: datos fiscales y condiciones de pago
post/suppliers
Scope: procurement:write
Parámetros
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
namestringobligatorioNombre del proveedor como lo ve la tienda.
- Largo máximo:
- 200
tax_idstring o nullNúmero fiscal como lo cargó la tienda (CUIT en Argentina); null si no está cargado.
- Largo máximo:
- 32
tax_id_countrystring o nullPaís del número fiscal, ISO 3166-1 alfa-2; null si el número no está cargado.
- Valores:
ARBRCLCOMXPERUnull
legal_namestring o nullRazón social; null si no está cargada.
- Largo máximo:
- 200
settlement_modestringon_receipt: compra común, la deuda nace con la recepción; on_sale: consignación, la tienda paga lo vendido según la liquidación de consignación.
- Valores:
on_receipton_sale
consignment_loss_policystringQuién paga la mercadería en consignación vencida o faltante: return_to_supplier: a cargo del proveedor, con devolución de la mercadería; our_cost: pérdida de la tienda.
- Valores:
return_to_supplierour_cost
prices_include_taxboolean o nulltrue: el proveedor cotiza con impuestos; false: sin impuestos; null: según la regla de la tienda.
payment_term_daysinteger o nullPlazo de pago en días: con él se calcula el vencimiento due_on del comprobante. null: sin plazo.
- Mínimo:
- 0
- Máximo:
- 365
min_order_amountinteger o nullMonto mínimo de pedido en unidades mínimas de currency; null: sin mínimo.
- Máximo:
- 100000000000000
lead_time_daysinteger o nullPlazo de entrega en días desde el pedido; null si no está cargado.
- Mínimo:
- 1
- Máximo:
- 365
is_activebooleanfalse: el proveedor está desactivado; no se le hacen pedidos nuevos y los documentos quedan.
currencystringMoneda de compra con el proveedor, ISO 4217: en ella están min_order_amount y los precios de sus pedidos.
- Valores:
ARSUSDBRLCLPCOPMXNPENRUB
external_idstring o nullID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
Respuestas
201Creado
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
Locationstring (uri)obligatorioDirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.
application/json
Devuelve Supplier
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
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
external_id_in_useEl ID externo está en uso - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
record_limit_reachedSe alcanzó el tope de registros - 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/suppliers" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"name": "string",
"tax_id": "string",
"tax_id_country": "AR",
"legal_name": "string",
"settlement_mode": "on_receipt",
"consignment_loss_policy": "return_to_supplier",
"prices_include_tax": true,
"payment_term_days": 0,
"min_order_amount": 0,
"lead_time_days": 1,
"is_active": true,
"currency": "ARS",
"external_id": "string"
}{
"id": 0,
"version": 0,
"external_id": "string",
"name": "string",
"legal_name": "string",
"tax_id": "string",
"tax_id_country": "string",
"is_active": true,
"currency": "string",
"payment_term_days": 0,
"prices_include_tax": true,
"settlement_mode": "on_receipt",
"consignment_loss_policy": "return_to_supplier",
"lead_time_days": 0,
"min_order_amount": 0,
"customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Proveedor
get/suppliers/{supplier}
Scope: procurement:read
Parámetros
Ruta
supplierintegerobligatorioID del proveedor.
Respuestas
200Éxito
Encabezados
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve Supplier
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/suppliers/{supplier}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"version": 0,
"external_id": "string",
"name": "string",
"legal_name": "string",
"tax_id": "string",
"tax_id_country": "string",
"is_active": true,
"currency": "string",
"payment_term_days": 0,
"prices_include_tax": true,
"settlement_mode": "on_receipt",
"consignment_loss_policy": "return_to_supplier",
"lead_time_days": 0,
"min_order_amount": 0,
"customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Actualizar los datos fiscales, las condiciones de pago y el ID externo de un proveedor
patch/suppliers/{supplier}
Scope: procurement:write
Parámetros
Ruta
supplierintegerobligatorioID del proveedor.
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
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Cuerpo de la solicitud application/json
namestringNombre del proveedor como lo ve la tienda.
- Largo máximo:
- 200
legal_namestring o nullRazón social; null si no está cargada.
- Largo máximo:
- 200
tax_idstring o nullNúmero fiscal como lo cargó la tienda (CUIT en Argentina); null si no está cargado.
- Largo máximo:
- 32
tax_id_countrystring o nullPaís del número fiscal, ISO 3166-1 alfa-2; null si el número no está cargado.
is_activebooleanfalse: el proveedor está desactivado; no se le hacen pedidos nuevos y los documentos quedan.
payment_term_daysinteger o nullPlazo de pago en días: con él se calcula el vencimiento due_on del comprobante. null: sin plazo.
- Mínimo:
- 0
- Máximo:
- 365
prices_include_taxboolean o nulltrue: el proveedor cotiza con impuestos; false: sin impuestos; null: según la regla de la tienda.
settlement_modestringon_receipt: compra común, la deuda nace con la recepción; on_sale: consignación, la tienda paga lo vendido según la liquidación de consignación.
- Valores:
on_receipton_sale
consignment_loss_policystringQuién paga la mercadería en consignación vencida o faltante: return_to_supplier: a cargo del proveedor, con devolución de la mercadería; our_cost: pérdida de la tienda.
- Valores:
return_to_supplierour_cost
lead_time_daysinteger o nullPlazo de entrega en días desde el pedido; null si no está cargado.
- Mínimo:
- 1
- Máximo:
- 365
min_order_amountinteger o nullMonto mínimo de pedido en unidades mínimas de currency; null: sin mínimo.
currencystringMoneda de compra con el proveedor, ISO 4217: en ella están min_order_amount y los precios de sus pedidos.
external_idstring o nullID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve Supplier
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
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
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
external_id_in_useEl ID externo está en uso - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
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 PATCH "https://api.saleya.app/v1/suppliers/{supplier}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"name": "string",
"legal_name": "string",
"tax_id": "string",
"tax_id_country": "string",
"is_active": true,
"payment_term_days": 0,
"prices_include_tax": true,
"settlement_mode": "on_receipt",
"consignment_loss_policy": "return_to_supplier",
"lead_time_days": 1,
"min_order_amount": 0,
"currency": "string",
"external_id": "string"
}{
"id": 0,
"version": 0,
"external_id": "string",
"name": "string",
"legal_name": "string",
"tax_id": "string",
"tax_id_country": "string",
"is_active": true,
"currency": "string",
"payment_term_days": 0,
"prices_include_tax": true,
"settlement_mode": "on_receipt",
"consignment_loss_policy": "return_to_supplier",
"lead_time_days": 0,
"min_order_amount": 0,
"customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Proveedor por su ID externo
get/suppliers/by-external-id/{external_id}
Scope: procurement:read
Parámetros
Ruta
external_idstringobligatorioID externo: el ID del registro en tu sistema.
Respuestas
200Éxito
Encabezados
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve Supplier
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/suppliers/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"version": 0,
"external_id": "string",
"name": "string",
"legal_name": "string",
"tax_id": "string",
"tax_id_country": "string",
"is_active": true,
"currency": "string",
"payment_term_days": 0,
"prices_include_tax": true,
"settlement_mode": "on_receipt",
"consignment_loss_policy": "return_to_supplier",
"lead_time_days": 0,
"min_order_amount": 0,
"customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Crear o actualizar un proveedor por su ID externo
patch/suppliers/by-external-id/{external_id}
Scope: procurement:write
Parámetros
Ruta
external_idstringobligatorioID externo: el ID del registro en tu sistema.
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
If-MatchstringETag del registro de la última lectura. Es obligatorio si ya existe un registro con este ID externo (si no, 428) y no tiene que estar si no existe.
- Ejemplo:
"7"
If-None-Matchstring* — solo crear: si ya existe un registro con este ID externo, la solicitud recibe 412.
- Valores:
*
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve Supplier
201Creado
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
Locationstring (uri)obligatorioDirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.
application/json
Devuelve Supplier
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
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
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
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 - 409
record_limit_reachedSe alcanzó el tope de registros - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
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 PATCH "https://api.saleya.app/v1/suppliers/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"version": 0,
"external_id": "string",
"name": "string",
"legal_name": "string",
"tax_id": "string",
"tax_id_country": "string",
"is_active": true,
"currency": "string",
"payment_term_days": 0,
"prices_include_tax": true,
"settlement_mode": "on_receipt",
"consignment_loss_policy": "return_to_supplier",
"lead_time_days": 0,
"min_order_amount": 0,
"customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Saldo del proveedor: cuánto le debe la tienda ahora, por componente y vencimiento
get/suppliers/{supplier}/balance
Scope: procurement:read
Parámetros
Ruta
supplierintegerobligatorioID del proveedor.
Query
legal_entity_idintegerSolo la deuda con esta razón social de la tienda.
Respuestas
200Éxito
application/json
Devuelve SupplierBalance
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/suppliers/{supplier}/balance" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"supplier_id": 0,
"legal_entity_id": 0,
"as_of": "string",
"currency": "ARS",
"total_due": 0,
"has_open_items": true,
"bills_outstanding": 0,
"overdue": 0,
"overdue_1_30": 0,
"overdue_31_60": 0,
"overdue_61_90": 0,
"overdue_90_plus": 0,
"not_due": 0,
"due_soon": 0,
"no_due_date": 0,
"settled_pending_bill": 0,
"accrued_unsettled": 0,
"received_unbilled": 0,
"returns_expected": 0,
"advances_unapplied": 0,
"payments_unapplied": 0
}Conciliación de saldos con el proveedor en un período: saldo inicial y final, líneas con saldo acumulado
get/suppliers/{supplier}/statement
Scope: procurement:read
Parámetros
Ruta
supplierintegerobligatorioID del proveedor.
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 línea de la conciliación.
tostring (date)Último día del período, AAAA-MM-DD en la zona horaria de la tienda; por defecto, hoy.
legal_entity_idintegerConciliación de esta razón social de la tienda: solo su parte de líneas y saldos.
Respuestas
200Éxito
application/json
Devuelve SupplierStatement
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/suppliers/{supplier}/statement" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"supplier_id": 0,
"legal_entity_id": 0,
"currency": "ARS",
"from": "string",
"to": "string",
"opening_balance": 0,
"closing_balance": 0,
"increase_total": 0,
"decrease_total": 0,
"lines": [
{
"date": "string",
"kind": "bill",
"amount": 0,
"balance": 0,
"document": {
"type": "supplier_bill",
"id": 0,
"number": "string"
},
"supplier_bill_payment_id": 0,
"money_transaction_id": 0,
"settlement_offset_id": 0,
"document_amount": {
"currency": "string",
"amount": 0
}
}
]
}