Consultar detalle de ventas

Retorna el detalle de ventas de Pymes desglosado por línea de documento (una fila por ítem facturado). Incluye facturas de venta y notas crédito. Solo se incluyen documentos cuyo estado no sea EP (en proceso). Adicionalmente, permite consultar los impuestos y retenciones aplicados a cada línea del detalle enviando embedded=impuestos junto con el cliente (clienteUuid o clienteId) o el numero del documento.

Parámetros

ParámetroTipoObligatorioDescripción
establecimientostringNoUUID o código del establecimiento a filtrar. Si no se envía, o si corresponde a un nodo de tipo compañía, retorna la consolidación de toda la compañía.
clienteUuidstringNoUUID del cliente en Loggro a filtrar.
clienteIdstringNoNúmero de identificación del cliente a filtrar.
tipoDocumentostringNoTipo de documento a filtrar. Valores permitidos: FAVE (factura de venta), NCVE (nota crédito de venta).
numerostringNoNúmero del documento a filtrar. Si se envía y no se indican fechaDesde ni fechaHasta, la consulta se realiza sin restricción de rango de fechas.
fechaDesdestringCondicionalFecha inicial del rango a consultar. Formato dd/MM/yyyy. Obligatorio, salvo que se envíe numero sin indicar ninguna fecha.
fechaHastastringCondicionalFecha final del rango a consultar. Formato dd/MM/yyyy. Obligatorio, salvo que se envíe numero sin indicar ninguna fecha.
embeddedstringNoPermite incluir información adicional en la respuesta. Único valor soportado: impuestos. Requiere indicar clienteUuid, clienteId o numero.
pageintegerNoNúmero de página (base 1). Debe ser mayor o igual a 1. Por defecto 1.
limitintegerNoMáximo de registros por página. Debe ser mayor o igual a 1 y no puede superar 100. Por defecto 20.

Reglas de negocio

  • fechaDesde y fechaHasta son obligatorios, a menos que se envíe numero sin indicar ninguna de las dos fechas.
  • Si se envía únicamente fechaDesde o únicamente fechaHasta (sin la otra), la fecha faltante sigue siendo obligatoria, incluso si se envía numero.
  • fechaDesde y fechaHasta deben tener el formato dd/MM/yyyy; de lo contrario retorna 400.
  • fechaDesde debe ser anterior a fechaHasta; de lo contrario retorna 400.
  • fechaHasta no puede ser una fecha futura; de lo contrario retorna 400.
  • El rango entre fechaDesde y fechaHasta no puede superar 31 días; de lo contrario retorna 400.
  • Si se envía tipoDocumento, debe ser FAVE o NCVE; de lo contrario retorna 400.
  • Si se envía embedded, su único valor permitido es impuestos; de lo contrario retorna 400.
  • Si se envía embedded=impuestos, es obligatorio indicar clienteUuid, clienteId o numero; de lo contrario retorna 400.
  • Si se envía establecimiento y no existe (por UUID o código), retorna 404.
  • page debe ser mayor o igual a 1; de lo contrario retorna 400.
  • limit debe ser mayor o igual a 1 y no puede superar 100; de lo contrario retorna 400.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

UUID o código del establecimiento a filtrar. Si no se envía, retorna la consolidación de toda la compañía.

string

UUID del cliente en Loggro a filtrar.

string

Número de identificación del cliente a filtrar.

string
enum

Tipo de documento a filtrar (FAVE, NCVE).

Allowed:
string

Número del documento a filtrar. Si se envía y no se indican fechaDesde ni fechaHasta, la consulta se realiza sin restricción de rango de fechas.

string

Fecha inicial del rango a consultar. Formato dd/MM/yyyy. Obligatorio, salvo que se envíe numero sin indicar ninguna fecha.

string

Fecha final del rango a consultar. Formato dd/MM/yyyy. Obligatorio, salvo que se envíe numero sin indicar ninguna fecha.

string
enum

Información adicional a incluir en la respuesta. Único valor soportado impuestos. Requiere clienteUuid, clienteId o numero.

Allowed:
integer
≥ 1
Defaults to 1

Número de página (base 1). Debe ser mayor o igual a 1. Por defecto 1.

integer
1 to 100
Defaults to 20

Cantidad máxima de registros a retornar. Debe ser mayor o igual a 1 y no puede superar 100. Por defecto 20.

Responses

400

fechaDesde o fechaHasta no se envían (y no se envió numero) o tienen formato inválido, fechaDesde no es anterior a fechaHasta, fechaHasta es una fecha futura, el rango entre fechaDesde y fechaHasta supera 31 días, tipoDocumento no es FAVE ni NCVE, embedded tiene un valor distinto de impuestos, se envía embedded=impuestos sin indicar clienteUuid, clienteId ni numero, o page/limit son inválidos.

404

Establecimiento no encontrado.

500

Error interno del servidor.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json