nf-produto-v2.ts

/**
 * ⚠️  AUTO-GENERATED from nf-produto-v2.yaml
 *
 * Do not edit this file directly.
 *
 * To regenerate: npm run generate
 * Last generated: 2026-01-19T23:42:06.094Z
 * Generator: openapi-typescript
 */

/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */


export type paths = {
  "/v2/companies": {
    /**
     * Consultar todas as Empresas da Conta
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para consultar os dados das empresas vinculadas a conta.
     */
    get: operations["V2CompaniesGet"];
    /**
     * Criar uma Empresa
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais.
     * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
     */
    post: operations["V2CompaniesPost"];
  };
  "/v2/companies/{company_id}": {
    /**
     * Consultar uma Empresa pelo ID
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para consultar os dados de uma empresas pelo ID.
     */
    get: operations["V2CompaniesByCompany_idGet"];
    /**
     * Alterar uma Empresa pelo ID
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para alterar os dados de uma empresas pelo ID.
     */
    put: operations["V2CompaniesByCompany_idPut"];
    /**
     * Excluir uma Empresa por ID
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível.
     */
    delete: operations["V2CompaniesByCompany_idDelete"];
  };
  "/v2/companies/{company_id}/certificates": {
    /**
     * Consultar um Certificado por seu Status
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através d0 **status do certificado** (__status__).
     */
    get: operations["V2CompaniesByCompany_idCertificatesGet"];
    /**
     * Upload de um Certificado
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo __e-CNPJ A1__ ou __NFE A1__ em uma **Empresa** e vincula-lo para processamentos.
     *
     * O **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web.
     */
    post: operations["V2CompaniesByCompany_idCertificatesPost"];
  };
  "/v2/companies/{company_id}/certificates/{certificate_thumbprint}": {
    /**
     * Consultar um Certificado por sua impressão digital
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__).
     */
    get: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet"];
    /**
     * Excluir um Certificado por sua impressão digital
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**.
     *
     * **ATENÇÃO pois esta requisição é irreversível**
     */
    delete: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete"];
  };
  "/v2/companies/{company_id}/statetaxes": {
    /**
     * Listar as Inscrições Estaduais
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__.
     * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
     * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
     */
    get: operations["V2CompaniesByCompany_idStatetaxesGet"];
    /**
     * Criar uma Inscrição Estadual
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__.
     * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
     * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
     */
    post: operations["V2CompaniesByCompany_idStatetaxesPost"];
  };
  "/v2/companies/{company_id}/statetaxes/{state_tax_id}": {
    /**
     * Consultar uma Inscrição Estadual pelo ID
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para consultar os dados de uma empresas pelo ID.
     * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
     * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
     */
    get: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idGet"];
    /**
     * Alterar uma Inscrição Estadual pelo ID
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID.
     * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
     * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
     */
    put: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idPut"];
    /**
     * Excluir uma Inscrição Estadual pelo ID
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível.
     * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
     * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
     */
    delete: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idDelete"];
  };
  "/v2/companies/{companyId}/productinvoices": {
    /**
     * Listar as Notas Fiscais Eletrônicas (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar uma lista de notas fiscais eletrônicas por empresa.
     */
    get: {
      parameters: {
        query: {
          /** @description Tipo de Ambiente é obrigatório (Production or Test) */
          environment: components["schemas"]["EnvironmentType"];
          /** @description Id de início do contador (Default: Empty) */
          startingAfter?: string;
          /** @description Id de fim do contador (Default: Empty) */
          endingBefore?: string;
          /**
           * @description Buscar por parâmetros. ("ElasticSearch string query") Ex: (q=buyer.name:'EMPRESA LTDA'). Saiba mais
           * em: https://nfe.io/docs/nota-fiscal-eletronica/integracao-api/consulta-elasticsearch
           */
          q?: string;
          /** @description Limite de resultados na página (Default: 10) */
          limit?: number;
        };
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta em lista */
        200: {
          content: {
            readonly "application/json": components["schemas"]["ProductInvoicesResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
    /**
     * Emitir uma Nota Fiscal Eletrônica (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de emissão.
     * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo
     * não garante a emissão do documento fiscal.
     * Para obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos
     * utilizar os WebHooks.
     */
    post: {
      parameters: {
        path: {
          /** @description Empresa ID */
          companyId: string;
        };
      };
      /** @description Dados da nota fiscal a ser emitida */
      readonly requestBody?: {
        readonly content: {
          readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "text/json": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "application/*+json": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "application/xml": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "text/xml": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "application/*+xml": components["schemas"]["ProductInvoiceQueueIssueResource"];
        };
      };
      responses: {
        /** @description Sucesso ao enfileirar para emissão */
        202: {
          content: {
            readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}": {
    /**
     * Consultar por ID uma Nota Fiscal Eletrônica (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID.
     */
    get: {
      parameters: {
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal Eletrônica que deverá ser retornada */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta */
        200: {
          content: {
            readonly "application/json": components["schemas"]["InvoiceResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
    /**
     * Cancelar uma Nota Fiscal Eletrônica (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de cancelamento.
     * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo
     * não garante o cancelamento do documento fiscal.
     * Para obter um retorno ao final do processo de cancelamento de uma Nota Fiscal Eletrônica (NFe),
     * recomendamos utilizar os WebHooks.
     */
    delete: {
      parameters: {
        query?: {
          /** @description Motivo do cancelamento */
          reason?: string;
        };
        path: {
          /** @description Empresa ID */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser cancelada */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso ao enfileirar para cancelamento */
        204: {
          content: {
            readonly "application/json": components["schemas"]["RequestCancellationResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/items": {
    /**
     * Consultar os produtos por ID uma Nota Fiscal Eletrônica (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID.
     */
    get: {
      parameters: {
        query?: {
          /** @description Limite de resultados na página (Default: 10) */
          limit?: number;
          /** @description Índice de início do contador (Default: 0) */
          startingAfter?: number;
        };
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal Eletrônica que deverá ser retornada */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta */
        200: {
          content: {
            readonly "application/json": components["schemas"]["InvoiceItemsResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/events": {
    /**
     * Consultar eventos por ID uma Nota Fiscal Eletrônica (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID.
     */
    get: {
      parameters: {
        query?: {
          /** @description Limite de resultados na página (Default: 10) */
          limit?: number;
          /** @description Índice de início do contador (Default: 0) */
          startingAfter?: number;
        };
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal Eletrônica que deverá ser retornada */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta */
        200: {
          content: {
            readonly "application/json": components["schemas"]["ProductInvoiceEventsResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/pdf": {
    /**
     * Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal Eletrônica (DANFE)
     * em formato de arquivo PDF.
     */
    get: {
      parameters: {
        query?: {
          /** @description Força a geração do pdf independente do FlowStatus */
          force?: boolean;
        };
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser retornado */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta do DANFE */
        200: {
          content: {
            readonly "application/json": components["schemas"]["FileResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml": {
    /**
     * Consultar XML da Nota Fiscal Eletrônica (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar os dados de uma nota fiscal Eletrônica pelo ID.
     */
    get: {
      parameters: {
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser retornado */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta do XML da NFE */
        200: {
          content: {
            readonly "application/json": components["schemas"]["FileResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml/rejection": {
    /**
     * Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar o motivo da rejeição de uma nota fiscal Eletrônica pelo ID.
     */
    get: {
      parameters: {
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser retornado */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta do XML da NFE */
        200: {
          content: {
            readonly "application/json": components["schemas"]["FileResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml-rejection": {
    /**
     * Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar o motivo da rejeição de uma nota fiscal Eletrônica pelo ID.
     */
    get: {
      parameters: {
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser retornado */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta do XML da NFE */
        200: {
          content: {
            readonly "application/json": components["schemas"]["FileResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml-epec": {
    /** Consultar XML da autorização em contingência (EPEC) */
    get: {
      parameters: {
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser retornado */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta do XML da NFE */
        200: {
          content: {
            readonly "application/json": components["schemas"]["FileResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter": {
    /**
     * Enviar uma carta de correção para Nota Fiscal Eletrônica (CC-e)
     * @description ### Informações adicionais
     * Utilize esta requisição para enviar uma carta de correção na Nota Fiscal Eletrônica (NFE).
     * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo
     * não garante a execução do documento fiscal.
     * Para obter um retorno ao final do processo de carta de correção de uma Nota Fiscal Eletrônica (NFe),
     * recomendamos utilizar os WebHooks.
     */
    put: {
      parameters: {
        path: {
          /** @description Empresa ID */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser cancelada */
          invoiceId: string;
        };
      };
      readonly requestBody?: {
        readonly content: {
          readonly "application/json": components["schemas"]["QueueEventResource"];
          readonly "text/json": components["schemas"]["QueueEventResource"];
          readonly "application/*+json": components["schemas"]["QueueEventResource"];
          readonly "application/xml": components["schemas"]["QueueEventResource"];
          readonly "text/xml": components["schemas"]["QueueEventResource"];
          readonly "application/*+xml": components["schemas"]["QueueEventResource"];
        };
      };
      responses: {
        /** @description Sucesso ao enfileirar para cancelamento */
        204: {
          content: {
            readonly "application/json": components["schemas"]["RequestCancellationResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/pdf": {
    /**
     * Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) de Carta de Correção (CC-e)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal Eletrônica (DANFE)
     * em formato de arquivo PDF.
     */
    get: {
      parameters: {
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser retornado */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta do DANFE */
        200: {
          content: {
            readonly "application/json": components["schemas"]["FileResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/xml": {
    /**
     * Consultar XML da Carta de Correção Eletrônica (CC-e)
     * @description ### Informações adicionais
     * Utilize esta requisição para consultar os dados da carta de correção de uma nota fiscal Eletrônica pelo ID.
     */
    get: {
      parameters: {
        path: {
          /** @description ID da Empresa que deverá ser retornado */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser retornado */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso na consulta do XML da NFE */
        200: {
          content: {
            readonly "application/json": components["schemas"]["FileResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/{invoiceId}/disablement": {
    /**
     * Inutilizar uma Nota Fiscal Eletrônica (NFE)
     * @description ### Informações adicionais
     * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de inutilização.
     * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo
     * não garante a inutilização do documento fiscal.
     * Para obter um retorno ao final do processo de inutilização de uma Nota Fiscal Eletrônica (NFe),
     * recomendamos utilizar os WebHooks.
     */
    post: {
      parameters: {
        query?: {
          /** @description Motivo da inutilização */
          reason?: string;
        };
        path: {
          /** @description Empresa ID */
          companyId: string;
          /** @description ID da Nota Fiscal que deverá ser inutilizada */
          invoiceId: string;
        };
      };
      responses: {
        /** @description Sucesso ao enfileirar para inutilização */
        204: {
          content: {
            readonly "application/json": components["schemas"]["RequestCancellationResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/productinvoices/disablement": {
    /**
     * Inutilizar números de nota fiscal
     * @description ### Informações adicionais
     * Caso seja um único número, utilizar o Número inicial e o Número final com o mesmo valor
     */
    post: {
      parameters: {
        path: {
          /** @description ID da Empresa */
          companyId: string;
        };
      };
      readonly requestBody?: {
        readonly content: {
          readonly "application/json": components["schemas"]["DisablementResource"];
          readonly "text/json": components["schemas"]["DisablementResource"];
          readonly "application/*+json": components["schemas"]["DisablementResource"];
          readonly "application/xml": components["schemas"]["DisablementResource"];
          readonly "text/xml": components["schemas"]["DisablementResource"];
          readonly "application/*+xml": components["schemas"]["DisablementResource"];
        };
      };
      responses: {
        /** @description Sucesso */
        200: {
          content: {
            readonly "application/json": components["schemas"]["DisablementResource"];
          };
        };
        /** @description Algum parâmetro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Nota Fiscal Eletrônica não encontrada */
        404: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/companies/{companyId}/statetaxes/{statetaxId}/productinvoices": {
    /**
     * Emitir uma Nota Fiscal Eletrônica (NFE) Informando um StateTaxId
     * @description ### Informações adicionais
     * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de emissão.
     * **ATENÇÃO**: Cada processamento será feito de forma assíncrona, ou seja, o retorno positivo
     * não garante a emissão do documento fiscal.
     * Para obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos
     * utilizar os WebHooks.
     */
    post: {
      parameters: {
        path: {
          /** @description Empresa ID */
          companyId: string;
          /** @description Inscrição Estadual(StateTax) ID */
          statetaxId: string;
        };
      };
      /** @description Dados da nota fiscal a ser emitida */
      readonly requestBody?: {
        readonly content: {
          readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "text/json": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "application/*+json": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "application/xml": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "text/xml": components["schemas"]["ProductInvoiceQueueIssueResource"];
          readonly "application/*+xml": components["schemas"]["ProductInvoiceQueueIssueResource"];
        };
      };
      responses: {
        /** @description Sucesso ao enfileirar para emissão */
        202: {
          content: {
            readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"];
          };
        };
        /** @description Algum parametro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Tempo limite de 60s excedido no enfileiramento */
        408: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
        /** @description Erro no processamento */
        500: {
          content: {
            readonly "application/json": components["schemas"]["ErrorsResource"];
          };
        };
      };
    };
  };
  "/v2/webhooks/eventtypes": {
    /**
     * Listar os Tipos de Eventos gerados pela plataforma
     * @description ### Informações adicionais
     *
     * Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados
     * criando notificações para os webhooks ativos e configurados para receber os eventos.
     *
     * São identificados seguindo o padrão **Resource.EventAction**,
     * onde **Resource**: nome da entidade que gerou o evento;
     * **EventAction**: nome do evento e ação criados.
     *
     * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook,
     * sendo que o filtro determina quais notificações de eventos e ação serão enviadas
     * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook
     * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros.
     */
    get: {
      responses: {
        /** @description Sucesso na consulta do tipos de eventos */
        200: {
          content: {
            readonly "application/json": {
              /** @description Lista de Evento */
              readonly eventTypes?: readonly ({
                  /**
                   * @description Identificador do evento, seguem o padrão **Resource.EventAction**.
                   * Onde **Resource**: nome da entidade que gerou o evento;
                   * **EventAction**: nome do evento e ação criados.
                   * Alguns exemplos **Invoice.Issued** ou **Blob.Updated**
                   */
                  readonly id?: string;
                  /** @description Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. */
                  readonly description?: string;
                  /**
                   * Format: int32
                   * @description WebHook Filter Status
                   * @enum {integer}
                   */
                  readonly status?: 0 | 1;
                })[];
            };
          };
        };
        /** @description Erro no processamento */
        500: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
      };
    };
  };
  "/v2/webhooks": {
    /**
     * Listar os Webhooks
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada.
     */
    get: {
      responses: {
        /** @description Sucesso na consulta da lista */
        200: {
          content: {
            readonly "application/json": {
              /** @description Lista de Web Hook */
              readonly webHooks?: readonly ({
                  /**
                   * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de
                   * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID.
                   */
                  readonly id?: string;
                  /** @description A URL onde as notificações dos eventos deverão entregues. */
                  readonly uri: string;
                  /**
                   * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
                   * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
                   * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
                   */
                  readonly secret?: string;
                  /**
                   * Format: int32
                   * @description WebHook Media Type
                   * @enum {integer}
                   */
                  readonly contentType?: 0 | 1;
                  /**
                   * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
                   * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
                   */
                  readonly insecureSsl?: boolean;
                  /**
                   * Format: int32
                   * @description WebHook Status
                   * @enum {integer}
                   */
                  readonly status?: 0 | 1;
                  /**
                   * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
                   * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
                   * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
                   */
                  readonly filters?: readonly string[];
                  /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
                  readonly headers?: {
                    [key: string]: string;
                  };
                  /**
                   * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
                   * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
                   */
                  readonly properties?: {
                    [key: string]: Record<string, never>;
                  };
                  /**
                   * Format: date-time
                   * @description Data de criação do webhook
                   */
                  readonly createdOn?: string;
                  /**
                   * Format: date-time
                   * @description Data de modificação do webhook
                   */
                  readonly modifiedOn?: string;
                })[];
            };
          };
        };
        /** @description Algum parametro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
        /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
        401: {
          content: {
          };
        };
        /** @description Accesso proibido */
        403: {
          content: {
          };
        };
        /** @description Erro no processamento */
        500: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
      };
    };
    /**
     * Criar um Webhook
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma.
     *
     * Na criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada.
     *
     * Um **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura*
     * que permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas.
     * Um **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos
     * que podem ser acionados por eventos gerados através de ações executadas por esse Conta.
     * Ou seja, a **Conta da _Empresa A_** não verá os WebHooks disparados por uma ação executada pelo usuário **Conta da _Empresa B_**.
     */
    post: {
      readonly requestBody?: {
        readonly content: {
          readonly "application/json-patch+json": {
            /** @description Dados para criar um Web Hook */
            readonly webHook?: {
              /** @description A URL onde as notificações dos eventos deverão entregues. */
              readonly uri: string;
              /**
               * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
               * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
               * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
               */
              readonly secret?: string;
              /**
               * Format: int32
               * @description WebHook Media Type
               * @enum {integer}
               */
              readonly contentType?: 0 | 1;
              /**
               * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
               * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
               */
              readonly insecureSsl?: boolean;
              /**
               * Format: int32
               * @description WebHook Status
               * @enum {integer}
               */
              readonly status?: 0 | 1;
              /**
               * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
               * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
               * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
               */
              readonly filters?: readonly string[];
              /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
              readonly headers?: {
                [key: string]: string;
              };
              /**
               * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
               * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
               */
              readonly properties?: {
                [key: string]: Record<string, never>;
              };
              /**
               * Format: date-time
               * @description Data de criação do webhook
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação do webhook
               */
              readonly modifiedOn?: string;
            };
          };
          readonly "application/json": {
            /** @description Dados para criar um Web Hook */
            readonly webHook?: {
              /** @description A URL onde as notificações dos eventos deverão entregues. */
              readonly uri: string;
              /**
               * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
               * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
               * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
               */
              readonly secret?: string;
              /**
               * Format: int32
               * @description WebHook Media Type
               * @enum {integer}
               */
              readonly contentType?: 0 | 1;
              /**
               * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
               * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
               */
              readonly insecureSsl?: boolean;
              /**
               * Format: int32
               * @description WebHook Status
               * @enum {integer}
               */
              readonly status?: 0 | 1;
              /**
               * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
               * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
               * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
               */
              readonly filters?: readonly string[];
              /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
              readonly headers?: {
                [key: string]: string;
              };
              /**
               * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
               * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
               */
              readonly properties?: {
                [key: string]: Record<string, never>;
              };
              /**
               * Format: date-time
               * @description Data de criação do webhook
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação do webhook
               */
              readonly modifiedOn?: string;
            };
          };
          readonly "text/json": {
            /** @description Dados para criar um Web Hook */
            readonly webHook?: {
              /** @description A URL onde as notificações dos eventos deverão entregues. */
              readonly uri: string;
              /**
               * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
               * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
               * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
               */
              readonly secret?: string;
              /**
               * Format: int32
               * @description WebHook Media Type
               * @enum {integer}
               */
              readonly contentType?: 0 | 1;
              /**
               * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
               * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
               */
              readonly insecureSsl?: boolean;
              /**
               * Format: int32
               * @description WebHook Status
               * @enum {integer}
               */
              readonly status?: 0 | 1;
              /**
               * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
               * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
               * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
               */
              readonly filters?: readonly string[];
              /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
              readonly headers?: {
                [key: string]: string;
              };
              /**
               * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
               * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
               */
              readonly properties?: {
                [key: string]: Record<string, never>;
              };
              /**
               * Format: date-time
               * @description Data de criação do webhook
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação do webhook
               */
              readonly modifiedOn?: string;
            };
          };
          readonly "application/*+json": {
            /** @description Dados para criar um Web Hook */
            readonly webHook?: {
              /** @description A URL onde as notificações dos eventos deverão entregues. */
              readonly uri: string;
              /**
               * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
               * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
               * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
               */
              readonly secret?: string;
              /**
               * Format: int32
               * @description WebHook Media Type
               * @enum {integer}
               */
              readonly contentType?: 0 | 1;
              /**
               * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
               * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
               */
              readonly insecureSsl?: boolean;
              /**
               * Format: int32
               * @description WebHook Status
               * @enum {integer}
               */
              readonly status?: 0 | 1;
              /**
               * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
               * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
               * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
               */
              readonly filters?: readonly string[];
              /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
              readonly headers?: {
                [key: string]: string;
              };
              /**
               * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
               * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
               */
              readonly properties?: {
                [key: string]: Record<string, never>;
              };
              /**
               * Format: date-time
               * @description Data de criação do webhook
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação do webhook
               */
              readonly modifiedOn?: string;
            };
          };
        };
      };
      responses: {
        /** @description Sucesso na criação da webhook */
        201: {
          content: {
            readonly "application/json": {
              /** @description WebHook (Notificação HTTP) */
              readonly webHook?: {
                /**
                 * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de
                 * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID.
                 */
                readonly id?: string;
                /** @description A URL onde as notificações dos eventos deverão entregues. */
                readonly uri: string;
                /**
                 * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
                 * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
                 * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
                 */
                readonly secret?: string;
                /**
                 * Format: int32
                 * @description WebHook Media Type
                 * @enum {integer}
                 */
                readonly contentType?: 0 | 1;
                /**
                 * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
                 * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
                 */
                readonly insecureSsl?: boolean;
                /**
                 * Format: int32
                 * @description WebHook Status
                 * @enum {integer}
                 */
                readonly status?: 0 | 1;
                /**
                 * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
                 * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
                 * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
                 */
                readonly filters?: readonly string[];
                /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
                readonly headers?: {
                  [key: string]: string;
                };
                /**
                 * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
                 * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
                 */
                readonly properties?: {
                  [key: string]: Record<string, never>;
                };
                /**
                 * Format: date-time
                 * @description Data de criação do webhook
                 */
                readonly createdOn?: string;
                /**
                 * Format: date-time
                 * @description Data de modificação do webhook
                 */
                readonly modifiedOn?: string;
              };
            };
          };
        };
        /** @description Algum parametro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
        /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
        401: {
          content: {
          };
        };
        /** @description Accesso proibido */
        403: {
          content: {
          };
        };
        /** @description Webhook não encontrado */
        404: {
          content: {
          };
        };
        /** @description Erro no processamento */
        500: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
      };
    };
    /**
     * Excluir Todos os Webhooks existentes
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada.
     */
    delete: {
      responses: {
        /** @description Sucesso na exclusão dos WebHooks */
        204: {
          content: {
          };
        };
        /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
        401: {
          content: {
          };
        };
        /** @description Accesso proibido */
        403: {
          content: {
          };
        };
        /** @description Erro no processamento */
        500: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
      };
    };
  };
  "/v2/webhooks/{webhook_id}": {
    /**
     * Consultar um webhook existente
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**.
     */
    get: operations["RegistrationLookupAction"];
    /**
     * Alterar um Webhook existente
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado.
     */
    put: {
      parameters: {
        path: {
          /** @description ID do Webhook a ser atualizado */
          webhook_id: string;
        };
      };
      /** @description Dados para alterar o Webhook */
      readonly requestBody?: {
        readonly content: {
          readonly "application/json-patch+json": {
            /** @description WebHook (Notificação HTTP) */
            readonly webHook?: {
              /**
               * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de
               * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID.
               */
              readonly id?: string;
              /** @description A URL onde as notificações dos eventos deverão entregues. */
              readonly uri: string;
              /**
               * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
               * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
               * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
               */
              readonly secret?: string;
              /**
               * Format: int32
               * @description WebHook Media Type
               * @enum {integer}
               */
              readonly contentType?: 0 | 1;
              /**
               * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
               * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
               */
              readonly insecureSsl?: boolean;
              /**
               * Format: int32
               * @description WebHook Status
               * @enum {integer}
               */
              readonly status?: 0 | 1;
              /**
               * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
               * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
               * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
               */
              readonly filters?: readonly string[];
              /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
              readonly headers?: {
                [key: string]: string;
              };
              /**
               * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
               * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
               */
              readonly properties?: {
                [key: string]: Record<string, never>;
              };
              /**
               * Format: date-time
               * @description Data de criação do webhook
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação do webhook
               */
              readonly modifiedOn?: string;
            };
          };
          readonly "application/json": {
            /** @description WebHook (Notificação HTTP) */
            readonly webHook?: {
              /**
               * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de
               * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID.
               */
              readonly id?: string;
              /** @description A URL onde as notificações dos eventos deverão entregues. */
              readonly uri: string;
              /**
               * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
               * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
               * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
               */
              readonly secret?: string;
              /**
               * Format: int32
               * @description WebHook Media Type
               * @enum {integer}
               */
              readonly contentType?: 0 | 1;
              /**
               * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
               * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
               */
              readonly insecureSsl?: boolean;
              /**
               * Format: int32
               * @description WebHook Status
               * @enum {integer}
               */
              readonly status?: 0 | 1;
              /**
               * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
               * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
               * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
               */
              readonly filters?: readonly string[];
              /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
              readonly headers?: {
                [key: string]: string;
              };
              /**
               * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
               * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
               */
              readonly properties?: {
                [key: string]: Record<string, never>;
              };
              /**
               * Format: date-time
               * @description Data de criação do webhook
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação do webhook
               */
              readonly modifiedOn?: string;
            };
          };
          readonly "text/json": {
            /** @description WebHook (Notificação HTTP) */
            readonly webHook?: {
              /**
               * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de
               * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID.
               */
              readonly id?: string;
              /** @description A URL onde as notificações dos eventos deverão entregues. */
              readonly uri: string;
              /**
               * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
               * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
               * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
               */
              readonly secret?: string;
              /**
               * Format: int32
               * @description WebHook Media Type
               * @enum {integer}
               */
              readonly contentType?: 0 | 1;
              /**
               * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
               * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
               */
              readonly insecureSsl?: boolean;
              /**
               * Format: int32
               * @description WebHook Status
               * @enum {integer}
               */
              readonly status?: 0 | 1;
              /**
               * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
               * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
               * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
               */
              readonly filters?: readonly string[];
              /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
              readonly headers?: {
                [key: string]: string;
              };
              /**
               * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
               * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
               */
              readonly properties?: {
                [key: string]: Record<string, never>;
              };
              /**
               * Format: date-time
               * @description Data de criação do webhook
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação do webhook
               */
              readonly modifiedOn?: string;
            };
          };
          readonly "application/*+json": {
            /** @description WebHook (Notificação HTTP) */
            readonly webHook?: {
              /**
               * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de
               * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID.
               */
              readonly id?: string;
              /** @description A URL onde as notificações dos eventos deverão entregues. */
              readonly uri: string;
              /**
               * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
               * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
               * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
               */
              readonly secret?: string;
              /**
               * Format: int32
               * @description WebHook Media Type
               * @enum {integer}
               */
              readonly contentType?: 0 | 1;
              /**
               * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
               * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
               */
              readonly insecureSsl?: boolean;
              /**
               * Format: int32
               * @description WebHook Status
               * @enum {integer}
               */
              readonly status?: 0 | 1;
              /**
               * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
               * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
               * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
               */
              readonly filters?: readonly string[];
              /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
              readonly headers?: {
                [key: string]: string;
              };
              /**
               * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
               * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
               */
              readonly properties?: {
                [key: string]: Record<string, never>;
              };
              /**
               * Format: date-time
               * @description Data de criação do webhook
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação do webhook
               */
              readonly modifiedOn?: string;
            };
          };
        };
      };
      responses: {
        /** @description Sucesso na atualização da Webhook */
        200: {
          content: {
            readonly "application/json": {
              /** @description WebHook (Notificação HTTP) */
              readonly webHook?: {
                /**
                 * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de
                 * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID.
                 */
                readonly id?: string;
                /** @description A URL onde as notificações dos eventos deverão entregues. */
                readonly uri: string;
                /**
                 * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
                 * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
                 * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
                 */
                readonly secret?: string;
                /**
                 * Format: int32
                 * @description WebHook Media Type
                 * @enum {integer}
                 */
                readonly contentType?: 0 | 1;
                /**
                 * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
                 * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
                 */
                readonly insecureSsl?: boolean;
                /**
                 * Format: int32
                 * @description WebHook Status
                 * @enum {integer}
                 */
                readonly status?: 0 | 1;
                /**
                 * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
                 * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
                 * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
                 */
                readonly filters?: readonly string[];
                /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
                readonly headers?: {
                  [key: string]: string;
                };
                /**
                 * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
                 * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
                 */
                readonly properties?: {
                  [key: string]: Record<string, never>;
                };
                /**
                 * Format: date-time
                 * @description Data de criação do webhook
                 */
                readonly createdOn?: string;
                /**
                 * Format: date-time
                 * @description Data de modificação do webhook
                 */
                readonly modifiedOn?: string;
              };
            };
          };
        };
        /** @description Algum parametro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
        /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
        401: {
          content: {
          };
        };
        /** @description Accesso proibido */
        403: {
          content: {
          };
        };
        /** @description Webhook não encontrado */
        404: {
          content: {
          };
        };
        /** @description Erro no processamento */
        500: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
      };
    };
    /**
     * Excluir um Webhook existente
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado.
     * A exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos.
     */
    delete: {
      parameters: {
        path: {
          /** @description ID do Webhook a ser excluído */
          webhook_id: string;
        };
      };
      responses: {
        /** @description Sucesso na exclusão da Webhook */
        204: {
          content: {
          };
        };
        /** @description Algum parametro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
        /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
        401: {
          content: {
          };
        };
        /** @description Accesso proibido */
        403: {
          content: {
          };
        };
        /** @description Webhook não encontrado */
        404: {
          content: {
          };
        };
        /** @description Erro no processamento */
        500: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
      };
    };
  };
  "/v2/webhooks/{webhook_id}/pings": {
    /**
     * Criar notificação para Testar um webhook
     * @description ### Informações adicionais
     *
     * Utilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado.
     *
     * Esta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado.
     */
    put: {
      parameters: {
        path: {
          /** @description ID do Webhook a ser testado */
          webhook_id: string;
        };
      };
      responses: {
        /** @description Sucesso ao criar notificação de teste */
        204: {
          content: {
          };
        };
        /** @description Algum parametro informado não é válido, verificar resposta */
        400: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
        /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
        401: {
          content: {
          };
        };
        /** @description Accesso proibido */
        403: {
          content: {
          };
        };
        /** @description Webhook não encontrado */
        404: {
          content: {
          };
        };
        /** @description Erro no processamento */
        500: {
          content: {
            readonly "application/json": {
              /** @description Lista de Erros */
              readonly errors?: readonly {
                  /**
                   * Format: int32
                   * @description Código do erro
                   */
                  readonly code?: number;
                  /** @description Mensagem contendo os detalhes do erro */
                  readonly message?: string;
                }[];
            };
          };
        };
      };
    };
  };
};

export type webhooks = Record<string, never>;

export type components = {
  schemas: {
    readonly ActivityResource: {
      /** @description Detalhes do Evento */
      readonly data?: unknown;
      /** @description Nome do Evento gerado */
      readonly type?: string | null;
      /**
       * Format: int32
       * @description Número sequencial do Evento
       */
      readonly sequence?: number | null;
    };
    /** @description Adições (adi) */
    readonly AdditionResource: {
      /**
       * Format: int64
       * @description Numero da adição (nAdicao)
       */
      readonly code?: number | null;
      /** @description Código do fabricante estrangeiro (cFabricante) */
      readonly manufacturer?: string | null;
      /**
       * Format: double
       * @description Valor do desconto do item da DI – Adição (vDescDI)
       */
      readonly amount?: number | null;
      /**
       * Format: int64
       * @description Número do ato concessório de Drawback (nDraw)
       */
      readonly drawback?: number | null;
    };
    readonly AdditionalInformationResource: {
      /** @description Informações Adicionais de Interesse do Fisco (infAdFisco) */
      readonly fisco?: string | null;
      /** @description Informações Complementares de interesse do Contribuinte (infCpl) */
      readonly taxpayer?: string | null;
      /** @description Informações Complementares de interesse do Contribuinte (infCpl) */
      readonly xmlAuthorized?: (readonly number[]) | null;
      readonly effort?: string | null;
      readonly order?: string | null;
      readonly contract?: string | null;
      /** @description Documentos Fiscais Referenciados (refECF) */
      readonly taxDocumentsReference?: (readonly components["schemas"]["TaxDocumentsReferenceResource"][]) | null;
      /** @description Observações fiscais (obsCont) */
      readonly taxpayerComments?: (readonly components["schemas"]["TaxpayerCommentsResource"][]) | null;
      /** @description Processos referenciados (procRef) */
      readonly referencedProcess?: (readonly components["schemas"]["ReferencedProcessResource"][]) | null;
    };
    /** @description Dados do Endereço */
    readonly AddressResource: {
      /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
      readonly state?: string | null;
      readonly city?: components["schemas"]["CityResource"];
      /** @description Bairro do Endereço */
      readonly district?: string | null;
      /** @description Complemento do Endereço, ex.: AP 2, BL A. */
      readonly additionalInformation?: string | null;
      /** @description Logradouro do Endereço */
      readonly street?: string | null;
      /** @description Número do Endereço. Usar S/N para "sem número". */
      readonly number?: string | null;
      /** @description Cód. Endereço Postal (CEP) */
      readonly postalCode?: string | null;
      /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
      readonly country?: string | null;
      /** @description Telefone */
      readonly phone?: string | null;
    };
    readonly AuthorizationResource: {
      /** Format: date-time */
      readonly receiptOn?: string | null;
      readonly accessKey?: string | null;
      readonly message?: string | null;
    };
    readonly BillResource: {
      /** @description Número da Fatura (nFat) */
      readonly number?: string | null;
      /**
       * Format: double
       * @description Valor Original da Fatura (vOrig)
       */
      readonly originalAmount?: number | null;
      /**
       * Format: double
       * @description Valor do desconto (vDesc)
       */
      readonly discountAmount?: number | null;
      /**
       * Format: double
       * @description Valor Líquido da Fatura (vLiq)
       */
      readonly netAmount?: number | null;
    };
    readonly BillingResource: {
      readonly bill?: components["schemas"]["BillResource"];
      /** @description Grupo Duplicata (dup) */
      readonly duplicates?: (readonly components["schemas"]["DuplicateResource"][]) | null;
    };
    /**
     * @description Manual_de_Orientação_Contribuinte_v_5.00
     * Grupo de endereço do Destinatário da NF-e
     */
    readonly BuyerResource: {
      /** @description Identificador da Conta */
      readonly accountId?: string | null;
      /** @description Identificação */
      readonly id?: string | null;
      /** @description Nome ou Razão Social (xNome) */
      readonly name?: string | null;
      /**
       * Format: int64
       * @description CNPJ ou CPF
       */
      readonly federalTaxNumber?: number | null;
      /** @description Email */
      readonly email?: string | null;
      readonly address?: components["schemas"]["AddressResource"];
      readonly type?: components["schemas"]["PersonType"];
      readonly stateTaxNumberIndicator?: components["schemas"]["ReceiverStateTaxIndicator"];
      /** @description Nome fantasia */
      readonly tradeName?: string | null;
      readonly taxRegime?: components["schemas"]["TaxRegime"];
      /** @description Inscrição Estadual (IE) */
      readonly stateTaxNumber?: string | null;
    };
    readonly CIDEResource: {
      /**
       * Format: double
       * @description BC da CIDE (qBCProd)
       */
      readonly bc?: number | null;
      /**
       * Format: double
       * @description Valor da alíquota da CIDE (vAliqProd)
       */
      readonly rate?: number | null;
      /**
       * Format: double
       * @description Valor da CIDE (vCIDE)
       */
      readonly cideAmount?: number | null;
    };
    readonly CardResource: {
      /** @description CNPJ da Credenciadora de cartão de crédito e/ou débito (CNPJ) */
      readonly federalTaxNumber?: string | null;
      readonly flag?: components["schemas"]["FlagCard"];
      /** @description Número de autorização da operação cartão de crédito e/ou débito (cAut) */
      readonly authorization?: string | null;
      readonly integrationPaymentType?: components["schemas"]["IntegrationPaymentType"];
      /** @description CNPJ do beneficiário do pagamento (CNPJReceb) */
      readonly federalTaxNumberRecipient?: string | null;
      /** @description Identificador do terminal de pagamento (idTermPag) */
      readonly idPaymentTerminal?: string | null;
    };
    readonly CityResource: {
      /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
      readonly code?: string | null;
      /** @description Nome do Município */
      readonly name?: string | null;
    };
    /**
     * @description Grupo do COFINS
     *
     * ID: S01
     * Pai: M01
     *
     *     Obs: Informar apenas um dos grupos S02, S03, S04 ou S04
     *     com base valor atribuído ao campo S06 – CST do COFINS
     */
    readonly CofinsTaxResource: {
      /** @description Código de Situação Tributária da COFINS */
      readonly cst?: string | null;
      /**
       * Format: double
       * @description Valor da Base de Cálculo da COFINS (vBC)
       */
      readonly baseTax?: number | null;
      /**
       * Format: double
       * @description Alíquota da COFINS (em percentual) (pCOFINS)
       */
      readonly rate?: number | null;
      /**
       * Format: double
       * @description Valor da COFINS (vCOFINS)
       */
      readonly amount?: number | null;
      /**
       * Format: double
       * @description Quantidade Vendida (qBCProd)
       */
      readonly baseTaxProductQuantity?: number | null;
      /**
       * Format: double
       * @description Alíquota da COFINS (em reais) (vAliqProd)
       */
      readonly productRate?: number | null;
    };
    /**
     * @description Indicador de Presença (indPres )
     * @enum {string}
     */
    readonly ConsumerPresenceType: "None" | "Presence" | "Internet" | "Telephone" | "Delivery" | "OthersNonPresenceOperation";
    /**
     * @description Indica operação com Consumidor final (indFinal)
     * @enum {string}
     */
    readonly ConsumerType: "FinalConsumer" | "Normal";
    readonly ContingencyDetails: {
      readonly authorizer?: components["schemas"]["StateTaxProcessingAuthorizer"];
      /**
       * Format: date-time
       * @description Data e hora do início da contingência
       */
      readonly startedOn?: string;
      /** @description Justificativa da entrada em contingência */
      readonly reason?: string | null;
    };
    /** @description Identificação do Local de entrega (entrega) */
    readonly DeliveryInformationResource: {
      /** @description Identificador da Conta */
      readonly accountId?: string | null;
      /** @description Identificação */
      readonly id?: string | null;
      /** @description Nome ou Razão Social (xNome) */
      readonly name?: string | null;
      /**
       * Format: int64
       * @description CNPJ ou CPF
       */
      readonly federalTaxNumber?: number | null;
      /** @description Email */
      readonly email?: string | null;
      readonly address?: components["schemas"]["AddressResource"];
      readonly type?: components["schemas"]["PersonType"];
      /** @description Inscrição Estadual (IE) */
      readonly stateTaxNumber?: string | null;
    };
    /**
     * @description Identificador de local de destino da operação (idDest)
     * @enum {string}
     */
    readonly Destination: "None" | "Internal_Operation" | "Interstate_Operation" | "International_Operation";
    /** @description Dados para inutilizar números de nota fiscal */
    readonly DisablementResource: {
      readonly environment?: components["schemas"]["EnvironmentType"];
      /**
       * Format: int32
       * @description Série
       */
      readonly serie?: number;
      readonly state?: components["schemas"]["StateCode"];
      /**
       * Format: int32
       * @description Número inicial
       */
      readonly beginNumber?: number;
      /**
       * Format: int32
       * @description Número final (usar o mesmo número inicial se for apenas um número)
       */
      readonly lastNumber?: number;
      /** @description Motivo da inutilização */
      readonly reason?: string | null;
    };
    readonly DocumentElectronicInvoiceResource: {
      /** @description Chave de Acesso (refNFe) */
      readonly accessKey?: string | null;
    };
    readonly DocumentInvoiceReferenceResource: {
      /**
       * Format: double
       * @description Código da UF (cUF)
       */
      readonly state?: number | null;
      /** @description Ano / Mês (AAMM) */
      readonly yearMonth?: string | null;
      /** @description CNPJ (CNPJ) */
      readonly federalTaxNumber?: string | null;
      /** @description Modelo (mod) */
      readonly model?: string | null;
      /** @description Série (serie) */
      readonly series?: string | null;
      /** @description Número (nNF) */
      readonly number?: string | null;
    };
    /**
     * @description Indicador de intermediador/marketplace (indIntermed)
     * @enum {string}
     */
    readonly DuductionIndicator: "NotDeduct" | "Deduce";
    readonly DuplicateResource: {
      /** @description Número da Duplicata (nDup) */
      readonly number?: string | null;
      /**
       * Format: date-time
       * @description Data de vencimento (dVenc)
       */
      readonly expirationOn?: string | null;
      /**
       * Format: double
       * @description Valor da duplicata (vDup)
       */
      readonly amount?: number | null;
    };
    readonly EconomicActivityResource: {
      readonly type?: components["schemas"]["EconomicActivityType"];
      /**
       * Format: int32
       * @description Código da Atividade da Empresa
       */
      readonly code?: number | null;
    };
    /** @enum {string} */
    readonly EconomicActivityType: "Main" | "Secondary";
    /** @enum {string} */
    readonly EnvironmentType: "None" | "Production" | "Test";
    readonly ErrorResource: {
      /** Format: int32 */
      readonly code?: number | null;
      readonly message?: string | null;
    };
    readonly ErrorsResource: {
      readonly errors?: (readonly components["schemas"]["ErrorResource"][]) | null;
    };
    /**
     * @description Campo será preenchido quando o campo anterior estiver
     * preenchido.Informar o motivo da desoneração:
     * @enum {string}
     */
    readonly ExemptReason: "Agriculture" | "Others" | "DevelopmentEntities";
    readonly ExportDetailResource: {
      /** @description Número do ato concessório de Drawback (nDraw) */
      readonly drawback?: string | null;
      readonly hintInformation?: components["schemas"]["ExportHintResource"];
    };
    readonly ExportHintResource: {
      /** @description Número do Registro de Exportação (nRE) */
      readonly registryId?: string | null;
      /** @description Chave de Acesso da NF-e recebida para exportação (chNFe) */
      readonly accessKey?: string | null;
      /**
       * Format: double
       * @description Quantidade do item realmente exportado (qExport)
       */
      readonly quantity?: number | null;
    };
    readonly ExportResource: {
      readonly state?: components["schemas"]["StateCode"];
      /** @description Descrição do Local de Embarque ou de transposição de fronteira (xLocExporta) */
      readonly office?: string | null;
      /** @description Informações Complementares de interesse do Contribuinte (xLocDespacho) */
      readonly local?: string | null;
    };
    /** @description Arquivo */
    readonly FileResource: {
      /** @description Endereço Absoluto URI para o arquivo */
      readonly uri?: string | null;
    };
    /** @enum {string} */
    readonly FlagCard: "None" | "Visa" | "Mastercard" | "AmericanExpress" | "Sorocred" | "DinersClub" | "Elo" | "Hipercard" | "Aura" | "Cabal" | "Alelo" | "BanesCard" | "CalCard" | "Credz" | "Discover" | "GoodCard" | "GreenCard" | "Hiper" | "JCB" | "Mais" | "MaxVan" | "Policard" | "RedeCompras" | "Sodexo" | "ValeCard" | "Verocheque" | "VR" | "Ticket" | "Other";
    readonly FuelOriginResource: {
      /**
       * Format: int32
       * @description Indicador de importação (indImport)
       */
      readonly indImport?: number | null;
      /**
       * Format: int32
       * @description Código da UF (cUFOrig)
       */
      readonly cUFOrig?: number | null;
      /**
       * Format: double
       * @description Percentual originário para a UF (pOrig)
       */
      readonly pOrig?: number | null;
    };
    readonly FuelResource: {
      /** @description Código de produto da ANP (cProdANP) */
      readonly codeANP?: string | null;
      /**
       * Format: double
       * @description Percentual de Gás Natural para o produto GLP (cProdANP=210203001) (pMixGN)
       */
      readonly percentageNG?: number | null;
      /** @description Descrição do produto conforme ANP (descANP) */
      readonly descriptionANP?: string | null;
      /**
       * Format: double
       * @description Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001) (pGLP)
       */
      readonly percentageGLP?: number | null;
      /**
       * Format: double
       * @description Percentual de Gás Natural Nacional – GLGNn para o produto GLP (cProdANP= 210203001) (pGNn)
       */
      readonly percentageNGn?: number | null;
      /**
       * Format: double
       * @description Percentual de Gás Natural Importado – GLGNi para o produto GLP (cProdANP= 210203001) (pGNi)
       */
      readonly percentageGNi?: number | null;
      /**
       * Format: double
       * @description Valor de partida (cProdANP=210203001) (vPart)
       */
      readonly startingAmount?: number | null;
      /** @description Código de autorização / registro do CODIF (CODIF) */
      readonly codif?: string | null;
      /**
       * Format: double
       * @description Quantidade de combustível faturada à temperatura ambiente (qTemp)
       */
      readonly amountTemp?: number | null;
      /** @description Sigla da UF de consumo (UFCons) */
      readonly stateBuyer?: string | null;
      readonly cide?: components["schemas"]["CIDEResource"];
      readonly pump?: components["schemas"]["PumpResource"];
      readonly fuelOrigin?: components["schemas"]["FuelOriginResource"];
    };
    /**
     * @description Manual Contribuinte v_5.00
     * Grupo de Valores Totais referentes ao ICMS
     */
    readonly ICMSTotal: {
      /**
       * Format: double
       * @description Base de Cálculo do ICMS (vBC)
       */
      readonly baseTax?: number | null;
      /**
       * Format: double
       * @description Valor Total do ICMS (vICMS)
       */
      readonly icmsAmount?: number | null;
      /**
       * Format: double
       * @description Valor ICMS Total desonerado (vICMSDeson)
       */
      readonly icmsExemptAmount?: number | null;
      /**
       * Format: double
       * @description Base de Cálculo do ICMS Substituição Tributária (vBCST)
       */
      readonly stCalculationBasisAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do ICMS ST (vST)
       */
      readonly stAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total dos produtos e serviços (vProd)
       */
      readonly productAmount?: number;
      /**
       * Format: double
       * @description Valor Total do Frete (vFrete)
       */
      readonly freightAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do Seguro (vSeg)
       */
      readonly insuranceAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do Desconto (vDesc)
       */
      readonly discountAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do Imposto de Importação (vII)
       */
      readonly iiAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do IPI (vIPI)
       */
      readonly ipiAmount?: number | null;
      /**
       * Format: double
       * @description Valor do PIS (vPIS)
       */
      readonly pisAmount?: number | null;
      /**
       * Format: double
       * @description Valor do COFINS (vCOFINS)
       */
      readonly cofinsAmount?: number | null;
      /**
       * Format: double
       * @description Outras Despesas acessórias (vOutro)
       */
      readonly othersAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total da NF-e (vNF)
       */
      readonly invoiceAmount?: number;
      /**
       * Format: double
       * @description Valor Total ICMS FCP UF Destino
       */
      readonly fcpufDestinationAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total ICMS Interestadual UF Destino
       */
      readonly icmsufDestinationAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total ICMS Interestadual UF Rem.
       */
      readonly icmsufSenderAmount?: number | null;
      /**
       * Format: double
       * @description Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib)
       */
      readonly federalTaxesAmount?: number;
      /**
       * Format: double
       * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP)
       */
      readonly fcpAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) retido por substituição tributária.
       */
      readonly fcpstAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) retido anteriormente por substituição tributária.
       */
      readonly fcpstRetAmount?: number | null;
      /**
       * Format: double
       * @description Valor total do IPI devolvido (vIPIDevol)
       */
      readonly ipiDevolAmount?: number | null;
      /** Format: double */
      readonly qBCMono?: number | null;
      /**
       * Format: double
       * @description Valor total do ICMS monofásico próprio (vICMSMono).
       */
      readonly vICMSMono?: number | null;
      /**
       * Format: double
       * @description Valor total da quantidade tributada do ICMS monofásico sujeito a retenção (qBCMonoReten).
       */
      readonly qBCMonoReten?: number | null;
      /**
       * Format: double
       * @description Valor total da quantidade tributada do ICMS monofásico retido anteriormente(vICMSMonoReten)
       */
      readonly vICMSMonoReten?: number | null;
      /**
       * Format: double
       * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet)
       */
      readonly qBCMonoRet?: number | null;
      /**
       * Format: double
       * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet)
       */
      readonly vICMSMonoRet?: number | null;
    };
    /**
     * @description Manual Contribuinte v_5.00
     * Grupo de Valores Totais referentes ao ICMS
     */
    readonly ICMSTotalResource: {
      /**
       * Format: double
       * @description Base de Cálculo do ICMS (vBC)
       */
      readonly baseTax?: number | null;
      /**
       * Format: double
       * @description Valor Total do ICMS (vICMS)
       */
      readonly icmsAmount?: number | null;
      /**
       * Format: double
       * @description Valor ICMS Total desonerado (vICMSDeson)
       */
      readonly icmsExemptAmount?: number | null;
      /**
       * Format: double
       * @description Base de Cálculo do ICMS Substituição Tributária (vBCST)
       */
      readonly stCalculationBasisAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do ICMS ST (vST)
       */
      readonly stAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total dos produtos e serviços (vProd)
       */
      readonly productAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do Frete (vFrete)
       */
      readonly freightAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do Seguro (vSeg)
       */
      readonly insuranceAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do Desconto (vDesc)
       */
      readonly discountAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do Imposto de Importação (vII)
       */
      readonly iiAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do IPI (vIPI)
       */
      readonly ipiAmount?: number | null;
      /**
       * Format: double
       * @description Valor do PIS (vPIS)
       */
      readonly pisAmount?: number | null;
      /**
       * Format: double
       * @description Valor do COFINS (vCOFINS)
       */
      readonly cofinsAmount?: number | null;
      /**
       * Format: double
       * @description Outras Despesas acessórias (vOutro)
       */
      readonly othersAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total da NF-e (vNF)
       */
      readonly invoiceAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total ICMS FCP UF Destino (vFCPUFDest)
       */
      readonly fcpufDestinationAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total ICMS Interestadual UF Destino (vICMSUFDest)
       */
      readonly icmsufDestinationAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total ICMS Interestadual UF Remetente (vICMSUFRemet)
       */
      readonly icmsufSenderAmount?: number | null;
      /**
       * Format: double
       * @description Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib)
       */
      readonly federalTaxesAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP)
       */
      readonly fcpAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST)
       */
      readonly fcpstAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet)
       */
      readonly fcpstRetAmount?: number | null;
      /**
       * Format: double
       * @description Valor total do IPI devolvido (vIPIDevol)
       */
      readonly ipiDevolAmount?: number | null;
      /**
       * Format: double
       * @description Valor total da quantidade tributada do ICMS monofásico próprio (qBCMono)
       */
      readonly qBCMono?: number | null;
      /**
       * Format: double
       * @description Valor total do ICMS monofásico próprio  (vICMSMono)
       */
      readonly vICMSMono?: number | null;
      /**
       * Format: double
       * @description Valor total da quantidade tributada do ICMS monofásico sujeito a retenção(qBCMonoReten)
       */
      readonly qBCMonoReten?: number | null;
      /**
       * Format: double
       * @description Valor total do ICMS monofásico sujeito a retenção (vICMSMonoReten)
       */
      readonly vICMSMonoReten?: number | null;
      /**
       * Format: double
       * @description Valor total da quantidade tributada do ICMS monofásico retido anteriormente(qBCMonoRet)
       */
      readonly qBCMonoRet?: number | null;
      /**
       * Format: double
       * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet)
       */
      readonly vICMSMonoRet?: number | null;
    };
    /** @description Grupo de Tributação do ICMS de Destino da UF */
    readonly ICMSUFDestinationTaxResource: {
      /**
       * Format: double
       * @description Valor da Base de Cálculo do ICMS na UF de destino (vBCUFDest)
       */
      readonly vBCUFDest?: number | null;
      /**
       * Format: double
       * @description Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de Combate à Pobreza (FCP) naquela UF (pFCPUFDest)
       */
      readonly pFCPUFDest?: number | null;
      /**
       * Format: double
       * @description Alíquota adotada nas operações internas na UF de destino para o produto / mercadoria (pICMSUFDest)
       */
      readonly pICMSUFDest?: number | null;
      /**
       * Format: double
       * @description Alíquota interestadual das UF envolvidas (pICMSInter)
       */
      readonly pICMSInter?: number | null;
      /**
       * Format: double
       * @description Percentual de ICMS Interestadual para a UF de destino (pICMSInterPart)
       */
      readonly pICMSInterPart?: number | null;
      /**
       * Format: double
       * @description Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino (vFCPUFDest
       */
      readonly vFCPUFDest?: number | null;
      /**
       * Format: double
       * @description Valor do ICMS Interestadual para a UF de destino (vICMSUFDest)
       */
      readonly vICMSUFDest?: number | null;
      /**
       * Format: double
       * @description Valor do ICMS Interestadual para a UF do remetente (vICMSUFRemet)
       */
      readonly vICMSUFRemet?: number | null;
      /**
       * Format: double
       * @description Valor da BC FCP na UF de destino (vBCFCPUFDest)
       */
      readonly vBCFCPUFDest?: number | null;
    };
    /**
     * @description Grupo do Imposto de Importação
     *
     * Id: P01
     * Pai: O01
     */
    readonly IITaxResource: {
      /** @description Valor BC do Imposto de Importação (vBC) */
      readonly baseTax?: string | null;
      /** @description Valor despesas aduaneiras (vDespAdu) */
      readonly customsExpenditureAmount?: string | null;
      /**
       * Format: double
       * @description Valor Imposto de Importação (vII)
       */
      readonly amount?: number | null;
      /**
       * Format: double
       * @description Valor Imposto sobre Operações Financeiras (vIOF)
       */
      readonly iofAmount?: number | null;
      /**
       * Format: double
       * @description Valor dos encargos cambiais
       */
      readonly vEnqCamb?: number | null;
    };
    /**
     * @description
     * Grupo do IPI
     *
     * Informar apenas quando o item for sujeito ao IPI
     *
     * ID: O01
     *
     * Pai: M01
     */
    readonly IPITaxResource: {
      /** @description Código da situação tributária do IPI (CST) */
      readonly cst?: string | null;
      /** @description Código de Enquadramento Legal do IPI (cEnq) */
      readonly classificationCode?: string | null;
      /**
       * @description clEnq
       * Classe de enquadramento do IPI para Cigarros e Bebidas (clEnq)
       */
      readonly classification?: string | null;
      /** @description CNPJ do produtor da mercadoria, quando diferente do emitente. Somente para os casos de exportação direta ou indireta (CNPJProd) */
      readonly producerCNPJ?: string | null;
      /** @description Código do selo de controle IPI (cSelo) */
      readonly stampCode?: string | null;
      /**
       * Format: double
       * @description Quantidade de selo de controle (qSelo)
       */
      readonly stampQuantity?: number | null;
      /**
       * Format: double
       * @description Valor da BC do IPI (vBC)
       */
      readonly base?: number | null;
      /**
       * Format: double
       * @description Alíquota do IPI (pIPI)
       */
      readonly rate?: number | null;
      /**
       * Format: double
       * @description Quantidade total na unidade padrão para tributação (somente para os produtos tributados por unidade) (qUnid)
       */
      readonly unitQuantity?: number | null;
      /**
       * Format: double
       * @description Valor por Unidade Tributável (vUnid)
       */
      readonly unitAmount?: number | null;
      /**
       * Format: double
       * @description Valor IPI (vIPI)
       */
      readonly amount?: number | null;
    };
    readonly ISSQNTotal: {
      /**
       * Format: double
       * @description Valor Total Serv.Não Tributados p/ ICMS
       */
      readonly totalServiceNotTaxedICMS?: number | null;
      /**
       * Format: double
       * @description Base de Cálculo do ISS
       */
      readonly baseRateISS?: number | null;
      /**
       * Format: double
       * @description Valor Total do ISS
       */
      readonly totalISS?: number | null;
      /**
       * Format: double
       * @description Valor do PIS sobre Serviços
       */
      readonly valueServicePIS?: number | null;
      /**
       * Format: double
       * @description Valor da COFINS sobre Serviços
       */
      readonly valueServiceCOFINS?: number | null;
      /**
       * Format: date-time
       * @description Data Prestação Serviço
       */
      readonly provisionService?: string | null;
      /**
       * Format: double
       * @description Valor Dedução para Redução da BC
       */
      readonly deductionReductionBC?: number | null;
      /**
       * Format: double
       * @description Valor Outras Retenções
       */
      readonly valueOtherRetention?: number | null;
      /**
       * Format: double
       * @description Valor Desconto Incondicionado
       */
      readonly discountUnconditional?: number | null;
      /**
       * Format: double
       * @description Valor Desconto Condicionado
       */
      readonly discountConditioning?: number | null;
      /**
       * Format: double
       * @description Valor Total Retenção ISS
       */
      readonly totalRetentionISS?: number | null;
      /**
       * Format: double
       * @description Código Regime Tributação
       */
      readonly codeTaxRegime?: number | null;
    };
    readonly ISSQNTotalResource: {
      /**
       * Format: double
       * @description Valor Total Serv.Não Tributados p/ ICMS (vServ)
       */
      readonly totalServiceNotTaxedICMS?: number | null;
      /**
       * Format: double
       * @description Base de Cálculo do ISS (vBC)
       */
      readonly baseRateISS?: number | null;
      /**
       * Format: double
       * @description Valor Total do ISS (vISS)
       */
      readonly totalISS?: number | null;
      /**
       * Format: double
       * @description Valor do PIS sobre Serviços (vPIS)
       */
      readonly valueServicePIS?: number | null;
      /**
       * Format: double
       * @description Valor da COFINS sobre Serviços (vCOFINS)
       */
      readonly valueServiceCOFINS?: number | null;
      /**
       * Format: date-time
       * @description Data Prestação Serviço (dCompet)
       */
      readonly provisionService?: string | null;
      /**
       * Format: double
       * @description Valor Dedução para Redução da BC (vDeducao)
       */
      readonly deductionReductionBC?: number | null;
      /**
       * Format: double
       * @description Valor Outras Retenções (vOutro)
       */
      readonly valueOtherRetention?: number | null;
      /**
       * Format: double
       * @description Valor Desconto Incondicionado (vDescIncond)
       */
      readonly discountUnconditional?: number | null;
      /**
       * Format: double
       * @description Valor Desconto Condicionado (vDescCond)
       */
      readonly discountConditioning?: number | null;
      /**
       * Format: double
       * @description Valor Total Retenção ISS (vISSRet)
       */
      readonly totalRetentionISS?: number | null;
      /**
       * Format: double
       * @description Código Regime Tributação (cRegTrib)
       */
      readonly codeTaxRegime?: number | null;
    };
    /**
     * @description Grupo do ICMS da Operação própria e ST
     *
     * ID: N01
     * PAI: M01
     *
     *     Obs: Informar apenas um dos grupos N02, N03, N04, N05, N06, N07, N08, N09, N10,
     *     N10a, N10b, N10c, N10d, N10e, N10f, N10g ou N10h com base no conteúdo informado na TAG Tributação do ICMS. (v2.0)
     */
    readonly IcmsTaxResource: {
      /** @description Origem da mercadoria (orig) */
      readonly origin?: string | null;
      /** @description Tributação do ICMS (CST) */
      readonly cst?: string | null;
      /**
       * @description 101- Tributada pelo Simples Nacional com permissão de crédito. (v.2.0) (CSOSN)
       * Código de Situação da Operação – Simples Nacional
       */
      readonly csosn?: string | null;
      /**
       * @description Modalidade de determinação da BC do ICMS (modBC)
       * <remarks>
       *     Margem Valor Agregado (%) = 0
       *     Pauta (valor) = 1
       *     Preço Tabelado Máximo (valor) = 2
       *     Valor da Operação = 3
       * </remarks>
       */
      readonly baseTaxModality?: string | null;
      /**
       * Format: double
       * @description Valor da BC do ICMS (vBC)
       */
      readonly baseTax?: number | null;
      /** @description Modalidade de determinação da BC do ICMS ST (modBCST) */
      readonly baseTaxSTModality?: string | null;
      /**
       * @description pRedBCST
       * Percentual da Redução de BC do ICMS ST (pRedBCST)
       */
      readonly baseTaxSTReduction?: string | null;
      /**
       * Format: double
       * @description Valor da BC do ICMS ST (vBCST)
       */
      readonly baseTaxST?: number | null;
      /**
       * Format: double
       * @description Percentual da Redução de BC (pRedBC)
       */
      readonly baseTaxReduction?: number | null;
      /**
       * Format: double
       * @description Alíquota do imposto do ICMS ST (pICMSST)
       */
      readonly stRate?: number | null;
      /**
       * Format: double
       * @description Valor do ICMS ST (vICMSST)
       */
      readonly stAmount?: number | null;
      /**
       * Format: double
       * @description pMVAST
       * Percentual da margem de valor Adicionado do ICMS ST (pMVAST)
       */
      readonly stMarginAmount?: number | null;
      /**
       * Format: double
       * @description pICMS
       * Alíquota do imposto (pICMS)
       */
      readonly rate?: number | null;
      /**
       * Format: double
       * @description Valor do ICMS (vICMS)
       * O valor do ICMS desonerado será informado apenas nas operações:
       * a) com produtos beneficiados com a desoneração condicional do ICMS.
       * b) destinadas à SUFRAMA, informando-se o valor que seria devido se não houvesse isenção.
       * c) de venda a órgãos da administração pública direta e suas fundações e
       * autarquias com isenção do ICMS. (NT 2011/004)
       */
      readonly amount?: number | null;
      /**
       * Format: double
       * @description Percentual da Redução de BC (pICMS)
       */
      readonly percentual?: number | null;
      /**
       * Format: double
       * @description Alíquota aplicável de cálculo do crédito (Simples Nacional). (pCredSN)
       */
      readonly snCreditRate?: number | null;
      /**
       * Format: double
       * @description Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 Simples Nacional (vCredICMSSN)
       */
      readonly snCreditAmount?: number | null;
      /** @description Percentual da margem de valor Adicionado do ICMS ST (pMVAST) */
      readonly stMarginAddedAmount?: string | null;
      /** @description Valor do ICMS ST retido (vICMSSTRet) */
      readonly stRetentionAmount?: string | null;
      /** @description Valor da BC do ICMS ST retido (vBCSTRet) */
      readonly baseSTRetentionAmount?: string | null;
      /**
       * @description Percentual  da BC operação própria  (pBCOp)
       * Percentual para determinação do valor  da Base de Cálculo da operação própria. (v2.0)
       */
      readonly baseTaxOperationPercentual?: string | null;
      /**
       * @description UF para qual é devido o ICMS ST (UFST)
       * Sigla da UF para qual é devido o ICMS ST da operação. (v2.0)
       */
      readonly ufst?: string | null;
      /** @description Motivo Desoneração ICMS */
      readonly amountSTReason?: string | null;
      /** @description Valor da BC do ICMS ST retido (vBCSTRet) */
      readonly baseSNRetentionAmount?: string | null;
      /** @description Valor do ICMS ST retido (vICMSSTRet) */
      readonly snRetentionAmount?: string | null;
      /** @description Valor do ICMS da Operação (vICMSOp) */
      readonly amountOperation?: string | null;
      /** @description Percentual do Diferimento (pDif) */
      readonly percentualDeferment?: string | null;
      /** @description Valor do ICMS Diferido (vICMSDif) */
      readonly baseDeferred?: string | null;
      /**
       * Format: double
       * @description Valor ICMS Desonerado
       */
      readonly exemptAmount?: number | null;
      readonly exemptReason?: components["schemas"]["ExemptReason"];
      /**
       * Format: double
       * @description Valor ICMS Desonerado
       */
      readonly exemptAmountST?: number | null;
      readonly exemptReasonST?: components["schemas"]["ExemptReason"];
      /**
       * Format: double
       * @description Percentual do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (pFCP)
       */
      readonly fcpRate?: number | null;
      /**
       * Format: double
       * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP)
       */
      readonly fcpAmount?: number | null;
      /**
       * Format: double
       * @description Percentual do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (pFCPST)
       */
      readonly fcpstRate?: number | null;
      /**
       * Format: double
       * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST)
       */
      readonly fcpstAmount?: number | null;
      /**
       * Format: double
       * @description Percentual do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (pFCPSTRet)
       */
      readonly fcpstRetRate?: number | null;
      /**
       * Format: double
       * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet)
       */
      readonly fcpstRetAmount?: number | null;
      /**
       * Format: double
       * @description Informar o valor da Base de Cálculo do FCP (vBCFCPST)
       */
      readonly baseTaxFCPSTAmount?: number | null;
      /**
       * Format: double
       * @description Valor do ICMS próprio do Substituto (tag: vICMSSubstituto)
       */
      readonly substituteAmount?: number | null;
      /**
       * Format: double
       * @description N26a - Alíquota suportada pelo Consumidor Final (pST)
       * Deve ser informada a alíquota do cálculo do ICMS-ST, já incluso o FCP caso incida sobre a mercadoria
       */
      readonly stFinalConsumerRate?: number | null;
      /**
       * Format: double
       * @description N34 - Percentual de redução da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (pRedBCEfet)
       */
      readonly effectiveBaseTaxReductionRate?: number | null;
      /**
       * Format: double
       * @description N35 - Valor da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (vBCEfet)
       */
      readonly effectiveBaseTaxAmount?: number | null;
      /**
       * Format: double
       * @description N36 - Alíquota do ICMS efetiva, caso estivesse submetida ao regime comum de tributação (pICMSEFET)
       */
      readonly effectiveRate?: number | null;
      /**
       * Format: double
       * @description N37 - Valor do ICMS efetivo, caso estivesse submetida ao regime comum de tributação (vICMSEFET)
       */
      readonly effectiveAmount?: number | null;
      readonly deductionIndicator?: components["schemas"]["DuductionIndicator"];
    };
    /** @description Declaração Importação (DI) */
    readonly ImportDeclarationResource: {
      /** @description Número do Documento de Importação da DI/DSI/DA (nDI) */
      readonly code?: string | null;
      /**
       * Format: date-time
       * @description Data de Registro da DI/DSI/DA (dDI)
       */
      readonly registeredOn?: string | null;
      /** @description Local de desembaraço (xLocDesemb) */
      readonly customsClearanceName?: string | null;
      readonly customsClearanceState?: components["schemas"]["StateCode"];
      /**
       * Format: date-time
       * @description Data do Desembaraço Aduaneiro (dDesemb)
       */
      readonly customsClearancedOn?: string | null;
      /** @description Adições (adi) */
      readonly additions?: (readonly components["schemas"]["AdditionResource"][]) | null;
      /** @description Código do exportador (cExportador) */
      readonly exporter?: string | null;
      readonly internationalTransport?: components["schemas"]["InternationalTransportType"];
      readonly intermediation?: components["schemas"]["IntermediationType"];
      /** @description CNPJ/CPF do adquirente ou do encomendante (CNPJ ou CPF) */
      readonly acquirerFederalTaxNumber?: string | null;
      /** @description Sigla da UF do adquirente ou do encomendante  (UFTerceiro) */
      readonly stateThird?: string | null;
    };
    /**
     * @description 1 - Pagamento integrado com o sistema de automação da empresa(Ex.: equipamento TEF, Comércio Eletrônico)
     * 2 - Pagamento não integrado com o sistema de automação da empresa(Ex.: equipamento POS);
     * @enum {string}
     */
    readonly IntegrationPaymentType: "Integrated" | "NotIntegrated";
    /** @description Grupo de Informações do Intermediador da Transação (infIntermed) */
    readonly IntermediateResource: {
      /**
       * Format: int64
       * @description CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios. (CNPJ)
       */
      readonly federalTaxNumber?: number | null;
      /** @description Identificador cadastrado no intermediador (idCadIntTran) */
      readonly identifier?: string | null;
    };
    /**
     * @description Tipo de Intermediação
     * @enum {string}
     */
    readonly IntermediationType: "None" | "ByOwn" | "ImportOnBehalf" | "ByOrder";
    /**
     * @description Tipo Transporte Internacional
     * @enum {string}
     */
    readonly InternationalTransportType: "None" | "Maritime" | "River" | "Lake" | "Airline" | "Postal" | "Railway" | "Highway" | "Network" | "Own" | "Ficta" | "Courier" | "Handcarry";
    readonly InvoiceEventsResourceBase: {
      /** @description Lista de Eventos ocorridos na Nota Fiscal */
      readonly events?: (readonly components["schemas"]["ActivityResource"][]) | null;
      /** @description Identificador de possibilidade de mais itens. */
      readonly hasMore?: boolean | null;
    };
    /**
     * @description Manual Contribuinte v_5.00
     * Grupo do detalhamento de Produtos e Serviços da NF-e
     */
    readonly InvoiceItemResource: {
      /** @description Código do produto ou serviço (cProd) */
      readonly code?: string | null;
      /**
       * @description GTIN (Global Trade Item Number) do produto,
       * antigo código EAN ou código de barras (cEAN)
       */
      readonly codeGTIN?: string | null;
      /** @description Descrição do produto ou serviço (xProd) */
      readonly description?: string | null;
      /** @description Código NCM com 8 dígitos ou 2 dígitos (gênero) (NCM) */
      readonly ncm?: string | null;
      /** @description Nomenclatura de Valor aduaneiro e Estatístico (NVE) */
      readonly nve?: (readonly string[]) | null;
      /** @description Código Exceção da Tabela de IPI */
      readonly extipi?: string | null;
      /**
       * Format: int64
       * @description Código Fiscal de Operações e Prestações (CFOP)
       */
      readonly cfop?: number | null;
      /** @description Unidade Comercial (uCom) */
      readonly unit?: string | null;
      /**
       * Format: double
       * @description Quantidade Comercial (qCom)
       */
      readonly quantity?: number | null;
      /**
       * Format: double
       * @description Valor Unitário de Comercialização (vUnCom)
       */
      readonly unitAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total Bruto dos Produtos ou Serviços (vProd)
       */
      readonly totalAmount?: number | null;
      /**
       * @description GTIN (Global Trade Item Number) da unidade tributável,
       * antigo código EAN ou código de barras (cEANTrib)
       */
      readonly codeTaxGTIN?: string | null;
      /** @description Unidade Tributável (uTrib) */
      readonly unitTax?: string | null;
      /**
       * Format: double
       * @description Quantidade Tributável (qTrib)
       */
      readonly quantityTax?: number | null;
      /**
       * Format: double
       * @description Valor Unitário de tributação (vUnTrib)
       */
      readonly taxUnitAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do Frete (vFrete)
       */
      readonly freightAmount?: number | null;
      /**
       * Format: double
       * @description Valor Total do Seguro (vSeg)
       */
      readonly insuranceAmount?: number | null;
      /**
       * Format: double
       * @description Valor do Desconto (vDesc)
       */
      readonly discountAmount?: number | null;
      /**
       * Format: double
       * @description Outras despesas acessórias (vOutro)
       */
      readonly othersAmount?: number | null;
      /**
       * @description Indica se valor do Item (vProd)
       * entra no valor total da NF-e (vProd) (indTot)
       */
      readonly totalIndicator?: boolean | null;
      /** @description CEST - Código especificador da substituição tributária */
      readonly cest?: string | null;
      readonly tax?: components["schemas"]["InvoiceItemTaxResource"];
      /** @description Informações Adicionais do Produto (infAdProd) */
      readonly additionalInformation?: string | null;
      /** @description Número do pedido de compra (xPed) */
      readonly numberOrderBuy?: string | null;
      /**
       * Format: int32
       * @description Item do Pedido de Compra (nItemPed)
       */
      readonly itemNumberOrderBuy?: number | null;
      /** @description Número de controle da FCI - Ficha de Conteúdo de Importação (nFCI) */
      readonly importControlSheetNumber?: string | null;
      readonly fuelDetail?: components["schemas"]["FuelResource"];
      /** @description Código de Benefício Fiscal na UF aplicado ao item (cBenef) */
      readonly benefit?: string | null;
      /** @description Declaração Importação (DI) */
      readonly importDeclarations?: (readonly components["schemas"]["ImportDeclarationResource"][]) | null;
      /** @description Grupo de informações de exportação para o item (detExport) */
      readonly exportDetails?: (readonly components["schemas"]["ExportDetailResource"][]) | null;
      readonly taxDetermination?: components["schemas"]["TaxDeterminationResource"];
    };
    readonly InvoiceItemTaxResource: {
      /**
       * Format: double
       * @description Valor aproximado total de tributos federais, estaduais e municipais (vTotTrib)
       */
      readonly totalTax?: number | null;
      readonly icms?: components["schemas"]["IcmsTaxResource"];
      readonly ipi?: components["schemas"]["IPITaxResource"];
      readonly ii?: components["schemas"]["IITaxResource"];
      readonly pis?: components["schemas"]["PISTaxResource"];
      readonly cofins?: components["schemas"]["CofinsTaxResource"];
      readonly icmsDestination?: components["schemas"]["ICMSUFDestinationTaxResource"];
    };
    readonly InvoiceItemsResource: {
      /** @description Identificador da Conta */
      readonly accountId?: string | null;
      /** @description Identificador da Empresa */
      readonly companyId?: string | null;
      /** @description Identificador da Nota Fiscal */
      readonly id?: string | null;
      /** @description Detalhamento de Produtos e Serviços (det) - Lista de Items da Nota Fiscal */
      readonly items?: (readonly components["schemas"]["InvoiceItemResource"][]) | null;
      /** @description Identifica se existem mais items a serem consultados */
      readonly hasMore?: boolean | null;
    };
    readonly InvoiceResource: {
      /** @description Identificador único */
      readonly id?: string | null;
      /**
       * Format: int32
       * @description Série do Documento Fiscal (serie)
       */
      readonly serie?: number | null;
      /**
       * Format: int64
       * @description Número do Documento Fiscal (nNF)
       */
      readonly number?: number | null;
      readonly status?: components["schemas"]["InvoiceStatus"];
      readonly authorization?: components["schemas"]["AuthorizationResource"];
      readonly contingencyDetails?: components["schemas"]["ContingencyDetails"];
      /** @description Descrição da Natureza da Operação (natOp) */
      readonly operationNature?: string | null;
      /**
       * Format: date-time
       * @description Data de criação
       */
      readonly createdOn?: string | null;
      /**
       * Format: date-time
       * @description Data de modificação
       */
      readonly modifiedOn?: string | null;
      /**
       * Format: date-time
       * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)
       * <remarks>
       *     Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.
       * </remarks>
       */
      readonly operationOn?: string | null;
      readonly operationType?: components["schemas"]["OperationType"];
      readonly environmentType?: components["schemas"]["EnvironmentType"];
      readonly purposeType?: components["schemas"]["PurposeType"];
      readonly issuer?: components["schemas"]["IssuerResource"];
      readonly buyer?: components["schemas"]["BuyerResource"];
      readonly totals?: components["schemas"]["TotalResource"];
      readonly transport?: components["schemas"]["TransportInformationResource"];
      readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"];
      readonly export?: components["schemas"]["ExportResource"];
      readonly billing?: components["schemas"]["BillingResource"];
      /** @description Grupo de Formas de Pagamento (pag) */
      readonly payment?: (readonly components["schemas"]["PaymentResource"][]) | null;
      readonly transactionIntermediate?: components["schemas"]["IntermediateResource"];
      readonly delivery?: components["schemas"]["DeliveryInformationResource"];
      readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"];
      readonly lastEvents?: components["schemas"]["InvoiceEventsResourceBase"];
    };
    /** @enum {string} */
    readonly InvoiceStatus: "None" | "Created" | "Processing" | "Issued" | "IssuedContingency" | "Cancelled" | "Disabled" | "IssueDenied" | "Error";
    readonly InvoiceWithoutEventsResource: {
      /** @description Identificador único */
      readonly id?: string | null;
      /**
       * Format: int32
       * @description Série do Documento Fiscal (serie)
       */
      readonly serie?: number | null;
      /**
       * Format: int64
       * @description Número do Documento Fiscal (nNF)
       */
      readonly number?: number | null;
      readonly status?: components["schemas"]["InvoiceStatus"];
      readonly authorization?: components["schemas"]["AuthorizationResource"];
      readonly contingencyDetails?: components["schemas"]["ContingencyDetails"];
      /** @description Descrição da Natureza da Operação (natOp) */
      readonly operationNature?: string | null;
      /**
       * Format: date-time
       * @description Data de criação
       */
      readonly createdOn?: string | null;
      /**
       * Format: date-time
       * @description Data de modificação
       */
      readonly modifiedOn?: string | null;
      /**
       * Format: date-time
       * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)
       * <remarks>
       *     Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.
       * </remarks>
       */
      readonly operationOn?: string | null;
      readonly operationType?: components["schemas"]["OperationType"];
      readonly environmentType?: components["schemas"]["EnvironmentType"];
      readonly purposeType?: components["schemas"]["PurposeType"];
      readonly issuer?: components["schemas"]["IssuerResource"];
      readonly buyer?: components["schemas"]["BuyerResource"];
      readonly totals?: components["schemas"]["TotalResource"];
      readonly transport?: components["schemas"]["TransportInformationResource"];
      readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"];
      readonly export?: components["schemas"]["ExportResource"];
      readonly billing?: components["schemas"]["BillingResource"];
      /** @description Grupo de Formas de Pagamento (pag) */
      readonly payment?: (readonly components["schemas"]["PaymentResource"][]) | null;
      readonly transactionIntermediate?: components["schemas"]["IntermediateResource"];
      readonly delivery?: components["schemas"]["DeliveryInformationResource"];
      readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"];
    };
    readonly IssuerFromRequestResource: {
      /** @description IE do Substituto Tributário (IEST) */
      readonly stStateTaxNumber?: string | null;
    };
    /**
     * @description Manual_de_Orientação_Contribuinte_v_5.00
     * Grupo de identificação do emitente da NF-e
     */
    readonly IssuerResource: {
      /** @description Identificador da Conta */
      readonly accountId?: string | null;
      /** @description Identificação */
      readonly id?: string | null;
      /** @description Nome ou Razão Social (xNome) */
      readonly name?: string | null;
      /**
       * Format: int64
       * @description CNPJ ou CPF
       */
      readonly federalTaxNumber?: number | null;
      /** @description Email */
      readonly email?: string | null;
      readonly address?: components["schemas"]["AddressResource"];
      readonly type?: components["schemas"]["PersonType"];
      /** @description Nome Fantasia */
      readonly tradeName?: string | null;
      /**
       * Format: date-time
       * @description Data abertura da empresa
       */
      readonly openningDate?: string | null;
      readonly taxRegime?: components["schemas"]["TaxRegime"];
      readonly specialTaxRegime?: components["schemas"]["SpecialTaxRegime"];
      readonly legalNature?: components["schemas"]["LegalNature"];
      /** @description Atividades da Empresa (CNAE) */
      readonly economicActivities?: (readonly components["schemas"]["EconomicActivityResource"][]) | null;
      /**
       * Format: int64
       * @description Número de Inscrição na Junta Comercial
       */
      readonly companyRegistryNumber?: number | null;
      /**
       * Format: int64
       * @description Número de Inscrição na SEFAZ (IE)
       */
      readonly regionalTaxNumber?: number | null;
      /**
       * Format: int64
       * @description Inscrição Estadual do Substituto Tributário (IEST)
       */
      readonly regionalSTTaxNumber?: number | null;
      /** @description Número de Inscrição na Prefeitura (IM/CCM) */
      readonly municipalTaxNumber?: string | null;
      /** @description IE do Substituto Tributário (IEST) */
      readonly stStateTaxNumber?: string | null;
    };
    /** @enum {string} */
    readonly LegalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada";
    /** @enum {string} */
    readonly OperationType: "Outgoing" | "Incoming";
    /** @description Grupo do PIS */
    readonly PISTaxResource: {
      /** @description Código de Situação Tributária do PIS (CST) */
      readonly cst?: string | null;
      /**
       * Format: double
       * @description Valor da Base de Cálculo do PIS (vBC)
       */
      readonly baseTax?: number | null;
      /**
       * Format: double
       * @description Alíquota do PIS (em percentual) (pPIS)
       */
      readonly rate?: number | null;
      /**
       * Format: double
       * @description Valor do PIS (vPIS)
       */
      readonly amount?: number | null;
      /**
       * Format: double
       * @description Quantidade Vendida (qBCProd)
       */
      readonly baseTaxProductQuantity?: number | null;
      /**
       * Format: double
       * @description Alíquota do PIS (em reais) (vAliqProd)
       */
      readonly productRate?: number | null;
    };
    readonly PaymentDetailResource: {
      readonly method?: components["schemas"]["PaymentMethod"];
      /** @description Descrição do meio de pagamento (xPag) */
      readonly methodDescription?: string | null;
      readonly paymentType?: components["schemas"]["PaymentType"];
      /**
       * Format: double
       * @description Valor do Pagamento (vPag)
       */
      readonly amount?: number | null;
      readonly card?: components["schemas"]["CardResource"];
      /**
       * Format: date-time
       * @description Data do pagamento (dPag)
       */
      readonly paymentDate?: string | null;
      /** @description CNPJ transacional do pagamento (CNPJPag) */
      readonly federalTaxNumberPag?: string | null;
      /** @description UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (UFPag) */
      readonly statePag?: string | null;
    };
    /** @enum {string} */
    readonly PaymentMethod: "Cash" | "Cheque" | "CreditCard" | "DebitCard" | "StoreCredict" | "FoodVouchers" | "MealVouchers" | "GiftVouchers" | "FuelVouchers" | "BankBill" | "BankDeposit" | "InstantPayment" | "WireTransfer" | "Cashback" | "WithoutPayment" | "Others";
    readonly PaymentResource: {
      /**
       * @description YA01a - Grupo Detalhamento da Forma de Pagamento (detPag)
       * VERSÃO 4.00
       */
      readonly paymentDetail?: (readonly components["schemas"]["PaymentDetailResource"][]) | null;
      /**
       * Format: double
       * @description Valor do troco (vTroco)
       * VERSÃO 4.00
       */
      readonly payBack?: number | null;
    };
    /** @enum {string} */
    readonly PaymentType: "InCash" | "Term";
    /** @enum {string} */
    readonly PersonType: "Undefined" | "NaturalPerson" | "LegalEntity" | "Company" | "Customer";
    /** @enum {string} */
    readonly PrintType: "None" | "NFeNormalPortrait" | "NFeNormalLandscape" | "NFeSimplified" | "DANFE_NFC_E" | "DANFE_NFC_E_MSG_ELETRONICA";
    readonly ProductInvoiceEventsResource: {
      /** @description Lista de Eventos ocorridos na Nota Fiscal */
      readonly events?: (readonly components["schemas"]["ActivityResource"][]) | null;
      /** @description Identificador de possibilidade de mais itens. */
      readonly hasMore?: boolean | null;
      /** @description Identificação */
      readonly id?: string | null;
      /** @description Identificador da Conta */
      readonly accountId?: string | null;
      /** @description Identificador da Empresa */
      readonly companyId?: string | null;
    };
    /** @description Notas Fiscais Eletrônicas (NFe) */
    readonly ProductInvoiceQueueIssueResource: {
      /** @description Identificador único */
      readonly id?: string | null;
      /** @description Grupo de Formas de Pagamento (pag) */
      readonly payment?: (readonly components["schemas"]["PaymentResource"][]) | null;
      /**
       * Format: int32
       * @description Série do Documento Fiscal (serie)
       */
      readonly serie?: number | null;
      /**
       * Format: int64
       * @description Número do Documento Fiscal (nNF)
       */
      readonly number?: number | null;
      /**
       * Format: date-time
       * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)
       * <remarks>
       *     Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.
       * </remarks>
       */
      readonly operationOn?: string | null;
      /** @description Descrição da Natureza da Operação (natOp) */
      readonly operationNature?: string | null;
      readonly operationType?: components["schemas"]["OperationType"];
      readonly destination?: components["schemas"]["Destination"];
      readonly printType?: components["schemas"]["PrintType"];
      readonly purposeType?: components["schemas"]["PurposeType"];
      readonly consumerType?: components["schemas"]["ConsumerType"];
      readonly presenceType?: components["schemas"]["ConsumerPresenceType"];
      /**
       * Format: date-time
       * @description Data e Hora da entrada em contingência (dhCont)
       * <remarks>
       *     Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD
       * </remarks>
       */
      readonly contingencyOn?: string | null;
      /** @description Justificativa da entrada em contingência (xJust) */
      readonly contingencyJustification?: string | null;
      readonly buyer?: components["schemas"]["BuyerResource"];
      readonly transport?: components["schemas"]["TransportInformationResource"];
      readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"];
      readonly export?: components["schemas"]["ExportResource"];
      /** @description Detalhamento de Produtos e Serviços (det) */
      readonly items?: (readonly components["schemas"]["InvoiceItemResource"][]) | null;
      readonly billing?: components["schemas"]["BillingResource"];
      readonly issuer?: components["schemas"]["IssuerFromRequestResource"];
      readonly transactionIntermediate?: components["schemas"]["IntermediateResource"];
      readonly delivery?: components["schemas"]["DeliveryInformationResource"];
      readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"];
      readonly totals?: components["schemas"]["Total"];
    };
    /** @description Notas Fiscais Eletrônicas (NF-e) */
    readonly ProductInvoicesResource: {
      /** @description Lista de Notas Fiscais Eletrônicas (NF-e) */
      readonly productInvoices?: (readonly components["schemas"]["InvoiceWithoutEventsResource"][]) | null;
      /** @description Identificador de possibilidade de mais itens. */
      readonly hasMore?: boolean;
    };
    readonly PumpResource: {
      /**
       * Format: int32
       * @description Número de identificação do bico utilizado no abastecimento (nBico)
       */
      readonly spoutNumber?: number | null;
      /**
       * Format: int32
       * @description Número de identificação da bomba ao qual o bico está interligado (nBomba)
       */
      readonly number?: number | null;
      /**
       * Format: int32
       * @description Número de identificação do tanque ao qual o bico está interligado (nTanque)
       */
      readonly tankNumber?: number | null;
      /**
       * Format: double
       * @description Valor do Encerrante no início do abastecimento (vEncIni)
       */
      readonly beginningAmount?: number | null;
      /**
       * Format: double
       * @description Valor do Encerrante no final do abastecimento (vEncFin)
       */
      readonly endAmount?: number | null;
      /**
       * Format: double
       * @description Percentual do índice de mistura do Biodiesel (B100) no Óleo Diesel B instituído pelo órgão regulamentador
       */
      readonly percentageBio?: number | null;
    };
    /** @enum {string} */
    readonly PurposeType: "None" | "Normal" | "Complement" | "Adjustment" | "Devolution";
    readonly QueueEventResource: {
      /**
       * @description Justificativa da carta de correção
       * O Texto deve conter no mínimo 15 e no máximo 1.000 caracteres
       * (os quais não poderão conter acentos e/ou caracteres especiais)
       */
      readonly reason?: string | null;
    };
    /**
     * @description Manual_de_Orientação_Contribuinte_v_5.00
     * Grupo Reboque
     */
    readonly ReboqueResource: {
      /** @description Placa do Veiculo (placa) */
      readonly plate?: string | null;
      /** @description UF Veiculo Reboque (UF) */
      readonly uf?: string | null;
      /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */
      readonly rntc?: string | null;
      /** @description Identificação do Vagão (vagao) */
      readonly wagon?: string | null;
      /** @description Identificação da Balsa (balsa) */
      readonly ferry?: string | null;
    };
    /** @enum {string} */
    readonly ReceiverStateTaxIndicator: "None" | "TaxPayer" | "Exempt" | "NonTaxPayer";
    readonly ReferencedProcessResource: {
      readonly identifierConcessory?: string | null;
      /** Format: int32 */
      readonly identifierOrigin?: number | null;
      /** Format: int32 */
      readonly concessionActType?: number | null;
    };
    readonly RequestCancellationResource: {
      readonly accountId?: string | null;
      readonly companyId?: string | null;
      readonly productInvoiceId?: string | null;
      readonly reason?: string | null;
    };
    /** @enum {string} */
    readonly ShippingModality: "ByIssuer" | "ByReceiver" | "ByThirdParties" | "OwnBySender" | "OwnByBuyer" | "Free";
    /**
     * @description Regime especial de tributação
     * @enum {string}
     */
    readonly SpecialTaxRegime: "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte" | "Automatico";
    /** @enum {string} */
    readonly StateCode: "NA" | "RO" | "AC" | "AM" | "RR" | "PA" | "AP" | "TO" | "MA" | "PI" | "CE" | "RN" | "PB" | "PE" | "AL" | "SE" | "BA" | "MG" | "ES" | "RJ" | "SP" | "PR" | "SC" | "RS" | "MS" | "MT" | "GO" | "DF" | "EX";
    /** @enum {string} */
    readonly StateTaxProcessingAuthorizer: "Normal" | "EPEC";
    readonly TaxCouponInformationResource: {
      /** @description Modelo de Documento Fiscal (mod) */
      readonly modelDocumentFiscal?: string | null;
      /** @description Número de Ordem Sequencial do ECF (nECF) */
      readonly orderECF?: string | null;
      /**
       * Format: int32
       * @description Número do Contador de Ordem de Operação (nCOO)
       */
      readonly orderCountOperation?: number | null;
    };
    readonly TaxDeterminationResource: {
      /**
       * Format: int32
       * @description Código interno para determinação de natureza de operação
       */
      readonly operationCode?: number | null;
      /** @description Perfil fiscal do vendedor (origem) - usado para o cálculo automático de impostos */
      readonly issuerTaxProfile?: string | null;
      /** @description Perfil fiscal do comprador (destino) - usado para o cálculo automático de impostos */
      readonly buyerTaxProfile?: string | null;
      /** @description Origem da mercadoria */
      readonly origin?: string | null;
      /** @description Finalidade de aquisição - usado para o cálculo automático de impostos */
      readonly acquisitionPurpose?: string | null;
    };
    readonly TaxDocumentsReferenceResource: {
      readonly taxCouponInformation?: components["schemas"]["TaxCouponInformationResource"];
      readonly documentInvoiceReference?: components["schemas"]["DocumentInvoiceReferenceResource"];
      readonly documentElectronicInvoice?: components["schemas"]["DocumentElectronicInvoiceResource"];
    };
    /**
     * @description Regime de tributação
     * @enum {string}
     */
    readonly TaxRegime: "None" | "LucroReal" | "LucroPresumido" | "SimplesNacional" | "SimplesNacionalExcessoSublimite" | "MicroempreendedorIndividual" | "Isento";
    readonly TaxpayerCommentsResource: {
      /** @description Campo (xCampo) */
      readonly field?: string | null;
      /** @description Texto (xTexto) */
      readonly text?: string | null;
    };
    readonly Total: {
      readonly icms?: components["schemas"]["ICMSTotal"];
      readonly issqn?: components["schemas"]["ISSQNTotal"];
    };
    readonly TotalResource: {
      readonly icms?: components["schemas"]["ICMSTotalResource"];
      readonly issqn?: components["schemas"]["ISSQNTotalResource"];
    };
    /**
     * @description Manual_de_Orientação_Contribuinte_v_5.00
     * Grupo Transportador
     */
    readonly TransportGroupResource: {
      /** @description Identificador da Conta */
      readonly accountId?: string | null;
      /** @description Identificação */
      readonly id?: string | null;
      /** @description Nome ou Razão Social (xNome) */
      readonly name?: string | null;
      /**
       * Format: int64
       * @description CNPJ ou CPF
       */
      readonly federalTaxNumber?: number | null;
      /** @description Email */
      readonly email?: string | null;
      readonly address?: components["schemas"]["AddressResource"];
      readonly type?: components["schemas"]["PersonType"];
      /** @description Inscrição Estadual do Transportador (IE) */
      readonly stateTaxNumber?: string | null;
      /** @description Grupo de Retenção do ICMS do transporte */
      readonly transportRetention?: string | null;
    };
    /**
     * @description Manual_de_Orientação_Contribuinte_v_5.00
     * Grupo de Informações do Transporte da NF-e
     * Id: X01 Pai: A1
     */
    readonly TransportInformationResource: {
      readonly freightModality?: components["schemas"]["ShippingModality"];
      readonly transportGroup?: components["schemas"]["TransportGroupResource"];
      readonly reboque?: components["schemas"]["ReboqueResource"];
      readonly volume?: components["schemas"]["VolumeResource"];
      readonly transportVehicle?: components["schemas"]["TransportVehicleResource"];
      /** @description Número dos Lacres */
      readonly sealNumber?: string | null;
      readonly transpRate?: components["schemas"]["TransportRateResource"];
    };
    readonly TransportRateResource: {
      /**
       * Format: double
       * @description Valor do Serviço (vServ)
       */
      readonly serviceAmount?: number | null;
      /**
       * Format: double
       * @description BC da Retenção do ICMS (vBCRet)
       */
      readonly bcRetentionAmount?: number | null;
      /**
       * Format: double
       * @description Alíquota da Retenção (pICMSRet) //Change to Rate
       */
      readonly icmsRetentionRate?: number | null;
      /**
       * Format: double
       * @description Valor do ICMS Retido (vICMSRet)
       */
      readonly icmsRetentionAmount?: number | null;
      /**
       * Format: int64
       * @description CFOP de Serviço de Transporte (CFOP)
       */
      readonly cfop?: number | null;
      /**
       * Format: int64
       * @description Código do Municipio de ocorrencia do fato gerador do ICMS do Transporte (cMunFG)
       */
      readonly cityGeneratorFactCode?: number | null;
    };
    /**
     * @description Manual_de_Orientação_Contribuinte_v_5.00
     * Grupo Veiculo
     */
    readonly TransportVehicleResource: {
      /** @description Placa do Veiculo (placa) */
      readonly plate?: string | null;
      /** @description Sigla da UF (UF) */
      readonly state?: string | null;
      /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */
      readonly rntc?: string | null;
    };
    /**
     * @description Manual_de_Orientação_Contribuinte_v_5.00
     * Volumes
     * Id:X26
     */
    readonly VolumeResource: {
      /**
       * Format: int32
       * @description Quantidade de volumes transportados (qVol)
       */
      readonly volumeQuantity?: number | null;
      /** @description Espécie dos volumes transportados (esp) */
      readonly species?: string | null;
      /** @description Marca dos Volumes Transportados (marca) */
      readonly brand?: string | null;
      /** @description Numeração dos Volumes Transportados (nVol) */
      readonly volumeNumeration?: string | null;
      /**
       * Format: double
       * @description Peso Liquido(em Kg) (pesoL)
       */
      readonly netWeight?: number | null;
      /**
       * Format: double
       * @description Peso Bruto(em Kg) (pesoB)
       */
      readonly grossWeight?: number | null;
    };
    /** @description Identificação do Local de retirada (retirada) */
    readonly WithdrawalInformationResource: {
      /** @description Identificador da Conta */
      readonly accountId?: string | null;
      /** @description Identificação */
      readonly id?: string | null;
      /** @description Nome ou Razão Social (xNome) */
      readonly name?: string | null;
      /**
       * Format: int64
       * @description CNPJ ou CPF
       */
      readonly federalTaxNumber?: number | null;
      /** @description Email */
      readonly email?: string | null;
      readonly address?: components["schemas"]["AddressResource"];
      readonly type?: components["schemas"]["PersonType"];
      /** @description Inscrição Estadual (IE) */
      readonly stateTaxNumber?: string | null;
    };
  };
  responses: never;
  parameters: never;
  requestBodies: never;
  headers: never;
  pathItems: never;
};

export type $defs = Record<string, never>;

export type external = Record<string, never>;

export type operations = {

  /**
   * Consultar todas as Empresas da Conta
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para consultar os dados das empresas vinculadas a conta.
   */
  V2CompaniesGet: {
    parameters: {
      query?: {
        /** @description Id de início do contador (Default: Empty) */
        startingAfter?: string;
        /** @description Id final do contador (Default: Empty) */
        endingBefore?: string;
        /** @description Limite de resultados na página (Default: 10) */
        limit?: number;
      };
    };
    responses: {
      /** @description Sucesso na consulta da Empresa */
      200: {
        content: {
          readonly "application/json": {
            /** @description Lista de Empresa */
            readonly companies?: readonly ({
                /** @description Identificador (gerado automaticamente) */
                readonly id?: string;
                /** @description Lista de Inscrição Estadual */
                readonly stateTaxes?: readonly string[];
                /** @description Razão Social */
                readonly name: string;
                /** @description Identificador da conta */
                readonly accountId?: string;
                /** @description Nome Fantasia */
                readonly tradeName: string;
                /**
                 * Format: int64
                 * @description Número de Inscrição Federal (CNPJ)
                 */
                readonly federalTaxNumber: number;
                /**
                 * @description Regime Tributário
                 * @enum {string}
                 */
                readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
                /** @description Endereço */
                readonly address: {
                  /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
                  readonly state: string;
                  /** @description Cidade do Endereço */
                  readonly city: {
                    /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                    readonly code: string;
                    /** @description Nome do Município */
                    readonly name: string;
                  };
                  /** @description Bairro do Endereço */
                  readonly district: string;
                  /** @description Complemento do Endereço, ex.: AP 2, BL A. */
                  readonly additionalInformation?: string;
                  /** @description Logradouro do Endereço */
                  readonly street: string;
                  /** @description Número do Endereço. Usar S/N para "sem número". */
                  readonly number: string;
                  /** @description Cód. Endereço Postal (CEP) */
                  readonly postalCode: string;
                  /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
                  readonly country: string;
                };
              })[];
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Empresa não encontrada */
      404: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Criar uma Empresa
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais.
   * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
   */
  V2CompaniesPost: {
    /** @description Dados da Empresa a ser criada */
    readonly requestBody?: {
      readonly content: {
        readonly "application/json": {
          /** @description Dados da Empresa */
          readonly company?: {
            /** @description Razão Social */
            readonly name: string;
            /** @description Identificador da conta */
            readonly accountId?: string;
            /** @description Nome Fantasia */
            readonly tradeName: string;
            /**
             * Format: int64
             * @description Número de Inscrição Federal (CNPJ)
             */
            readonly federalTaxNumber: number;
            /**
             * @description Regime Tributário
             * @enum {string}
             */
            readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
            /** @description Endereço */
            readonly address: {
              /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
              readonly state: string;
              /** @description Cidade do Endereço */
              readonly city: {
                /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                readonly code: string;
                /** @description Nome do Município */
                readonly name: string;
              };
              /** @description Bairro do Endereço */
              readonly district: string;
              /** @description Complemento do Endereço, ex.: AP 2, BL A. */
              readonly additionalInformation?: string;
              /** @description Logradouro do Endereço */
              readonly street: string;
              /** @description Número do Endereço. Usar S/N para "sem número". */
              readonly number: string;
              /** @description Cód. Endereço Postal (CEP) */
              readonly postalCode: string;
              /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
              readonly country: string;
            };
          };
        };
        readonly "text/json": {
          /** @description Dados da Empresa */
          readonly company?: {
            /** @description Razão Social */
            readonly name: string;
            /** @description Identificador da conta */
            readonly accountId?: string;
            /** @description Nome Fantasia */
            readonly tradeName: string;
            /**
             * Format: int64
             * @description Número de Inscrição Federal (CNPJ)
             */
            readonly federalTaxNumber: number;
            /**
             * @description Regime Tributário
             * @enum {string}
             */
            readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
            /** @description Endereço */
            readonly address: {
              /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
              readonly state: string;
              /** @description Cidade do Endereço */
              readonly city: {
                /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                readonly code: string;
                /** @description Nome do Município */
                readonly name: string;
              };
              /** @description Bairro do Endereço */
              readonly district: string;
              /** @description Complemento do Endereço, ex.: AP 2, BL A. */
              readonly additionalInformation?: string;
              /** @description Logradouro do Endereço */
              readonly street: string;
              /** @description Número do Endereço. Usar S/N para "sem número". */
              readonly number: string;
              /** @description Cód. Endereço Postal (CEP) */
              readonly postalCode: string;
              /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
              readonly country: string;
            };
          };
        };
        readonly "application/*+json": {
          /** @description Dados da Empresa */
          readonly company?: {
            /** @description Razão Social */
            readonly name: string;
            /** @description Identificador da conta */
            readonly accountId?: string;
            /** @description Nome Fantasia */
            readonly tradeName: string;
            /**
             * Format: int64
             * @description Número de Inscrição Federal (CNPJ)
             */
            readonly federalTaxNumber: number;
            /**
             * @description Regime Tributário
             * @enum {string}
             */
            readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
            /** @description Endereço */
            readonly address: {
              /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
              readonly state: string;
              /** @description Cidade do Endereço */
              readonly city: {
                /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                readonly code: string;
                /** @description Nome do Município */
                readonly name: string;
              };
              /** @description Bairro do Endereço */
              readonly district: string;
              /** @description Complemento do Endereço, ex.: AP 2, BL A. */
              readonly additionalInformation?: string;
              /** @description Logradouro do Endereço */
              readonly street: string;
              /** @description Número do Endereço. Usar S/N para "sem número". */
              readonly number: string;
              /** @description Cód. Endereço Postal (CEP) */
              readonly postalCode: string;
              /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
              readonly country: string;
            };
          };
        };
      };
    };
    responses: {
      /** @description Sucesso na criação da Empresa */
      200: {
        content: {
          readonly "application/json": {
            /** @description Dados da Empresa */
            readonly company?: {
              /** @description Identificador (gerado automaticamente) */
              readonly id?: string;
              /** @description Lista de Inscrição Estadual */
              readonly stateTaxes?: readonly string[];
              /** @description Razão Social */
              readonly name: string;
              /** @description Identificador da conta */
              readonly accountId?: string;
              /** @description Nome Fantasia */
              readonly tradeName: string;
              /**
               * Format: int64
               * @description Número de Inscrição Federal (CNPJ)
               */
              readonly federalTaxNumber: number;
              /**
               * @description Regime Tributário
               * @enum {string}
               */
              readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
              /** @description Endereço */
              readonly address: {
                /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
                readonly state: string;
                /** @description Cidade do Endereço */
                readonly city: {
                  /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                  readonly code: string;
                  /** @description Nome do Município */
                  readonly name: string;
                };
                /** @description Bairro do Endereço */
                readonly district: string;
                /** @description Complemento do Endereço, ex.: AP 2, BL A. */
                readonly additionalInformation?: string;
                /** @description Logradouro do Endereço */
                readonly street: string;
                /** @description Número do Endereço. Usar S/N para "sem número". */
                readonly number: string;
                /** @description Cód. Endereço Postal (CEP) */
                readonly postalCode: string;
                /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
                readonly country: string;
              };
            };
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Consultar uma Empresa pelo ID
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para consultar os dados de uma empresas pelo ID.
   */
  V2CompaniesByCompany_idGet: {
    parameters: {
      path: {
        /** @description ID da Empresa que deverá ser retornado */
        company_id: string;
      };
    };
    responses: {
      /** @description Sucesso na consulta da Empresa */
      200: {
        content: {
          readonly "application/json": {
            /** @description Dados da Empresa */
            readonly company?: {
              /** @description Identificador (gerado automaticamente) */
              readonly id?: string;
              /** @description Lista de Inscrição Estadual */
              readonly stateTaxes?: readonly string[];
              /** @description Razão Social */
              readonly name: string;
              /** @description Identificador da conta */
              readonly accountId?: string;
              /** @description Nome Fantasia */
              readonly tradeName: string;
              /**
               * Format: int64
               * @description Número de Inscrição Federal (CNPJ)
               */
              readonly federalTaxNumber: number;
              /**
               * @description Regime Tributário
               * @enum {string}
               */
              readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
              /** @description Endereço */
              readonly address: {
                /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
                readonly state: string;
                /** @description Cidade do Endereço */
                readonly city: {
                  /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                  readonly code: string;
                  /** @description Nome do Município */
                  readonly name: string;
                };
                /** @description Bairro do Endereço */
                readonly district: string;
                /** @description Complemento do Endereço, ex.: AP 2, BL A. */
                readonly additionalInformation?: string;
                /** @description Logradouro do Endereço */
                readonly street: string;
                /** @description Número do Endereço. Usar S/N para "sem número". */
                readonly number: string;
                /** @description Cód. Endereço Postal (CEP) */
                readonly postalCode: string;
                /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
                readonly country: string;
              };
            };
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Empresa não encontrada */
      404: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Alterar uma Empresa pelo ID
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para alterar os dados de uma empresas pelo ID.
   */
  V2CompaniesByCompany_idPut: {
    parameters: {
      path: {
        /** @description ID da Empresa que deverá ser retornado */
        company_id: string;
      };
    };
    /** @description Dados da Empresa a ser alterada */
    readonly requestBody?: {
      readonly content: {
        readonly "application/json": {
          /** @description Dados da Empresa */
          readonly company?: {
            /** @description Identificador (gerado automaticamente) */
            readonly id?: string;
            /** @description Razão Social */
            readonly name: string;
            /** @description Identificador da conta */
            readonly accountId?: string;
            /** @description Nome Fantasia */
            readonly tradeName: string;
            /**
             * Format: int64
             * @description Número de Inscrição Federal (CNPJ)
             */
            readonly federalTaxNumber: number;
            /**
             * @description Regime Tributário
             * @enum {string}
             */
            readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
            /** @description Endereço */
            readonly address: {
              /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
              readonly state: string;
              /** @description Cidade do Endereço */
              readonly city: {
                /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                readonly code: string;
                /** @description Nome do Município */
                readonly name: string;
              };
              /** @description Bairro do Endereço */
              readonly district: string;
              /** @description Complemento do Endereço, ex.: AP 2, BL A. */
              readonly additionalInformation?: string;
              /** @description Logradouro do Endereço */
              readonly street: string;
              /** @description Número do Endereço. Usar S/N para "sem número". */
              readonly number: string;
              /** @description Cód. Endereço Postal (CEP) */
              readonly postalCode: string;
              /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
              readonly country: string;
            };
          };
        };
        readonly "text/json": {
          /** @description Dados da Empresa */
          readonly company?: {
            /** @description Identificador (gerado automaticamente) */
            readonly id?: string;
            /** @description Razão Social */
            readonly name: string;
            /** @description Identificador da conta */
            readonly accountId?: string;
            /** @description Nome Fantasia */
            readonly tradeName: string;
            /**
             * Format: int64
             * @description Número de Inscrição Federal (CNPJ)
             */
            readonly federalTaxNumber: number;
            /**
             * @description Regime Tributário
             * @enum {string}
             */
            readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
            /** @description Endereço */
            readonly address: {
              /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
              readonly state: string;
              /** @description Cidade do Endereço */
              readonly city: {
                /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                readonly code: string;
                /** @description Nome do Município */
                readonly name: string;
              };
              /** @description Bairro do Endereço */
              readonly district: string;
              /** @description Complemento do Endereço, ex.: AP 2, BL A. */
              readonly additionalInformation?: string;
              /** @description Logradouro do Endereço */
              readonly street: string;
              /** @description Número do Endereço. Usar S/N para "sem número". */
              readonly number: string;
              /** @description Cód. Endereço Postal (CEP) */
              readonly postalCode: string;
              /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
              readonly country: string;
            };
          };
        };
        readonly "application/*+json": {
          /** @description Dados da Empresa */
          readonly company?: {
            /** @description Identificador (gerado automaticamente) */
            readonly id?: string;
            /** @description Razão Social */
            readonly name: string;
            /** @description Identificador da conta */
            readonly accountId?: string;
            /** @description Nome Fantasia */
            readonly tradeName: string;
            /**
             * Format: int64
             * @description Número de Inscrição Federal (CNPJ)
             */
            readonly federalTaxNumber: number;
            /**
             * @description Regime Tributário
             * @enum {string}
             */
            readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
            /** @description Endereço */
            readonly address: {
              /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
              readonly state: string;
              /** @description Cidade do Endereço */
              readonly city: {
                /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                readonly code: string;
                /** @description Nome do Município */
                readonly name: string;
              };
              /** @description Bairro do Endereço */
              readonly district: string;
              /** @description Complemento do Endereço, ex.: AP 2, BL A. */
              readonly additionalInformation?: string;
              /** @description Logradouro do Endereço */
              readonly street: string;
              /** @description Número do Endereço. Usar S/N para "sem número". */
              readonly number: string;
              /** @description Cód. Endereço Postal (CEP) */
              readonly postalCode: string;
              /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
              readonly country: string;
            };
          };
        };
      };
    };
    responses: {
      /** @description Sucesso na alteração da Empresa */
      200: {
        content: {
          readonly "application/json": {
            /** @description Dados da Empresa */
            readonly company?: {
              /** @description Identificador (gerado automaticamente) */
              readonly id?: string;
              /** @description Lista de Inscrição Estadual */
              readonly stateTaxes?: readonly string[];
              /** @description Razão Social */
              readonly name: string;
              /** @description Identificador da conta */
              readonly accountId?: string;
              /** @description Nome Fantasia */
              readonly tradeName: string;
              /**
               * Format: int64
               * @description Número de Inscrição Federal (CNPJ)
               */
              readonly federalTaxNumber: number;
              /**
               * @description Regime Tributário
               * @enum {string}
               */
              readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none";
              /** @description Endereço */
              readonly address: {
                /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */
                readonly state: string;
                /** @description Cidade do Endereço */
                readonly city: {
                  /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */
                  readonly code: string;
                  /** @description Nome do Município */
                  readonly name: string;
                };
                /** @description Bairro do Endereço */
                readonly district: string;
                /** @description Complemento do Endereço, ex.: AP 2, BL A. */
                readonly additionalInformation?: string;
                /** @description Logradouro do Endereço */
                readonly street: string;
                /** @description Número do Endereço. Usar S/N para "sem número". */
                readonly number: string;
                /** @description Cód. Endereço Postal (CEP) */
                readonly postalCode: string;
                /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */
                readonly country: string;
              };
            };
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Empresa não encontrada */
      404: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Excluir uma Empresa por ID
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível.
   */
  V2CompaniesByCompany_idDelete: {
    parameters: {
      path: {
        /** @description ID da Empresa que deverá ser retornado */
        company_id: string;
      };
    };
    responses: {
      /** @description Sucesso na exclusão da Empresa */
      204: {
        content: {
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Empresa não encontrada */
      404: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Consultar um Certificado por seu Status
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através d0 **status do certificado** (__status__).
   */
  V2CompaniesByCompany_idCertificatesGet: {
    parameters: {
      query?: {
        /** @description Status do certificado */
        status?: "inactive" | "overdue" | "pending" | "active" | "none";
      };
      path: {
        /** @description ID da Empresa relacionada ao certificado */
        company_id: string;
      };
    };
    responses: {
      /** @description Sucesso na consulta */
      200: {
        content: {
          readonly "application/json": {
            readonly certificates?: readonly ({
                /** @description Nome do certificado (subject distinguished name) */
                readonly subject?: string;
                /**
                 * Format: date-time
                 * @description Data no horário local após o qual um certificado não é mais válido
                 */
                readonly validUntil?: string;
                /** @description A impressão digital do certificado */
                readonly thumbprint?: string;
                /** @description CNPJ da Empresa */
                readonly federalTaxNumber?: string;
                /**
                 * Format: date-time
                 * @description Data de modificação
                 */
                readonly modifiedOn?: string;
                /**
                 * @description Status do certificado
                 * @enum {string}
                 */
                readonly status?: "inactive" | "overdue" | "pending" | "active" | "none";
              })[];
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Upload de um Certificado
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo __e-CNPJ A1__ ou __NFE A1__ em uma **Empresa** e vincula-lo para processamentos.
   *
   * O **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web.
   */
  V2CompaniesByCompany_idCertificatesPost: {
    parameters: {
      path: {
        /** @description ID da empresa */
        company_id: string;
      };
    };
    readonly requestBody: {
      readonly content: {
        readonly "multipart/form-data": {
          /**
           * Format: binary
           * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12
           */
          readonly file: string;
          /** @description Senha do certificado ICP-Brasil */
          readonly password: string;
        };
        readonly "application/form-data": {
          /**
           * Format: binary
           * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12
           */
          readonly file: string;
          /** @description Senha do certificado ICP-Brasil */
          readonly password: string;
        };
      };
    };
    responses: {
      /** @description Sucesso no upload e vinculo com a Empresa */
      200: {
        content: {
          readonly "application/json": {
            /** @description Certificado */
            readonly certificate?: {
              /** @description Nome do certificado (subject distinguished name) */
              readonly subject?: string;
              /**
               * Format: date-time
               * @description Data no horário local após o qual um certificado não é mais válido
               */
              readonly validUntil?: string;
              /** @description A impressão digital do certificado */
              readonly thumbprint?: string;
              /** @description CNPJ da Empresa */
              readonly federalTaxNumber?: string;
              /**
               * Format: date-time
               * @description Data de modificação
               */
              readonly modifiedOn?: string;
              /**
               * @description Status do certificado
               * @enum {string}
               */
              readonly status?: "inactive" | "overdue" | "pending" | "active" | "none";
            };
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Consultar um Certificado por sua impressão digital
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__).
   */
  V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet: {
    parameters: {
      path: {
        /** @description ID da Empresa relacionada ao certificado */
        company_id: string;
        /** @description Impressão digital do certificado */
        certificate_thumbprint: string;
      };
    };
    responses: {
      /** @description Sucesso na consulta */
      200: {
        content: {
          readonly "application/json": {
            /** @description Certificado */
            readonly certificate?: {
              /** @description Nome do certificado (subject distinguished name) */
              readonly subject?: string;
              /**
               * Format: date-time
               * @description Data no horário local após o qual um certificado não é mais válido
               */
              readonly validUntil?: string;
              /** @description A impressão digital do certificado */
              readonly thumbprint?: string;
              /** @description CNPJ da Empresa */
              readonly federalTaxNumber?: string;
              /**
               * Format: date-time
               * @description Data de modificação
               */
              readonly modifiedOn?: string;
              /**
               * @description Status do certificado
               * @enum {string}
               */
              readonly status?: "inactive" | "overdue" | "pending" | "active" | "none";
            };
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Certificado não encontrado */
      404: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Excluir um Certificado por sua impressão digital
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**.
   *
   * **ATENÇÃO pois esta requisição é irreversível**
   */
  V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete: {
    parameters: {
      path: {
        /** @description ID da Empresa relacionada ao certificado */
        company_id: string;
        /** @description Impressão digital do certificado */
        certificate_thumbprint: string;
      };
    };
    responses: {
      /** @description Sucesso na exclusão e desvinculo com a Empresa */
      204: {
        content: {
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Certificado não encontrado */
      404: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Listar as Inscrições Estaduais
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__.
   * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
   * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
   */
  V2CompaniesByCompany_idStatetaxesGet: {
    parameters: {
      query?: {
        /** @description Id de início do contador (Default: Empty) */
        startingAfter?: string;
        /** @description Id final do contador (Default: Empty) */
        endingBefore?: string;
        /** @description Limite de resultados na página (Default: 10) */
        limit?: number;
      };
      path: {
        /** @description ID da Empresa */
        company_id: string;
      };
    };
    responses: {
      /** @description Sucesso na criação da Inscrição Estadual */
      200: {
        content: {
          readonly "application/json": {
            /** @description Lista de Inscriçoes Estaduais */
            readonly stateTaxes?: readonly ({
                /** @description Código da Empresa */
                readonly companyId?: string;
                /** @description Account Id */
                readonly accountId?: string;
                /**
                 * @description Status no sistema
                 * @enum {string}
                 */
                readonly status?: "inactive" | "none" | "active";
                /** @description Todas as séries para esta Inscrição Estadual */
                readonly series?: readonly number[];
                /**
                 * Format: date-time
                 * @description Data de criação
                 */
                readonly createdOn?: string;
                /**
                 * Format: date-time
                 * @description Data de modificação
                 */
                readonly modifiedOn?: string;
                /**
                 * Format: int64
                 * @description Número do Lote
                 */
                readonly batchId?: number;
                /** @description Identificador (gerado automaticamente) */
                readonly id?: string;
                /**
                 * @description Código do Estado
                 * @enum {string}
                 */
                readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
                /**
                 * @description Ambiente
                 * @enum {string}
                 */
                readonly environmentType?: "none" | "production" | "test";
                /** @description Inscrição Estadual */
                readonly taxNumber: string;
                /**
                 * @description Tipo do regime especial de tributação
                 * @enum {string}
                 */
                readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
                /**
                 * Format: int32
                 * @description Serie para a emissão NFe
                 */
                readonly serie: number;
                /**
                 * Format: int64
                 * @description Número para a emissão NFe
                 */
                readonly number: number;
                /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
                readonly securityCredential?: {
                  /**
                   * Format: int32
                   * @description Id do código de segurança do contribuinte
                   */
                  readonly id?: number;
                  /** @description Código de segurança do contribuinte */
                  readonly code?: string;
                };
                /**
                 * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
                 * @enum {string}
                 */
                readonly type?: "default" | "nFe" | "nFCe";
              })[];
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Criar uma Inscrição Estadual
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__.
   * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
   * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
   */
  V2CompaniesByCompany_idStatetaxesPost: {
    parameters: {
      path: {
        /** @description ID da Empresa */
        company_id: string;
      };
    };
    /** @description Dados da Inscrição Estadual a ser criada */
    readonly requestBody?: {
      readonly content: {
        readonly "application/json": {
          /** @description Dados da Inscrição Estadual */
          readonly stateTax?: {
            /**
             * @description Código do Estado
             * @enum {string}
             */
            readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
            /**
             * @description Ambiente
             * @enum {string}
             */
            readonly environmentType?: "none" | "production" | "test";
            /** @description Inscrição Estadual */
            readonly taxNumber: string;
            /**
             * @description Tipo do regime especial de tributação
             * @enum {string}
             */
            readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
            /**
             * Format: int32
             * @description Serie para a emissão NFe
             */
            readonly serie: number;
            /**
             * Format: int64
             * @description Número para a emissão NFe
             */
            readonly number: number;
            /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
            readonly securityCredential?: {
              /**
               * Format: int32
               * @description Id do código de segurança do contribuinte
               */
              readonly id?: number;
              /** @description Código de segurança do contribuinte */
              readonly code?: string;
            };
            /**
             * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
             * @enum {string}
             */
            readonly type?: "default" | "nFe" | "nFCe";
          };
        };
        readonly "text/json": {
          /** @description Dados da Inscrição Estadual */
          readonly stateTax?: {
            /**
             * @description Código do Estado
             * @enum {string}
             */
            readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
            /**
             * @description Ambiente
             * @enum {string}
             */
            readonly environmentType?: "none" | "production" | "test";
            /** @description Inscrição Estadual */
            readonly taxNumber: string;
            /**
             * @description Tipo do regime especial de tributação
             * @enum {string}
             */
            readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
            /**
             * Format: int32
             * @description Serie para a emissão NFe
             */
            readonly serie: number;
            /**
             * Format: int64
             * @description Número para a emissão NFe
             */
            readonly number: number;
            /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
            readonly securityCredential?: {
              /**
               * Format: int32
               * @description Id do código de segurança do contribuinte
               */
              readonly id?: number;
              /** @description Código de segurança do contribuinte */
              readonly code?: string;
            };
            /**
             * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
             * @enum {string}
             */
            readonly type?: "default" | "nFe" | "nFCe";
          };
        };
        readonly "application/*+json": {
          /** @description Dados da Inscrição Estadual */
          readonly stateTax?: {
            /**
             * @description Código do Estado
             * @enum {string}
             */
            readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
            /**
             * @description Ambiente
             * @enum {string}
             */
            readonly environmentType?: "none" | "production" | "test";
            /** @description Inscrição Estadual */
            readonly taxNumber: string;
            /**
             * @description Tipo do regime especial de tributação
             * @enum {string}
             */
            readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
            /**
             * Format: int32
             * @description Serie para a emissão NFe
             */
            readonly serie: number;
            /**
             * Format: int64
             * @description Número para a emissão NFe
             */
            readonly number: number;
            /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
            readonly securityCredential?: {
              /**
               * Format: int32
               * @description Id do código de segurança do contribuinte
               */
              readonly id?: number;
              /** @description Código de segurança do contribuinte */
              readonly code?: string;
            };
            /**
             * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
             * @enum {string}
             */
            readonly type?: "default" | "nFe" | "nFCe";
          };
        };
      };
    };
    responses: {
      /** @description Sucesso na criação da Inscrição Estadual */
      200: {
        content: {
          readonly "application/json": {
            /** @description Dados da Inscrição Estadual */
            readonly stateTax?: {
              /** @description Código da Empresa */
              readonly companyId?: string;
              /** @description Account Id */
              readonly accountId?: string;
              /**
               * @description Status no sistema
               * @enum {string}
               */
              readonly status?: "inactive" | "none" | "active";
              /** @description Todas as séries para esta Inscrição Estadual */
              readonly series?: readonly number[];
              /**
               * Format: date-time
               * @description Data de criação
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação
               */
              readonly modifiedOn?: string;
              /**
               * Format: int64
               * @description Número do Lote
               */
              readonly batchId?: number;
              /** @description Identificador (gerado automaticamente) */
              readonly id?: string;
              /**
               * @description Código do Estado
               * @enum {string}
               */
              readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
              /**
               * @description Ambiente
               * @enum {string}
               */
              readonly environmentType?: "none" | "production" | "test";
              /** @description Inscrição Estadual */
              readonly taxNumber: string;
              /**
               * @description Tipo do regime especial de tributação
               * @enum {string}
               */
              readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
              /**
               * Format: int32
               * @description Serie para a emissão NFe
               */
              readonly serie: number;
              /**
               * Format: int64
               * @description Número para a emissão NFe
               */
              readonly number: number;
              /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
              readonly securityCredential?: {
                /**
                 * Format: int32
                 * @description Id do código de segurança do contribuinte
                 */
                readonly id?: number;
                /** @description Código de segurança do contribuinte */
                readonly code?: string;
              };
              /**
               * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
               * @enum {string}
               */
              readonly type?: "default" | "nFe" | "nFCe";
            };
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Consultar uma Inscrição Estadual pelo ID
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para consultar os dados de uma empresas pelo ID.
   * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
   * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
   */
  V2CompaniesByCompany_idStatetaxesByState_tax_idGet: {
    parameters: {
      path: {
        /** @description ID da Empresa */
        company_id: string;
        /** @description ID da Inscrição Estadual que deverá ser retornado */
        state_tax_id: string;
      };
    };
    responses: {
      /** @description Sucesso na consulta da Inscrição Estadual */
      200: {
        content: {
          readonly "application/json": {
            /** @description Dados da Inscrição Estadual */
            readonly stateTax?: {
              /** @description Código da Empresa */
              readonly companyId?: string;
              /** @description Account Id */
              readonly accountId?: string;
              /**
               * @description Status no sistema
               * @enum {string}
               */
              readonly status?: "inactive" | "none" | "active";
              /** @description Todas as séries para esta Inscrição Estadual */
              readonly series?: readonly number[];
              /**
               * Format: date-time
               * @description Data de criação
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação
               */
              readonly modifiedOn?: string;
              /**
               * Format: int64
               * @description Número do Lote
               */
              readonly batchId?: number;
              /** @description Identificador (gerado automaticamente) */
              readonly id?: string;
              /**
               * @description Código do Estado
               * @enum {string}
               */
              readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
              /**
               * @description Ambiente
               * @enum {string}
               */
              readonly environmentType?: "none" | "production" | "test";
              /** @description Inscrição Estadual */
              readonly taxNumber: string;
              /**
               * @description Tipo do regime especial de tributação
               * @enum {string}
               */
              readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
              /**
               * Format: int32
               * @description Serie para a emissão NFe
               */
              readonly serie: number;
              /**
               * Format: int64
               * @description Número para a emissão NFe
               */
              readonly number: number;
              /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
              readonly securityCredential?: {
                /**
                 * Format: int32
                 * @description Id do código de segurança do contribuinte
                 */
                readonly id?: number;
                /** @description Código de segurança do contribuinte */
                readonly code?: string;
              };
              /**
               * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
               * @enum {string}
               */
              readonly type?: "default" | "nFe" | "nFCe";
            };
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Inscrição Estadual não encontrada */
      404: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Alterar uma Inscrição Estadual pelo ID
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID.
   * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
   * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
   */
  V2CompaniesByCompany_idStatetaxesByState_tax_idPut: {
    parameters: {
      path: {
        /** @description ID da Empresa */
        company_id: string;
        /** @description ID da Inscrição Estadual que deverá ser retornado */
        state_tax_id: string;
      };
    };
    /** @description Dados da Inscrição Estadual a ser alterada */
    readonly requestBody?: {
      readonly content: {
        readonly "application/json": {
          /** @description Dados da Inscrição Estadual */
          readonly stateTax?: {
            /** @description Identificador (gerado automaticamente) */
            readonly id?: string;
            /**
             * @description Código do Estado
             * @enum {string}
             */
            readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
            /**
             * @description Ambiente
             * @enum {string}
             */
            readonly environmentType?: "none" | "production" | "test";
            /** @description Inscrição Estadual */
            readonly taxNumber: string;
            /**
             * @description Tipo do regime especial de tributação
             * @enum {string}
             */
            readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
            /**
             * Format: int32
             * @description Serie para a emissão NFe
             */
            readonly serie: number;
            /**
             * Format: int64
             * @description Número para a emissão NFe
             */
            readonly number: number;
            /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
            readonly securityCredential?: {
              /**
               * Format: int32
               * @description Id do código de segurança do contribuinte
               */
              readonly id?: number;
              /** @description Código de segurança do contribuinte */
              readonly code?: string;
            };
            /**
             * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
             * @enum {string}
             */
            readonly type?: "default" | "nFe" | "nFCe";
          };
        };
        readonly "text/json": {
          /** @description Dados da Inscrição Estadual */
          readonly stateTax?: {
            /** @description Identificador (gerado automaticamente) */
            readonly id?: string;
            /**
             * @description Código do Estado
             * @enum {string}
             */
            readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
            /**
             * @description Ambiente
             * @enum {string}
             */
            readonly environmentType?: "none" | "production" | "test";
            /** @description Inscrição Estadual */
            readonly taxNumber: string;
            /**
             * @description Tipo do regime especial de tributação
             * @enum {string}
             */
            readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
            /**
             * Format: int32
             * @description Serie para a emissão NFe
             */
            readonly serie: number;
            /**
             * Format: int64
             * @description Número para a emissão NFe
             */
            readonly number: number;
            /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
            readonly securityCredential?: {
              /**
               * Format: int32
               * @description Id do código de segurança do contribuinte
               */
              readonly id?: number;
              /** @description Código de segurança do contribuinte */
              readonly code?: string;
            };
            /**
             * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
             * @enum {string}
             */
            readonly type?: "default" | "nFe" | "nFCe";
          };
        };
        readonly "application/*+json": {
          /** @description Dados da Inscrição Estadual */
          readonly stateTax?: {
            /** @description Identificador (gerado automaticamente) */
            readonly id?: string;
            /**
             * @description Código do Estado
             * @enum {string}
             */
            readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
            /**
             * @description Ambiente
             * @enum {string}
             */
            readonly environmentType?: "none" | "production" | "test";
            /** @description Inscrição Estadual */
            readonly taxNumber: string;
            /**
             * @description Tipo do regime especial de tributação
             * @enum {string}
             */
            readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
            /**
             * Format: int32
             * @description Serie para a emissão NFe
             */
            readonly serie: number;
            /**
             * Format: int64
             * @description Número para a emissão NFe
             */
            readonly number: number;
            /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
            readonly securityCredential?: {
              /**
               * Format: int32
               * @description Id do código de segurança do contribuinte
               */
              readonly id?: number;
              /** @description Código de segurança do contribuinte */
              readonly code?: string;
            };
            /**
             * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
             * @enum {string}
             */
            readonly type?: "default" | "nFe" | "nFCe";
          };
        };
      };
    };
    responses: {
      /** @description Sucesso na alteração da Inscrição Estadual */
      200: {
        content: {
          readonly "application/json": {
            /** @description Dados da Inscrição Estadual */
            readonly stateTax?: {
              /** @description Código da Empresa */
              readonly companyId?: string;
              /** @description Account Id */
              readonly accountId?: string;
              /**
               * @description Status no sistema
               * @enum {string}
               */
              readonly status?: "inactive" | "none" | "active";
              /** @description Todas as séries para esta Inscrição Estadual */
              readonly series?: readonly number[];
              /**
               * Format: date-time
               * @description Data de criação
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação
               */
              readonly modifiedOn?: string;
              /**
               * Format: int64
               * @description Número do Lote
               */
              readonly batchId?: number;
              /** @description Identificador (gerado automaticamente) */
              readonly id?: string;
              /**
               * @description Código do Estado
               * @enum {string}
               */
              readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA";
              /**
               * @description Ambiente
               * @enum {string}
               */
              readonly environmentType?: "none" | "production" | "test";
              /** @description Inscrição Estadual */
              readonly taxNumber: string;
              /**
               * @description Tipo do regime especial de tributação
               * @enum {string}
               */
              readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte";
              /**
               * Format: int32
               * @description Serie para a emissão NFe
               */
              readonly serie: number;
              /**
               * Format: int64
               * @description Número para a emissão NFe
               */
              readonly number: number;
              /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */
              readonly securityCredential?: {
                /**
                 * Format: int32
                 * @description Id do código de segurança do contribuinte
                 */
                readonly id?: number;
                /** @description Código de segurança do contribuinte */
                readonly code?: string;
              };
              /**
               * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe
               * @enum {string}
               */
              readonly type?: "default" | "nFe" | "nFCe";
            };
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Inscrição Estadual não encontrada */
      404: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Excluir uma Inscrição Estadual pelo ID
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível.
   * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.
   * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.
   */
  V2CompaniesByCompany_idStatetaxesByState_tax_idDelete: {
    parameters: {
      path: {
        /** @description ID da Empresa */
        company_id: string;
        /** @description ID da Inscrição Estadual que deverá ser retornado */
        state_tax_id: string;
      };
    };
    responses: {
      /** @description Sucesso na exclusão da Inscrição Estadual */
      204: {
        content: {
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Inscrição Estadual não encontrada */
      404: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
  /**
   * Consultar um webhook existente
   * @description ### Informações adicionais
   *
   * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**.
   */
  RegistrationLookupAction: {
    parameters: {
      path: {
        /** @description ID do webhook a ser consultado */
        webhook_id: string;
      };
    };
    responses: {
      /** @description Sucesso na consulta do webhook */
      200: {
        content: {
          readonly "application/json": {
            /** @description WebHook (Notificação HTTP) */
            readonly webHook?: {
              /**
               * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de
               * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID.
               */
              readonly id?: string;
              /** @description A URL onde as notificações dos eventos deverão entregues. */
              readonly uri: string;
              /**
               * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor
               * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.
               * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado.
               */
              readonly secret?: string;
              /**
               * Format: int32
               * @description WebHook Media Type
               * @enum {integer}
               */
              readonly contentType?: 0 | 1;
              /**
               * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.
               * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**.
               */
              readonly insecureSsl?: boolean;
              /**
               * Format: int32
               * @description WebHook Status
               * @enum {integer}
               */
              readonly status?: 0 | 1;
              /**
               * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook.
               * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado.
               * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**.
               */
              readonly filters?: readonly string[];
              /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */
              readonly headers?: {
                [key: string]: string;
              };
              /**
               * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas
               * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP.
               */
              readonly properties?: {
                [key: string]: Record<string, never>;
              };
              /**
               * Format: date-time
               * @description Data de criação do webhook
               */
              readonly createdOn?: string;
              /**
               * Format: date-time
               * @description Data de modificação do webhook
               */
              readonly modifiedOn?: string;
            };
          };
        };
      };
      /** @description Algum parametro informado não é válido, verificar resposta */
      400: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
      /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */
      401: {
        content: {
        };
      };
      /** @description Accesso proibido */
      403: {
        content: {
        };
      };
      /** @description Webhook não encontrado */
      404: {
        content: {
        };
      };
      /** @description Erro no processamento */
      500: {
        content: {
          readonly "application/json": {
            /** @description Lista de Erros */
            readonly errors?: readonly {
                /**
                 * Format: int32
                 * @description Código do erro
                 */
                readonly code?: number;
                /** @description Mensagem contendo os detalhes do erro */
                readonly message?: string;
              }[];
          };
        };
      };
    };
  };
};