Cobranzas

Ver un recibo

Devuelve un recibo con su cliente tal como se registró, sus medios de cobro, lo imputado, lo que dejó a cuenta y sus aplicaciones posteriores, y su anulación.

GET/api/v1/collections/get

Permiso: collections.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

receiptIduuidrequerido

Respuesta

200 con este JSON.

iduuidrequerido
numberenterorequerido
nametextorequerido
circuitopciónrequerido
Valores: fiscal x
statusopciónrequerido
Valores: issued voided
receiptDatefecharequerido
customerobjetorequerido
Campos (5)
- iduuidrequerido
- legalNametextorequerido
- documentTypetextorequerido
- documentNumbertextorequerido
- addresstextorequerido
kindslista de opciónrequerido
Valores: cash transfer check echeq withholding
methodsTexttextorequerido
advanceBalancetextorequerido
totaltextorequerido
versionenterorequerido
mínimo 1
allocatedTotaltextorequerido
advanceTotaltextorequerido
isAdvancesí o norequerido
notescualquierarequerido
methodslista de objetorequerido
Campos de cada elemento (12)
- kindopciónrequerido
  Valores: cash transfer check echeq withholding
- amounttextorequerido
- bankNamecualquierarequerido
- referencecualquierarequerido
- checkNumbercualquierarequerido
- drawerNamecualquierarequerido
- drawerTaxIdcualquierarequerido
- paymentDatefecharequeridoadmite null
- taxopciónrequeridoadmite null
  Valores: vat income gross-income social-security
- jurisdictionobjetorequeridoadmite null
  Campos (2)
  - iduuidrequerido
  - nametextorequerido
- certificateNumbercualquierarequerido
- certificateDatefecharequeridoadmite null
allocationslista de objetorequerido
Campos de cada elemento (10)
- iduuidrequerido
- originopciónrequerido
  Valores: receipt advance
- allocatedOnfecharequerido
- amounttextorequerido
- documentobjetorequerido
  Campos (2)
  - iduuidrequerido
  - labeltextorequerido
- installmentcualquierarequerido
- dueDatefecharequerido
- balancetextorequerido
- documentBalancetextorequerido
- createdByobjetorequeridoadmite null
  Campos (2)
  - idtextorequerido
  - namecualquierarequerido
registeredAtfecha y horarequerido
registeredByobjetorequeridoadmite null
Campos (2)
- idtextorequerido
- namecualquierarequerido
voidReasoncualquierarequerido
voidedAtfecha y horarequeridoadmite null
voidedByobjetorequeridoadmite null
Campos (2)
- idtextorequerido
- namecualquierarequerido
accountobjetorequeridoadmite null
Campos (2)
- balancetextorequerido
- openDocumentsenterorequerido
  mínimo 0
registeredWithobjetorequeridoadmite null
Campos (3)
- iduuidrequerido
- nametextorequerido
- totaltextorequerido

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 `collections.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/collections/get?receiptId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/collections/get?receiptId=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",
  "circuit": "fiscal",
  "status": "issued",
  "receiptDate": "2026-10-23",
  "customer": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "legalName": "texto",
    "documentType": "texto",
    "documentNumber": "texto",
    "address": "texto"
  },
  "kinds": [
    "cash"
  ],
  "methodsText": "texto",
  "advanceBalance": "texto",
  "total": "texto",
  "version": 1,
  "allocatedTotal": "texto",
  "advanceTotal": "texto",
  "isAdvance": false,
  "notes": null,
  "methods": [
    {
      "kind": "cash",
      "amount": "texto",
      "bankName": null,
      "reference": null,
      "checkNumber": null,
      "drawerName": null,
      "drawerTaxId": null,
      "paymentDate": "2026-10-23",
      "tax": "vat",
      "jurisdiction": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "name": "texto"
      },
      "certificateNumber": null,
      "certificateDate": "2026-10-23"
    }
  ],
  "allocations": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "origin": "receipt",
      "allocatedOn": "2026-10-23",
      "amount": "texto",
      "document": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "label": "texto"
      },
      "installment": null,
      "dueDate": "2026-10-23",
      "balance": "texto",
      "documentBalance": "texto",
      "createdBy": {
        "id": "texto",
        "name": null
      }
    }
  ],
  "registeredAt": "2026-10-23T14:30:00.000Z",
  "registeredBy": {
    "id": "texto",
    "name": null
  },
  "voidReason": null,
  "voidedAt": "2026-10-23T14:30:00.000Z",
  "voidedBy": {
    "id": "texto",
    "name": null
  },
  "account": {
    "balance": "texto",
    "openDocuments": 1
  },
  "registeredWith": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "name": "texto",
    "total": "texto"
  }
}