Facturación
Listar comprobantes
Lista las facturas y notas de crédito con búsqueda por número o cliente y filtros de tipo, estado, cliente y fechas. Por defecto trae todos menos los descartados.
GET/api/v1/documents/list
- Permiso
documents.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
searchtextohasta 100 caracteres
kindopciónValores:
invoicecredit-notestatusopciónValores:
draftpending-authorizationauthorizeddiscardedcustomerIduuidsalesOrderIduuiddateFromfechadateTofechasortopciónValores:
datenumbercustomertotalPor defecto:datedirectionopciónValores:
ascdescPor defecto:desccircuitopciónValores:
allfiscalxPor defecto:allpageenteroPor defecto:
1mínimo 1pageSizeenteroPor defecto:
50mínimo 1, máximo 100
Respuesta
200 con este JSON.
documentslista de objetorequeridoCampos de cada elemento (11)
iduuidrequeridokindopciónrequeridoValores:
invoicecredit-notestatusopciónrequeridoValores:
draftpending-authorizationauthorizeddiscardednumbertextorequeridointernalNumberenterorequeridolegalNumberenterorequeridoadmite nullletteropciónrequeridoValores:
ABXdocumentDatefecharequeridocustomerobjetorequeridoCampos (4)
iduuidrequeridolegalNametextorequeridodocumentTypetextorequeridodocumentNumbertextorequerido
totaltextorequeridolastSubmissionobjetorequeridoadmite nullCampos (3)
resultopciónrequeridoValores:
authorizedrejectedunavailableindeterminatemessagecualquierarequeridorecordedAtfecha y horarequerido
totalenterorequeridomínimo 0
pendingenterorequeridomí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 documents.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.