> ## Documentation Index
> Fetch the complete documentation index at: https://doc.allcomtelecom.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Solicitar a geração do relatório do inventário

> Solicita a geração de um relatório do inventário



## OpenAPI

````yaml post /report/inventory
openapi: 3.0.1
info:
  title: OpenAPI Auth Store
  description: API de exemplo para demonstração de autenticação e obtenção de tokens.
  license:
    name: Allcom Telecom
  version: 1.0.0
servers:
  - url: >-
      https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1
security: []
paths:
  /report/inventory:
    servers:
      - url: >-
          https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1
        description: Solicita a geração de um relatório do inventário
    post:
      description: Solicita a geração de um relatório do inventário
      parameters:
        - name: Content-Type
          in: header
          required: true
          description: |-
            Define o formato da requisição.

            🔹 **Valor padrão:**
            ```
            application/json
            ```
            📌 **Dica:** Copie e cole esse valor no campo Content-Type.
          schema:
            type: string
            example: application/json
            default: application/json
        - name: client_id
          in: header
          required: true
          schema:
            type: string
            description: Identificador do client id do sensedia
            example: '123'
        - name: access_token
          in: header
          required: true
          schema:
            type: string
            description: Token gerado
            example: Basic MzQ4OSozNDMyLTMOMzItMTIz
      requestBody:
        description: Informações necessárias para fazer a solicitação do relatório.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  example: teste@gmail.com
                locale:
                  type: string
                  example: pt
                id:
                  type: integer
                  example: 0
                contractAssetNumber:
                  type: string
                  example: string
                showContracted:
                  type: boolean
                  example: true
                operator:
                  type: string
                  example: ALGAR TELECOM
                connectedOperator:
                  type: string
                  example: TIM
                subOperator:
                  type: string
                  example: ALGAR 3OP
                nickname:
                  type: string
                  example: Device nickname
                observation:
                  type: string
                  example: Observation about device
                msisdn:
                  type: array
                  example:
                    - '5516981818181'
                iccid:
                  type: array
                  example:
                    - '89553203000003920000'
                imsi:
                  type: array
                  example:
                    - '724373198034943'
                status:
                  type: string
                  example: ACTIVE
                stock:
                  type: boolean
                  example: true
                franchise:
                  type: integer
                  example: 20
                customerName:
                  type: string
                  example: Customer name
                customerDocumentNumber:
                  type: string
                  example: '351316040684'
                customerId:
                  type: integer
                  example: 15010
                online:
                  type: boolean
                  example: true
                city:
                  type: string
                  example: string
                state:
                  type: string
                  example: string
                postalCode:
                  type: string
                  example: string
                lastConnectionFrom:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                lastConnectionTo:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                consumptionPercentFrom:
                  type: number
                  example: 18.5
                consumptionPercentTo:
                  type: number
                  example: 83.5
                consumptionFrom:
                  type: integer
                  example: 18151355
                consumptionTo:
                  type: integer
                  example: 83344468486
                automaticBlocking:
                  type: boolean
                  example: true
                networkBlockStatus:
                  type: string
                  example: NONE
                blockedByDefault:
                  type: boolean
                  example: true
                accountId:
                  type: integer
                  example: 0
                accountDesc:
                  type: string
                  example: string
                loyaltyType:
                  type: integer
                  example: 0
                loyaltyTime:
                  type: integer
                  example: 0
                cancellationFeeFrom:
                  type: integer
                  example: 0
                cancellationFeeTo:
                  type: integer
                  example: 0
                activationPriceFrom:
                  type: integer
                  example: 0
                activationPriceTo:
                  type: integer
                  example: 0
                priceFrom:
                  type: integer
                  example: 0
                priceTo:
                  type: integer
                  example: 0
                megabyteExcPriceFrom:
                  type: integer
                  example: 0
                megabyteExcPriceTo:
                  type: integer
                  example: 0
                simcardCreditFrom:
                  type: integer
                  example: 0
                simcardCreditTo:
                  type: integer
                  example: 0
                tradeInMonths:
                  type: integer
                  example: 0
                preActivationDays:
                  type: integer
                  example: 0
                preActivationEndDateFrom:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                preActivationEndDateTo:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                sharingType:
                  type: string
                  example: NONE
                brokerContractId:
                  type: integer
                  example: 131351
                brokerContractDesc:
                  type: string
                  example: Shared contract ACDUEB123
                sharedContractCreditFrom:
                  type: integer
                  example: 5
                sharedContractCreditTo:
                  type: integer
                  example: 20
                sharedContractFranchiseFrom:
                  type: integer
                  example: 10
                sharedContractFranchiseTo:
                  type: integer
                  example: 20
                apn:
                  type: string
                  example: example.br
                hostname:
                  type: string
                  example: 172.217. 22.14
                technology:
                  type: string
                  example: 5G
                imei:
                  type: string
                  example: '516761813114869'
                imeiLocked:
                  type: boolean
                  example: true
                activationDateFrom:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                activationDateTo:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                cancellationDateFrom:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                cancellationDateTo:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                suspensionEligibility:
                  type: boolean
                  example: true
                suspensionStartDateFrom:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                suspensionStartDateTo:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                suspensionEndDateFrom:
                  type: string
                  example: '2025-08-11T17:33:27.358Z'
                suspensionEndDateTo:
                  type: string
                  example: '2025-08-11T17:33:27.359Z'
              required:
                - client_id
                - client_secret
      responses:
        '202':
          description: Request created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  Accepted:
                    type: string
                    example:
                      id: 56865
                      message: >-
                        Request created successfully! An email will be sent to:
                        thiago.moreira@eticasolucoes.com.br with the download
                        link
              example:
                id: 56865
                message: >-
                  Request created successfully! An email will be sent to:
                  thiago.moreira@eticasolucoes.com.br with the download link
        '400':
          description: Requisição mal formada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example:
                      errors: Parameter not found
              example:
                error: Requisição mal formada.
        '401':
          description: Requisição requer autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: Requisição requer autenticação.
        '403':
          description: O acesso ao recurso foi negado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: O acesso ao recurso foi negado.
        '404':
          description: URI de API/Recurso inexiste para processamento.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: URI de API/Recurso inexiste para processamento.
        '500':
          description: Erro Interno do servidor.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example:
                      errors: Parameter not found
              example:
                errors: Parameter not found

````