Pagos

Ver una orden de pago

Devuelve una orden de pago con su proveedor tal como se registró, sus medios de pago, lo imputado con la diferencia de cambio, lo que dejó a favor y sus aplicaciones posteriores, los avisos confirmados y su recupero.

GET/api/v1/payments/get

Permiso: payments.view
Empresa: Opera sobre la empresa activa
Tipo: Lectura: no cambia nada
Respuesta: JSON

Encabezados

Cookietextorequerido
La cookie de sesión del usuario de la integración (__Secure-erp.session_token). Cuando esté la clave API, va en Authorization: Bearer. Ver Autenticación.
X-Expected-Companyuuidrequerido
La empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.

Parámetros de la consulta

paymentOrderIduuidrequerido

Respuesta

200 con este JSON.

iduuidrequerido
numberenterorequerido
nametextorequerido
paymentDatefecharequerido
supplierobjetorequerido
Campos (4)
- iduuidrequerido
- legalNametextorequerido
- taxIdtextorequerido
- addresstextorequerido
currencyCodetextorequerido
kindslista de opciónrequerido
Valores: transfer cash own-check own-echeq endorsed-check
methodsTexttextorequerido
advanceBalancetextorequerido
totaltextorequerido
recoveredsí o norequerido
versionenterorequerido
mínimo 1
exchangeRatecualquierarequerido
foreignCurrencyCodecualquierarequerido
allocatedTotaltextorequerido
advanceTotaltextorequerido
isAdvancesí o norequerido
methodsTotaltextorequerido
exchangeDifferencetextorequerido
notescualquierarequerido
warningsAcceptedlista de opciónrequerido
Valores: payments.apocryphal payments.invoice-not-verified
methodslista de objetorequerido
Campos de cada elemento (10)
- kindopciónrequerido
  Valores: transfer cash own-check own-echeq endorsed-check
- amounttextorequerido
- fromAccountcualquierarequerido
- toAccountobjetorequeridoadmite null
  Campos (3)
  - iduuidrequerido
  - bankNamecualquierarequerido
  - accountKeytextorequerido
- referencecualquierarequerido
- bankNamecualquierarequerido
- checkNumbercualquierarequerido
- drawerNamecualquierarequerido
- drawerTaxIdcualquierarequerido
- dueDatefecharequeridoadmite null
allocationslista de objetorequerido
Campos de cada elemento (15)
- iduuidrequerido
- originopciónrequerido
  Valores: payment-order advance
- allocatedOnfecharequerido
- paidtextorequerido
- cancelledtextorequerido
- currencyCodetextorequerido
- exchangeDifferencetextorequerido
- documentobjetorequerido
  Campos (3)
  - iduuidrequerido
  - kindtextorequerido
  - labeltextorequerido
- installmentcualquierarequerido
- dueDatefecharequerido
- balancetextorequerido
- documentBalancetextorequerido
- documentRatecualquierarequerido
- reversedsí o norequerido
- createdByobjetorequeridoadmite null
  Campos (2)
  - idtextorequerido
  - namecualquierarequerido
recoveryobjetorequeridoadmite null
Campos (10)
- iduuidrequerido
- numberenterorequerido
- nametextorequerido
- recoveryDatefecharequerido
- totaltextorequerido
- refundKindopciónrequerido
  Valores: returned not-paid
- toAccountcualquierarequerido
- reasontextorequerido
- registeredAtfecha y horarequerido
- registeredByobjetorequeridoadmite null
  Campos (2)
  - idtextorequerido
  - namecualquierarequerido
registeredAtfecha y horarequerido
registeredByobjetorequeridoadmite null
Campos (2)
- idtextorequerido
- namecualquierarequerido
supplierAccountlista de objetorequeridoadmite null
Campos de cada elemento (2)
- currencyCodetextorequerido
- amounttextorequerido

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.

curl
TypeScript

curl "$ERP_URL/api/v1/payments/get?paymentOrderId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/payments/get?paymentOrderId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90`, {
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
  },
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

{
  "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "number": 1,
  "name": "texto",
  "paymentDate": "2026-10-23",
  "supplier": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "legalName": "texto",
    "taxId": "texto",
    "address": "texto"
  },
  "currencyCode": "texto",
  "kinds": [
    "transfer"
  ],
  "methodsText": "texto",
  "advanceBalance": "texto",
  "total": "texto",
  "recovered": false,
  "version": 1,
  "exchangeRate": null,
  "foreignCurrencyCode": null,
  "allocatedTotal": "texto",
  "advanceTotal": "texto",
  "isAdvance": false,
  "methodsTotal": "texto",
  "exchangeDifference": "texto",
  "notes": null,
  "warningsAccepted": [
    "payments.apocryphal"
  ],
  "methods": [
    {
      "kind": "transfer",
      "amount": "texto",
      "fromAccount": null,
      "toAccount": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "bankName": null,
        "accountKey": "texto"
      },
      "reference": null,
      "bankName": null,
      "checkNumber": null,
      "drawerName": null,
      "drawerTaxId": null,
      "dueDate": "2026-10-23"
    }
  ],
  "allocations": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "origin": "payment-order",
      "allocatedOn": "2026-10-23",
      "paid": "texto",
      "cancelled": "texto",
      "currencyCode": "texto",
      "exchangeDifference": "texto",
      "document": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "kind": "texto",
        "label": "texto"
      },
      "installment": null,
      "dueDate": "2026-10-23",
      "balance": "texto",
      "documentBalance": "texto",
      "documentRate": null,
      "reversed": false,
      "createdBy": {
        "id": "texto",
        "name": null
      }
    }
  ],
  "recovery": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "number": 1,
    "name": "texto",
    "recoveryDate": "2026-10-23",
    "total": "texto",
    "refundKind": "returned",
    "toAccount": null,
    "reason": "texto",
    "registeredAt": "2026-10-23T14:30:00.000Z",
    "registeredBy": {
      "id": "texto",
      "name": null
    }
  },
  "registeredAt": "2026-10-23T14:30:00.000Z",
  "registeredBy": {
    "id": "texto",
    "name": null
  },
  "supplierAccount": [
    {
      "currencyCode": "texto",
      "amount": "texto"
    }
  ]
}