Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

Se podrá consultar los saldos en inventario de acuerdo a los movimientos que se realiceninventory/getInventory

Describe las especificaciones técnicas para el consumo del servicioque permite consultar los saldos de inventario del usuario calificado. 

Solicitud

Valor

Nombre servicio

getInventory

Tipo método

POST

URL

https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/inventory/getInventory

Content type

application/json

Parámetros

Los parámetros se deben enviar en el cuerpo de la solicitud utilizando el formato de form data. Los siguientes parámetros son opcionales y se pueden utilizar para filtrar los resultados del inventario:

Parámetros

Descripción

product_code

Código del producto Ej: PROD01

description

Descripción del producto Ej: Camisa

reference

Código del formulario de ingreso, adicionando el número del ítem. Ej: 2255-1

import_declaration

declaración de importación Ej: 89235013

subheading

Código de la subpartida Ej: 2707501000

trade_agreement

Código de acuerdo comercial Ej: 01

business_unit_code

Código de la unidad comercial Ej: KG

invoice

Número de factura, registrado en el ítem del formulario.

certificate

Código del formulario de certificado Ej: 1028

Respuesta

La respuesta será un objeto JSON que contiene la información del inventario solicitado.

Bloque de código
{
    "status": {
        "code": 200,
        "message": "Procesado con éxito",
        "data": {
            "current_page": 1,
            "data": [
                {
                    "inventory_id": 1033,
                    "inventory_initial_operation": "101",
                    "inventory_operation_code": "101",
                    "inventory_business_unit": "KG",
                    "inventory_trade_agreement": "011",
                    "inventory_import_declaration": null,
                    "inventory_reference_description": "1599-1",
                    "inventory_integration_certificate": 0,
                    "inventory_nature_of_inventory": "EXT",
                    "inventory_third_party_name": "3M COLOMBIA S.A.",
                    "inventory_third_party_nit": "860002693",
                    "inventory_quantity_available": "0",
                    "inventory_quantity_go_out": "0",
                    "inventory_quantity_reserved": "0",
                    "inventory_quantity_reserved_input": "1,000",
                    "inventory_quantity_temporary": "0",
                    "inventory_quantity_free_zone": "0",
                    "inventory_quantity_total": "0",
                    "inventory_quantity_available_product": "0",
                    "inventory_quantity_go_out_product": "0",
                    "inventory_quantity_reserved_product": "0",
                    "inventory_quantity_reserved_product_input": "1000",
                    "inventory_quantity_temporary_product": "0",
                    "inventory_quantity_free_zone_product": "0",
                    "inventory_quantity_total_product": "0",
                    "inventory_net_weight_product_unit": "1",
                    "inventory_value_fob_unit_product": "0.123",
                    "inventory_value_cif_unit_product": "0.147",
                    "inventory_tracking_indicator": null,
                    "inventory_customs_clearance": null,
                    "qualified_user_id": 3,
                    "product_description": "TAC78200K NANSA EVM 62 (TENSOPER 60 EH)--- prueba",
                    "invoice": "123456",
                    "serial": null,
                    "brand": null,
                    "entry_quantity": "1000",
                    "entry_quantity_product": "1000",
                    "typeProduct_id": 7,
                    "name_typeProduct": "Insumos",
                    "description_typeProduct": "Insumos",
                    "qualified_user_nit": "8020193394",
                    "qualified_user_name": "ADAMA ANDINA B.V SUCURSAL COLOMBIA.",
                    "decimal_values_precision": "4",
                    "product_id": 60,
                    "product_code": "TAC78200K",
                    "product_convertion_factor": "1",
                    "product_group": null,
                    "product_created_at": "2022-12-13 14:09:26",
                    "product_updated_at": "2022-12-13 14:09:26",
                    "subheading_code": "3402429000",
                    "subheading_assessment": "15",
                    "subheading_variable": 1,
                    "subheading_description": "JABON, AGENTES DE SUPERFICIE ORGANICOS, PREPARACIONES PARA LAVAR, PREPARACIONES LUBRICANTES, CERAS ARTIFICIALES, CERAS PREPARADAS, PRODUCTOS DE LIMPIEZA, VELAS Y ARTICULOS SIMILARES, PASTAS PARA MODELAR, CERAS PARA ODONTOLOGIA",
                    "subheading_subchapter": "",
                    "subheading_status": 1,
                    "business_unit_id": 15,
                    "business_unit_code": "KG",
                    "business_unit_name": "KILOGRAMO",
                    "product_business_unit_id": 5,
                    "product_business_unit_code": "KG",
                    "product_business_unit_name": "Kilogramo",
                    "freely_available_material": "No",
                    "customs_clearance_id": null,
                    "customs_clearance_code": null,
                    "customs_clearance_acceptance_number": null,
                    "type_product_id": 7,
                    "type_product": "Insumos",
                    "inventory_date_approved": "2023-03-28",
                    "inventory_value_fob_available": "0",
                    "inventory_value_cif_available": "0",
                    "inventory_temporary_net_weight": "0",
                    "inventory_precision": "4",
                    "net_weight_available": "0",
                    "fob_temporal": "0",
                    "fob_reserved": "0",
                    "cif_reserved": "0",
                    "cif_temporal": "147",
                    "quantity_authorize_temporal": "0",
                    "quantity_authorize_temporal_product": "0",
                    "net_weight_reserved": "0",
                    "inventory_quantity_reserved_input_product": "0",
                    "inventory_date_entry": null,
                    "inventory_count_entry": 0
                }
            ],
            "first_page_url": "https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/inventory/getInventory?page=1",
            "from": 1,
            "last_page": 1,
            "last_page_url": "https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/inventory/getInventory?page=1",
            "links": [
                {
                    "url": null,
                    "label": "« Anterior",
                    "active": false
                },
                {
                    "url": "https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/inventory/getInventory?page=1",
                    "label": "1",
                    "active": true
                },
                {
                    "url": null,
                    "label": "Siguiente »",
                    "active": false
                }
            ],
            "next_page_url": null,
            "path": "https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/inventory/getInventory",
            "per_page": 5,
            "prev_page_url": null,
            "to": 1,
            "total": 1
        }
    }
}

Donde cada objeto en el arreglo representa un elemento del inventario y contiene los siguientes campos:

Nota: Se describen los campos relevantes para la operación.

  • brand: [string] - marca del ítem (opcional)

  • business_unit_code: [string] - Unidad comercial de la subpartida

  • business_unit_name: [string] - Nombre de la unidad comercial

  • cif_reserved: [float] - Valor cif reservado

  • cif_temporal: [float] - Valor cif temporal

  • customs_clearance_acceptance_number: [string] - Número de la declaración de importación

  • customs_clearance_code: [number] - Código del formulario de desaduanamiento

  • decimal_values_precision: [number] - Precisión

  • description_typeProduct: [string] - Tipo de producto definido en el formulario de ingreso

  • entry_quantity: [float] - Cantidad ingresada del producto de acuerdo a la subpartida

  • entry_quantity_product: [float] - Cantidad ingresada del producto

  • fob_reserved: [float] - Valor fob reservado

  • fob_temporal: [float] - Valor fob temporal

  • freely_available_material: [string] - Campo que indica si está en libre disposición la mercancía

  • inventory_business_unit: [string] - Unidad medida del producto

  • inventory_count_entry: [number] - Cantidad de pases de entrada

  • inventory_customs_clearance: [string] - Número de declaración

  • inventory_date_approved: [date] - fecha de aprobación del formulario de ingreso

  • inventory_initial_operation: [number] - Código de operación

  • inventory_integration_certificate: [number] - código del formulario de certificado de integración

  • inventory_nature_of_inventory: [string] - naturaleza de la operación (EXT: extranjera, NAC, nacional, CDI, cuadro de integración).

  • inventory_net_weight_product_unit: [string] - Peso neto por unidad de producto

  • inventory_operation_code: [number] - Código de operación

  • inventory_precision:[number] - Precisión

  • inventory_quantity_available: [float] - Cantidad disponible de la subpartida

  • inventory_quantity_available_product: [float] - Cantidad disponible del producto

  • inventory_quantity_go_out: [float] - Cantidad de salida

  • inventory_quantity_go_out_product: [float] - Cantidad de salida del producto

  • inventory_quantity_reserved: [float] - Cantidad de reservada

  • inventory_quantity_reserved_input: [float] - Cantidad reseverda de entrada

  • inventory_quantity_reserved_input_product: [float] - Cantidad reservada de entrada del producto

  • inventory_quantity_reserved_product: [float] - Cantidad reservada del producto

  • inventory_quantity_reserved_product_input: [float] -

  • inventory_quantity_temporary: [float] - Cantidad temporal

  • inventory_quantity_temporary_product: [float] -Cantidad temporal del producto

  • inventory_quantity_total: [float] - Cantidad total

  • inventory_quantity_total_product: [float] - Cantidad total del producto

  • inventory_reference_description: [string] - Descripción de la referencia

  • inventory_temporary_net_weight: [float] - Peso neto temporal

  • inventory_third_party_name: [string] - Razón social del tercero

  • inventory_third_party_nit: [number] - Nit del tercero

  • inventory_tracking_indicator: [string] - Indicador de seguimiento

  • inventory_trade_agreement: [string] - Código del acuerdo comercial

  • inventory_value_cif_available: [float] - Valor cif disponible

  • inventory_value_cif_unit_product: [float] - valor cif disponible del producto

  • inventory_value_fob_available: [float] - valor fob disponible

  • inventory_value_fob_unit_product: [float] - valor fob disponible del producto

  • invoice: [string] - factura

  • net_weight_available: [float] - Peso neto disponible

  • net_weight_reserved: [float] - Peso neto reservado

  • quantity_authorize_temporal: [float] - Cantidad autorizada temporal

  • quantity_authorize_temporal_product: [float] - cantidad autorizada temporal del producto

  • serial: [striing] - serial del producto (campo opcional que se digita en el formulario de ingreso).

En caso de que no se encuentren elementos que coincidan con los parámetros de consulta, la respuesta será un arreglo vacío [].