Skip to content
Documentación API

Buscar documento

GET /api/common/documentos/buscardocumento Búsqueda paginada de documentos V4

Descripción

Section titled “Descripción”

Endpoint que permite buscar documentos de Sage de forma paginada.

Devuelve una lista de documentos según el tipo indicado y los criterios de búsqueda proporcionados.

Si se especifica el parámetro opcional campos (lista de campos separados por comas), la respuesta incluirá únicamente esos campos.
Si no se especifica, se devuelven todos los campos.

Los parámetros page y pageSize son obligatorios para controlar la paginación.

Parámetros de consulta

Section titled “Parámetros de consulta”
ParámetroTipoRequeridoDescripción
tipoDocumentostring❌Tipo de documento (por ejemplo, PedidoVenta).
pageint✅Número de página
pageSizeint✅Cantidad de elementos por página
camposstring❌Lista de campos a devolver, separados por comas.
columnaBusquedastring❌Columna por la que se realiza el filtro.
valorBusquedastring❌Valor a buscar en la columna indicada.
codigoEmpresaint✅ (si es multiempresa)Código de la empresa.

El tipoDocumento puede ser:

Ejemplo con curl

Section titled “Ejemplo con curl”
Terminal window
curl -X GET \
  "https://b2b.tandemsm.dev:9394/api/common/documentos/buscardocumento?tipoDocumento=PedidoVenta&page=1&pageSize=10&columnaBusqueda=cifEuropeo&valorBusqueda=B84570936&codigoEmpresa=9999" \
  -H "Accept: */*" \
  -H "Authorization: Bearer tu_access_token"

Respuesta exitosa (200)

Section titled “Respuesta exitosa (200)”
{
  "success": true,
  "message": "Documentos encontradas",
  "result": {
    "data": [
      {
        "codigoEmpresa": 9999,
        "idDelegacion": "",
        "ejercicioPedido": 2023,
        "seriePedido": "ZZ",
        "numeroPedido": 5,
        "fechaPedido": "2023-12-12T00:00:00",
        "numeroLineas": 1,
        "codigoCliente": "000001",
        "codigoCadena_": "",
        "siglaNacion": "ES",
        "cifDni": "B84570936",
        "cifEuropeo": "ESB84570936",
        "razonSocial": "AMAZON SPAIN",
        "razonSocial2": "",
        "nombre": "AMAZON SPAIN",
        "domicilio": "",
        "domicilio2": "",
        "codigoPostal": "",
        "codigoMunicipio": "",
        "municipio": "",
        "colaMunicipio": "",
        "codigoProvincia": "",
        "provincia": "",
        "codigoNacion": 108,
        "nacion": "ESPAÑA",
        "codigoCondiciones": 0,
        "formadePago": "",
        "numeroPlazos": 1,
        "diasPrimerPlazo": 0,
        "diasEntrePlazos": 0,
        "diasFijos1": 0,
        "diasFijos2": 0,
        "diasFijos3": 0,
        "inicioNoPago": 0,
        "finNoPago": 0,
        "controlarFestivos": 0,
        "diasRetroceso": 0,
        "mesesComerciales": 0,
        "codigoContable": "430000001",
        "codigoDefinicion_": "",
        "remesaHabitual": "572000000",
        "codigoBanco": "",
        "codigoAgencia": "",
        "dc": "",
        "ccc": "",
        "iban": "",
        "domicilioEnvio": 0,
        "domicilioFactura": 0,
        "domicilioRecibo": 0,
        "codigoProyecto": "",
        "codigoSeccion": "",
        "codigoDepartamento": "",
        "codigoTransportistaEnvios": 0,
        "tipoPortesEnvios": "D",
        "codigoRetencion": 0,
        "codigoTransaccion": 1,
        "codigoZona": 0,
        "codigoCanal": "",
        "codigoRuta_": "",
        "codigoTerritorio": 0,
        "codigoTipoEfecto": 0,
        "codigoExportacion_": "",
        "condicionExportacion_": "",
        "tarifaPrecio": 0,
        "tarifaDescuento": 0,
        "grupoIva": 0,
        "indicadorIva": "I",
        "ivaIncluido": 0,
        "servirCompleto": 0,
        "reservarStock_": 0,
        "estado": 2,
        "statusAnalitica": 0,
        "statusAprobado": -1,
        "statusListado": 0,
        "statusEstadis": 0,
        "%Descuento": 0,
        "%ProntoPago": 0,
        "%Financiacion": 0,
        "%Retencion": 0,
        "%Rappel": 0,
        "codigoComisionista": 0,
        "codigoComisionista2_": 0,
        "codigoComisionista3_": 0,
        "codigoComisionista4_": 0,
        "codigoJefeVenta_": 0,
        "codigoJefeZona_": 0,
        "%Comision": 0,
        "%Comision2_": 0,
        "%Comision3_": 0,
        "%Comision4_": 0,
        "comisionSobreVenta%_": 0,
        "comisionSobreZona%_": 0,
        "periodicidadFacturas": 0,
        "mascaraPedido_": "",
        "agruparAlbaranes": 0,
        "albaranValorado": -1,
        "copiasAlbaran": 0,
        "copiasFactura": 0,
        "copiasPedido": 0,
        "observacionesCliente": "",
        "observacionesPedido": "",
        "observacionesAlbaran": "",
        "observacionesFactura": "",
        "suPedido": "",
        "fechaNecesaria": "2023-12-12T00:00:00",
        "fechaEntrega": "2023-12-12T00:00:00",
        "fechaTope": "2023-12-12T00:00:00",
        "pesoBruto_": 0,
        "pesoNeto_": 0,
        "volumen_": 0,
        "enEuros_": -1,
        "codigoDivisa": "",
        "codigoIdioma_": "",
        "mantenerCambio_": -1,
        "factorCambio": 0,
        "importeCambio": 0,
        "importeCambioViejo_": 0,
        "importeCoste": 0,
        "importeBruto": 300,
        "importeBrutoDivisa_": 0,
        "importeBrutoPendiente": 0,
        "importeDescuentoLineas": 0,
        "importeDtoLineasDivisa_": 0,
        "importeNetoLineas": 300,
        "importeNetoLineasDivisa_": 0,
        "importeNetoLineasPendiente": 0,
        "importeDescuento": 0,
        "importeDescuentoDivisa_": 0,
        "importeParcial": 300,
        "importeParcialDivisa_": 0,
        "importeParcialPendiente": 0,
        "importeProntoPago": 0,
        "importeProntoPagoDivisa_": 0,
        "baseImponible": 300,
        "baseImponibleDivisa_": 0,
        "baseImponiblePendiente": 0,
        "totalCuotaIva": 63,
        "totalCuotaIvaDivisa_": 0,
        "totalCuotaRecargo": 0,
        "totalCuotaRecargoDivisa_": 0,
        "totalIva": 63,
        "totalIvaDivisa_": 0,
        "importeFinanciacion": 0,
        "importeFinanciacionDivisa_": 0,
        "importeLiquido": 363,
        "importeLiquidoDivisa_": 0,
        "importeRappel": 0,
        "importeRappelDivisa_": 0,
        "ejercicioFacturaOriginal": 0,
        "serieFacturaOriginal": "",
        "numeroFacturaOriginal": 0,
        "ejercicioOferta": 0,
        "serieOferta": "",
        "numeroOferta": 0,
        "codigoTipoOperacionLc": "",
        "codigoTipoOperacionOrigenLc": "",
        "codigoDivisionLc": "",
        "codigoAmbitoClienteLc": "",
        "codigoClaseClienteLc": "",
        "codigoSubclaseClienteLc": "",
        "codigoTipoClienteLc": "",
        "codigoGrupoClienteLc": "",
        "codigoActividadLc": "",
        "codigoSubactividadLc": "",
        "comercialAsignadoLc": 0,
        "facturarCompletoLc": 0,
        "idFacturarCompletoLc": 0,
        "idFacturacionConjuntaLc": 0,
        "idDelegacionCentralLc": "",
        "codigoCampanaLc": "",
        "referenciaEdi_": "",
        "codigoMotivoAbonoLc": "",
        "ejercicioAlbaranOriginalLc": 0,
        "serieAlbaranOriginalLc": "",
        "numeroAlbaranOriginalLc": 0,
        "generarFactura": " ",
        "importeACuentaP_": 0,
        "importeACuentaPDivisa_": 0,
        "importeConsumidoP": 0,
        "importeConsumidoPDivisa_": 0,
        "ejercicioAlbaranDevolucionP": 0,
        "serieAlbaranDevolucionP": "",
        "numeroAlbaranDevolucionP": 0,
        "importePendientePAC": 0,
        "importePendientePACDivisa_": 0,
        "importeFactura": 363,
        "importeFacturaDivisa_": 0,
        "porMargenBeneficio": 100,
        "margenBeneficio": 300,
        "ejercicioExpediente": 0,
        "serieExpediente": "",
        "numeroExpediente": 0,
        "origenDespacho": 0,
        "importeProvisiones": 0,
        "importeProvisionesNF": 0,
        "importeSuplidos": 0,
        "importeProvisionesDivisa": 0,
        "importeProvisionesNFDivisa": 0,
        "importeSuplidosDivisa": 0,
        "codigoContableANT_": "",
        "remesaHabitualANT_": "",
        "anaLote": "",
        "anaCapitulo": "",
        "noFacturable": 0,
        "observacionesWeb": "",
        "suPedidoWeb": 0,
        "varFechaTraspaso": null,
        "varTraspasado": 5,
        "idPedidoCli": "857d63ae-a348-4670-971e-42d96626e764",
        "referenciaMandato": "",
        "suContrato": "",
        "pagoInmediato": 0,
        "statusWF": 0,
        "informeagencia": -1,
        "bultosPDA": 0,
        "servidoPDA": 0,
        "paletPDA": 0,
        "impresoPDA": 0,
        "pesoVolumetricoS": 0,
        "pesoVolumetricoO": 0,
        "etiquetasPDA": 0,
        "tS_ReservaStock": 0,
        "bultos": 0,
        "tS_IncluirPedidoRuta": -1,
        "tS_ExportarAgencia": -1,
        "tS_CambiarSerieAlbaran": -1,
        "tS_Retorno": 0,
        "tS_Sabado": 0,
        "tS_Acuse": 0,
        "tS_Valor": 0,
        "intercompanyGenerado": -1,
        "importeACuenta_": 0,
        "importeACuentaDivisa_": 0,
        "matricula": "",
        "matricula2": "",
        "cP_PedidoCompleto": 0,
        "tS_EstadoPedidoPDA": -1,
        "tS_UsuarioAPreparar": "TODOS",
        "tS_FicheroFirma": "00000000-0000-0000-0000-000000000000",
        "tS_EstadoFirma": 0,
        "tS_FechaFirma": null,
        "tS_B2B": ""
      }
    ],
    "totalRecords": 1,
    "totalPages": 1,
    "currentPage": 1,
    "pageSize": 10
  }
}