Pagos
Listar órdenes de pago
Lista las órdenes de pago, de la más nueva a la más vieja, con búsqueda por número o proveedor y filtros de estado (vigentes por defecto, recuperadas, con saldo a favor), medio de pago, moneda, proveedor y fechas.
GET/api/v1/payments/list
- Permiso
payments.view- Empresa
- Opera sobre la empresa activa
- Tipo
- Lectura: no cambia nada
- Respuesta
- JSON
Encabezados
CookietextorequeridoLa cookie de sesión del usuario de la integración (
__Secure-erp.session_token). Cuando esté la clave API, va enAuthorization: Bearer. Ver Autenticación.X-Expected-CompanyuuidrequeridoLa empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.
Parámetros de la consulta
searchtextoadmite nullhasta 100 caracteres
statusopciónValores:
issuedrecoveredwith-advanceallPor defecto:issuedkindopciónadmite nullValores:
transfercashown-checkown-echeqendorsed-checkcurrencyCodetextoadmite nullformato `^[A-Z]{3}$`
supplierIduuidadmite nulldateFromfechaadmite nulldateTofechaadmite nullpageenteroPor defecto:
1mínimo 1, máximo 100000pageSizeenteroPor defecto:
50mínimo 1, máximo 100
Respuesta
200 con este JSON.
orderslista de objetorequeridoCampos de cada elemento (11)
iduuidrequeridonumberenterorequeridonametextorequeridopaymentDatefecharequeridosupplierobjetorequeridoCampos (2)
iduuidrequeridolegalNametextorequerido
currencyCodetextorequeridokindslista de opciónrequeridoValores:
transfercashown-checkown-echeqendorsed-checkmethodsTexttextorequeridoadvanceBalancetextorequeridototaltextorequeridorecoveredsí o norequerido
totalenterorequeridomínimo 0
Errores
Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:
401 | Falta la credencial o venció. |
403 | La credencial no tiene el permiso payments.view. |
409 | La empresa activa no es la de X-Expected-Company. |
422 | Datos inválidos o una regla de negocio rota, con el detalle por campo. |
503 | Sistema ocupado: reintentá después de Retry-After segundos. |
La lista completa está en Errores.