API : Compras OC

https://www.obuma.cl/ayuda/articulo/331/api--compras-oc


API Endpoint: Compras Orden de Compra (OC)

 

Listar Compras

  • URL: /comprasOc.list.json
  • Método: GET
  • Descripción: Obtiene una lista de todas las órdenes de compra (OC) registradas, permitiendo aplicar múltiples filtros.
  • Parámetros (opcional):
    • id_dcto_desde: Filtra las órdenes de compra comenzando desde un ID específico.
    • folio_dcto: Filtra por folio de la OC.
    • mes: Filtra por mes de emisión de la OC.
    • ano: Filtra por año de emisión de la OC.
    • fecha: Filtra por fecha específica de emisión en formato dd-mm-aaaa.
    • fecha_desde: Filtra por fecha de emisión desde esta fecha (formato dd-mm-aaaa).
    • fecha_hasta: Filtra por fecha de emisión hasta esta fecha (formato dd-mm-aaaa).
    • total: Filtra por el monto total de la OC.
    • proveedor: Filtra por el ID del proveedor asociado a la OC.
    • sucursal: Filtra por el ID de la sucursal asociada a la OC.
    • bodega: Filtra por el ID de la bodega asociada a la OC.
    • estado: Filtra por el estado de la OC (nuevo filtro).
    • forma_pago: Filtra por la forma de pago de la OC (nuevo filtro).
    • metodo_despacho: Filtra por el método de despacho utilizado en la OC (nuevo filtro).
    • moneda: Filtra por la moneda utilizada en la OC (nuevo filtro).
    • centro_costo: Filtra por el centro de costo asociado a la OC (nuevo filtro).
    • concepto_gasto: Filtra por el concepto de gasto asociado a la OC (nuevo filtro).

 

Listar Items de las Compras

  • URL: /comprasOc.listItems.json
  • Método: GET
  • Descripción: Obtiene una lista de todos los items de las órdenes de compra (OC) registradas, permitiendo aplicar múltiples filtros.
  • Parámetros (opcional):
    • Filtros de la OC:
      • id_dcto_desde: Filtra las órdenes de compra comenzando desde un ID específico.
      • folio_dcto: Filtra por folio de la OC.
      • mes: Filtra por mes de emisión de la OC.
      • ano: Filtra por año de emisión de la OC.
      • fecha: Filtra por fecha específica de emisión en formato dd-mm-aaaa.
      • fecha_desde: Filtra por fecha de emisión desde esta fecha (formato dd-mm-aaaa).
      • fecha_hasta: Filtra por fecha de emisión hasta esta fecha (formato dd-mm-aaaa).
      • total: Filtra por el monto total de la OC.
      • proveedor: Filtra por el ID del proveedor asociado a la OC.
      • sucursal: Filtra por el ID de la sucursal asociada a la OC.
      • bodega: Filtra por el ID de la bodega asociada a la OC.
    • Filtros de los Items:
      • producto: Filtra por el ID del producto asociado al item.
      • producto_sku: Filtra por el código SKU del producto.

 

Obtener Último Folio Emitido

  • URL: /comprasOc.listLast.json
  • Método: GET
  • Descripción: Devuelve el último folio emitido para un tipo de documento específico en el sistema.
  • Parámetros:
    • No se requieren parámetros adicionales.

 

Obtener Compra por ID

  • URL: /comprasOc.findById.json/{RecursoId}
  • Método: GET
  • Descripción: Devuelve la información detallada de una orden de compra específica, incluyendo los items.
  • Parámetros:
    • RecursoId: ID de la orden de compra.

 

Crear Orden de Compra

  • URL: /comprasOc.create.json
  • Método: POST
  • Descripción: Crea una nueva orden de compra en el sistema con los datos proporcionados.
  • Body (JSON):
    • docs: Lista de documentos (órdenes de compra) a crear.
      • Campos para cada OC:
        • proveedor_rut: RUT del proveedor.
        • proveedor_razon_social: Razón social del proveedor.
        • proveedor_giro: Giro comercial del proveedor.
        • proveedor_direccion: Dirección del proveedor.
        • proveedor_comuna: ID de la comuna del proveedor.
        • proveedor_region: ID de la región del proveedor.
        • proveedor_email: Email del proveedor.
        • proveedor_telefono: Teléfono del proveedor.
        • proveedor_contacto: Contacto del proveedor.
        • oc_fecha: Fecha de la OC.
        • oc_sucursal: ID de la sucursal.
        • oc_usuario: ID del usuario.
        • oc_centro_costo: ID del centro de costo.
        • oc_concepto_gasto: ID del concepto de gasto.
        • oc_subtotal: Subtotal de la OC.
        • oc_descuento_pesos: Descuento en pesos.
        • oc_descuento_porciento: Descuento en porcentaje.
        • oc_exento: Monto exento.
        • oc_neto: Monto neto.
        • oc_iva: Monto del IVA.
        • oc_total: Monto total.
        • oc_fecha_entrega_productos: Fecha de entrega de productos.
        • oc_fecha_arribo_productos: Fecha de arribo de productos.
        • oc_forma_pago: Forma de pago.
        • oc_metodo_despacho: Método de despacho.
        • oc_direccion_despacho: Dirección de despacho.
        • oc_direccion_envio_factura: Dirección de envío de factura.
        • oc_validez: Validez de la OC.
        • oc_condiciones: Condiciones de la OC.
        • oc_observacion: Observaciones.
        • oc_referencia: Referencias.
        • oc_concepto: Concepto de la OC.
        • oc_internacional: Indicador de internacionalización.
        • oc_internacional_tipocambio: Tipo de cambio para OC internacional.
        • oc_moneda: ID de la moneda.
        • oc_estado: Estado de la OC.
        • oc_detalle: Lista de detalles de los items de la OC.
          • Campos para cada Item:
            • producto_id: ID del producto.
            • producto_nombre: Nombre del producto.
            • producto_descripcion: Descripción del producto.
            • producto_exento: Indicador de exención.
            • codigo_comercial: Código comercial del producto.
            • unidad_medida: Unidad de medida del producto.
            • cantidad: Cantidad del producto.
            • precio: Precio del producto.
            • descuento: Descuento aplicado.
            • subtotal: Subtotal del producto.
            • ia_codigo: Código de impuestos adicionales.
            • ia_tasa: Tasa de impuestos adicionales.
            • ia_monto: Monto de impuestos adicionales.
        • oc_referencias: Lista de referencias asociadas a la OC.
          • Campos para cada Referencia:
            • tipo_dcto_ref: Tipo de documento de referencia.
            • folio_dcto_ref: Folio del documento de referencia.
            • fecha_dcto_ref: Fecha del documento de referencia.
            • codigo_ref: Código de referencia.
            • razon_ref: Razón de la referencia.
        • oc_extra_datos: Lista de datos adicionales (metadatos) asociados a la OC.
          • Campos para cada Meta Dato:
            • key: Clave del metadato.
            • value: Valor del metadato.

 

Actualizar Orden de Compra

  • URL: /comprasOc.update.json
  • Método: POST
  • Descripción: Actualiza una orden de compra existente en el sistema con los datos proporcionados.
  • Body (JSON):
    • docs: Lista de documentos (órdenes de compra) a actualizar.
      • Campos para cada OC:
        • oc_id: ID de la orden de compra a actualizar.
        • proveedor_rut: RUT del proveedor.
        • proveedor_razon_social: Razón social del proveedor.
        • proveedor_giro: Giro comercial del proveedor.
        • proveedor_direccion: Dirección del proveedor.
        • proveedor_comuna: ID de la comuna del proveedor.
        • proveedor_region: ID de la región del proveedor.
        • proveedor_email: Email del proveedor.
        • proveedor_telefono: Teléfono del proveedor.
        • proveedor_contacto: Contacto del proveedor.
        • oc_fecha: Fecha de la OC.
        • oc_sucursal: ID de la sucursal.
        • oc_usuario: ID del usuario.
        • oc_centro_costo: ID del centro de costo.
        • oc_concepto_gasto: ID del concepto de gasto.
        • oc_subtotal: Subtotal de la OC.
        • oc_descuento_pesos: Descuento en pesos.
        • oc_descuento_porciento: Descuento en porcentaje.
        • oc_exento: Monto exento.
        • oc_neto: Monto neto.
        • oc_iva: Monto del IVA.
        • oc_total: Monto total.
        • oc_fecha_entrega_productos: Fecha de entrega de productos.
        • oc_fecha_arribo_productos: Fecha de arribo de productos.
        • oc_forma_pago: Forma de pago.
        • oc_metodo_despacho: Método de despacho.
        • oc_direccion_despacho: Dirección de despacho.
        • oc_direccion_envio_factura: Dirección de envío de factura.
        • oc_validez: Validez de la OC.
        • oc_condiciones: Condiciones de la OC.
        • oc_observacion: Observaciones.
        • oc_referencia: Referencias.
        • oc_concepto: Concepto de la OC.
        • oc_internacional: Indicador de internacionalización.
        • oc_internacional_tipocambio: Tipo de cambio para OC internacional.
        • oc_moneda: ID de la moneda.
        • oc_estado: Estado de la OC.
        • oc_detalle: Lista de detalles de los items de la OC.
          • Campos para cada Item:
            • producto_id: ID del producto.
            • producto_nombre: Nombre del producto.
            • producto_descripcion: Descripción del producto.
            • producto_exento: Indicador de exención.
            • codigo_comercial: Código comercial del producto.
            • unidad_medida: Unidad de medida del producto.
            • cantidad: Cantidad del producto.
            • precio: Precio del producto.
            • descuento: Descuento aplicado.
            • subtotal: Subtotal del producto.
            • ia_codigo: Código de impuestos adicionales.
            • ia_tasa: Tasa de impuestos adicionales.
            • ia_monto: Monto de impuestos adicionales.
        • oc_referencias: Lista de referencias asociadas a la OC.
          • Campos para cada Referencia:
            • tipo_dcto_ref: Tipo de documento de referencia.
            • folio_dcto_ref: Folio del documento de referencia.
            • fecha_dcto_ref: Fecha del documento de referencia.
            • codigo_ref: Código de referencia.
            • razon_ref: Razón de la referencia.
        • oc_extra_datos: Lista de datos adicionales (metadatos) asociados a la OC.
          • Campos para cada Meta Dato:
            • key: Clave del metadato.
            • value: Valor del metadato.

Nota: Al actualizar, los items actuales de la OC se eliminan y se ingresan nuevamente con la información proporcionada.