Pagos de comprobantes de proveedores
Con qué y por cuánto se canceló un comprobante: dinero, compensación, nota de crédito, anticipo, gasto del libro o fuera del sistema.
Pagos de comprobantes de proveedores
Objetos
SupplierBillPayment
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
supplier_bill_idintegerobligatorioID del comprobante de proveedor (/v1/supplier-bills).
kindstringobligatorioCon qué se canceló la deuda: money: con dinero de una cuenta; offset: compensación con una deuda cruzada; credit_note: con una nota de crédito (la línea está en la factura y en la nota); advance: con el anticipo de una orden de compra; journal: con un gasto ya registrado en el libro de dinero; out_of_band: pagado fuera del sistema, sin cuenta de dinero.
- Valores:
moneyoffsetcredit_noteadvancejournalout_of_band
amountintegerobligatorioImporte cancelado en la moneda del comprobante.
currencystringobligatorioMoneda del comprobante de proveedor, ISO 4217.
withheld_amountintegerobligatorioRetenido al pagar, en la moneda del comprobante; el proveedor recibió amount menos withheld_amount.
money_account_idinteger o nullobligatorioID de la cuenta de dinero (/v1/money-accounts) desde la que se pagó; null en pagos sin dinero de la tienda.
account_amountstring o nullobligatorioTransferido desde la cuenta de dinero, en su moneda, como cadena decimal; null si no hay cuenta de dinero.
base_amountintegerobligatorioEquivalente en la moneda de la tienda a la fecha del pago.
exchange_ratestring o nullobligatorioCotización a la fecha del pago como cadena decimal; null si no hubo conversión.
paid_onstring (date)obligatorioFecha del pago, YYYY-MM-DD en la zona horaria de la tienda.
settlement_offset_idinteger o nullobligatorioID del comprobante de compensación en kind offset; null en los demás.
counterpart_bill_idinteger o nullobligatorioID del comprobante de contrapartida en kind credit_note: en la factura, la nota; en la nota, la factura; null en los demás.
purchase_order_idinteger o nullobligatorioID de la orden de compra cuyo anticipo canceló el comprobante, en kind advance; null en los demás.
money_transaction_idinteger o nullobligatorioID del gasto del libro de dinero (/v1/money-transactions) aplicado al comprobante, en kind journal; null en los demás. El dinero de kind money es un movimiento del libro con source supplier_bill_payment y el ID de este pago.
notestring o nullobligatorioNota del personal; null si no hay.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
Endpoints
Pagos de comprobantes de proveedores: con dinero, compensación, nota de crédito, anticipo, gasto del libro o fuera del sistema
get/supplier-bill-payments
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.
supplier_bill_idintegerSolo pagos de este comprobante de 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/supplier-bill-payments" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"supplier_bill_id": 0,
"kind": "money",
"amount": 0,
"currency": "string",
"withheld_amount": 0,
"money_account_id": 0,
"account_amount": "string",
"base_amount": 0,
"exchange_rate": "string",
"paid_on": "2026-01-15",
"settlement_offset_id": 0,
"counterpart_bill_id": 0,
"purchase_order_id": 0,
"money_transaction_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"
}Pago de comprobante de proveedor
get/supplier-bill-payments/{supplier_bill_payment}
Scope: procurement:read
Parámetros
Ruta
supplier_bill_paymentintegerobligatorioID del pago de comprobante de proveedor.
Respuestas
200Éxito
application/json
Devuelve SupplierBillPayment
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/supplier-bill-payments/{supplier_bill_payment}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"supplier_bill_id": 0,
"kind": "money",
"amount": 0,
"currency": "string",
"withheld_amount": 0,
"money_account_id": 0,
"account_amount": "string",
"base_amount": 0,
"exchange_rate": "string",
"paid_on": "2026-01-15",
"settlement_offset_id": 0,
"counterpart_bill_id": 0,
"purchase_order_id": 0,
"money_transaction_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Marcar un comprobante de proveedor como pagado fuera del sistema
post/supplier-bills/{supplier_bill}/payments/out-of-band
Scope: procurement:pay
Parámetros
Ruta
supplier_billintegerobligatorioID del comprobante de 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
amountintegerobligatorioCuánto de la deuda se cancela, en unidades mínimas de la moneda del comprobante: no más que el saldo pendiente (outstanding). Las retenciones forman parte de este importe: el proveedor recibió amount menos las retenciones.
- Máximo:
- 10000000000
paid_onstring (date)obligatorioDía del pago, YYYY-MM-DD en la zona horaria de la tienda, no futuro: con él las retenciones caen en un período fiscal, y un período cerrado es un rechazo.
notestring o nullNota del pago, por ejemplo el número de la transferencia bancaria; null si no hay nota.
- Largo máximo:
- 1000
withholdingsarray de object o nullRetenciones que la tienda practicó en este pago al proveedor. Para una razón social agente de retención la lista es obligatoria: una lista vacía significa que no hubo retención, y la falta del campo es un rechazo. Las demás razones sociales no necesitan el campo.
- Máximo de elementos:
- 20
Campos · 6
regimestringobligatorioImpuesto retenido: vat, turnover, income y otros códigos de TaxRegime.
- Valores:
vatincometurnovermunicipalinternalsocialother
amountintegerobligatorioImporte de la retención en unidades mínimas de la moneda del comprobante; el total de retenciones es menor que amount. Se descuenta del pago al proveedor. Si el comprobante está en otra moneda, en tax-withholdings queda el equivalente en la moneda de la tienda a la cotización del día del pago; sin cotización, 422.
- Máximo:
- 10000000000
jurisdictionstring o nullJurisdicción de un impuesto provincial o municipal, por ejemplo AR-B: obligatoria en turnover y municipal. null para impuestos nacionales.
- Largo máximo:
- 8
- Patrón:
^[A-Z]{2}-[A-Z0-9]{1,5}$
certificate_numberstring o nullNúmero del certificado de retención entregado al proveedor; null para que la tienda asigne un número de su propia serie.
- Largo máximo:
- 64
rate_bpsinteger o nullAlícuota de la retención en centésimos de punto porcentual (250 es 2,5 %); null si no se conoce.
- Mínimo:
- 0
- Máximo:
- 10000
rate_sourcestring o nullOrigen de la alícuota: padron es el padrón de ARCA o de la provincia, default la alícuota por defecto, manual la cargada a mano; null si no se indica.
- Valores:
padrondefaultmanualnull
Respuestas
201Creado
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
application/json
Devuelve SupplierBillPayment
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
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
supplier_bill_refusedEl comprobante de proveedor no acepta este comando - 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 POST "https://api.saleya.app/v1/supplier-bills/{supplier_bill}/payments/out-of-band" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"amount": 0,
"paid_on": "2026-01-15",
"note": "string",
"withholdings": [
{
"regime": "vat",
"amount": 0,
"jurisdiction": "string",
"certificate_number": "string",
"rate_bps": 0,
"rate_source": "padron"
}
]
}{
"id": 0,
"supplier_bill_id": 0,
"kind": "money",
"amount": 0,
"currency": "string",
"withheld_amount": 0,
"money_account_id": 0,
"account_amount": "string",
"base_amount": 0,
"exchange_rate": "string",
"paid_on": "2026-01-15",
"settlement_offset_id": 0,
"counterpart_bill_id": 0,
"purchase_order_id": 0,
"money_transaction_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Anular un pago de comprobante de proveedor
delete/supplier-bills/{supplier_bill}/payments/{supplier_bill_payment}
Scope: procurement:pay
Parámetros
Ruta
supplier_billintegerobligatorioID del comprobante de proveedor.
supplier_bill_paymentintegerobligatorioID del pago de comprobante de 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"
Respuestas
204Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
Sin cuerpo
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
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
in_use_conflictRegistro en uso - 409
supplier_bill_payment_lockedEl pago del comprobante no se anula directamente - 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 DELETE "https://api.saleya.app/v1/supplier-bills/{supplier_bill}/payments/{supplier_bill_payment}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'