Ir al contenido
ERPDocs
llms.txt

Cobranzas

Listar recibos

Lista los recibos, del más nuevo al más viejo, con búsqueda por número o cliente y filtros de estado (emitidos por defecto, anulados, con saldo a cuenta), medio de cobro, cliente y fechas.

GET/api/v1/collections/list

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

  • searchtextoadmite null

    hasta 100 caracteres

  • statusopción

    Valores: issued voided with-advance allPor defecto: issued

  • circuitopción

    Valores: all fiscal xPor defecto: all

  • kindopciónadmite null

    Valores: cash transfer check echeq withholding

  • customerIduuidadmite null
  • dateFromfechaadmite null
  • dateTofechaadmite null
  • pageentero

    Por defecto: 1mínimo 1, máximo 100000

  • pageSizeentero

    Por defecto: 50mínimo 1, máximo 100

Respuesta

200 con este JSON.

  • receiptslista de objetorequerido
    Campos de cada elemento (11)
    • iduuidrequerido
    • numberenterorequerido
    • nametextorequerido
    • circuitopciónrequerido

      Valores: fiscal x

    • statusopciónrequerido

      Valores: issued voided

    • receiptDatefecharequerido
    • customerobjetorequerido
      Campos (2)
      • iduuidrequerido
      • legalNametextorequerido
    • kindslista de opciónrequerido

      Valores: cash transfer check echeq withholding

    • methodsTexttextorequerido
    • advanceBalancetextorequerido
    • totaltextorequerido
  • totalenterorequerido

    mínimo 0

Errores

Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:

401Falta la credencial o venció.
403La credencial no tiene el permiso collections.view.
409La empresa activa no es la de X-Expected-Company.
422Datos inválidos o una regla de negocio rota, con el detalle por campo.
503Sistema ocupado: reintentá después de Retry-After segundos.

La lista completa está en Errores.