Consultar detalle de compras

Retorna el detalle de compras (facturas y notas crédito de compra), una fila por línea de detalle, con los campos de encabezado repetidos en cada fila — en reemplazo del Explorador Documentos del Proveedor.

Siempre se incluyen únicamente Facturas de Compra (FACO) y Notas Crédito de Compra (NCCO); el parámetro tipoDocumento, si se envía, solo restringe dentro de ese mismo conjunto. Las Notas Crédito de Compra incluyen todas sus variantes (Otros Conceptos, Mayor Valor Facturado, Devolución de Mercancía, Nota de Ajuste por Anulación); el sub-tipo se expone en tipoNotaCreditoCompraCodigo/ tipoNotaCreditoCompraDescripcion. Nota Débito de Compra no existe en el sistema y no aplica a este reporte.

fechaDesde y fechaHasta son obligatorios salvo que se envíe numero. El rango máximo es 31 días (inclusive); un solo día (fechaDesde igual a fechaHasta) es válido. fechaHasta no puede ser una fecha futura.

El proveedor se puede identificar de una de estas dos formas, que son excluyentes entre sí: con el parámetro proveedorUuid, o con la pareja de parámetros proveedorTipoId e proveedorId (ambos obligatorios cuando se usa esta forma). Es opcional en general, salvo que se use embedded=impuestos sin enviar numero.

El parámetro embedded=impuestos agrega el desglose de impuestos y retenciones por línea (impuestosDetalle). Los códigos y descripciones de impuestos son configuración propia de cada compañía — no asumir que un código significa lo mismo en todos los clientes.

esDocumentoSoporteElectronico indica si el documento fue transmitido electrónicamente a la DIAN como Documento Soporte — no indica si el documento podría calificar como documento soporte.

Los campos condicionales/opcionales de descuentos y retenciones (porcentajeDescuento, valorDescuento, porcentajeDescuentoPiePagina, valorDescuentoPiePagina, totalDescuentos, totalRetencionesDetalle) nunca se devuelven como null: si el documento no tiene descuento o retención aplicable, se devuelve 0.00. No hay forma de distinguir "no aplica" de "aplica y es cero" desde la respuesta.

Esta es una API de detalle (una fila por línea del documento). Los campos sufijados ...Detalle (totalImpuestosDetalle, totalRetencionesDetalle, valorTotalDetalle) junto con porcentajeDescuento, valorDescuento, porcentajeDescuentoPiePagina, valorDescuentoPiePagina, totalDescuentos y precioTotalConImpuestos son valores propios de cada línea, distintos entre sí. precioTotalConImpuestos es valorTotalDetalle + totalImpuestosDetalle.

Los campos sufijados ...Encabezado (valorTotalBrutoEncabezado, valorTotalDescuentosEncabezado, valorTotalNetoEncabezado, totalImpuestosEncabezado, totalCargosEncabezado, ajusteEncabezado, totalRetencionesEncabezado, totalDeduccionesEncabezado, saldoOriginalEncabezado), en cambio, son totales del documento completo — el mismo valor se repite igual en todas las líneas de un mismo documento.

Los cargos de un documento (registros propios, distintos de los ítems) no se exponen como líneas de detalle en esta API — su valor total agregado sí está disponible en totalCargosEncabezado.

Dentro de impuestosDetalle, tarifaRetencion/valorRetencion son la excepción: solo aparecen en el objeto de IVA (la única retención que en Loggro Pymes viaja embebida sobre otro impuesto, el ReteIVA) — para cualquier otro impuesto o retención (ICO, ICA, RTF, ICUI, etc.) esos dos campos no vienen en la respuesta.

Paginación

size es un alias de limit: solo se usa si limit no se envía explícitamente. Si se envían ambos, limit tiene precedencia. offset, si se envía, sobrescribe el cálculo automático a partir de page y limit/size. page, limit, size y offset deben ser números enteros; page, limit y size además deben ser mayores o iguales a 1; de lo contrario retorna 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Fecha inicial del rango, formato dd/MM/yyyy. Obligatorio salvo que se envíe numero.

string

Fecha final del rango, formato dd/MM/yyyy. Obligatorio salvo que se envíe numero. Máximo 31 días desde fechaDesde (inclusive); un solo día es válido. No puede ser una fecha futura.

string

UUID del proveedor. No se puede enviar junto con proveedorTipoId o proveedorId.

string

UUID o abreviación del tipo de identificación del proveedor (ej. NIT, CC). Se debe enviar junto con proveedorId.

string

Número de identificación del proveedor. Se debe enviar junto con proveedorTipoId.

string
enum

Estado del documento. Catálogo de Factura de Compra: PG = Pagada, XP = Por Pagar, RE = Rechazada, AN = Anulada, PP = Pagada Parcialmente, EV = En Validación, PD = Pendiente Anulación. Catálogo propio de Nota Crédito de Compra: PA = Por Aplicar, AP = Aplicada Parcialmente, A = Aplicada. El estado EP (En Proceso) no aplica a este reporte, ya que un documento en proceso todavía no es una compra o nota crédito finalizada; no se acepta como valor de filtro.

string
enum

Restringe el resultado a un tipo de documento dentro del conjunto fijo (FACO/NCCO) que ya aplica siempre.

Allowed:
string

Número de documento puntual. No distingue mayúsculas/minúsculas.

string
enum

impuestos: incluye el desglose de impuestos y retenciones por línea (impuestosDetalle). Requiere que el proveedor esté identificado (proveedorUuid o proveedorTipoId+proveedorId) o que se envíe numero.

Allowed:
string

UUID o código completo de un nodo de la estructura empresarial (unidad de negocio, agrupador, establecimiento o bodega) por el cual filtrar el reporte. Si no se envía, o si resuelve a la compañía raíz, el reporte se consulta a nivel de toda la compañía.

integer
≥ 1
Defaults to 1

Número de página a consultar (base 1). Debe ser un número entero mayor o igual a 1; de lo contrario retorna 400. Por defecto 1.

integer
1 to 100
Defaults to 20

Número de registros por página. Debe ser un número entero mayor o igual a 1 y no puede superar 100; de lo contrario retorna 400. Tiene precedencia sobre size si ambos se envían. Por defecto 20.

integer
1 to 100

Alias de limit; solo se utiliza si limit no se envía explícitamente. Debe ser un número entero mayor o igual a 1 y no puede superar 100; de lo contrario retorna 400.

integer
≥ 0

Número de registros a omitir. Si se envía, sobrescribe el cálculo de offset a partir de page y limit/size. Debe ser un número entero no negativo; de lo contrario retorna 400.

Responses

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