# Consistem ERP Software de Gestão Empresarial O Consistem ERP é a ferramenta ideal para impulsionar o seu negócio. Com funcionalidades que atendem a cada segmento, a ferramenta oferece todo o suporte necessário para potencializar as operações cotidianas da sua organização. {% columns %} {% column %}
{% endcolumn %} {% column %} #### Arquitetura Plataforma baseada em ambiente 100% Web.\ **Core e Módulos**\ Funcionalidades lógicas e regras de negócio.\ **Componentes**\ Interface visual e recursos tecnológicos. Saiba mais {% endcolumn %} {% endcolumns %} {% columns %} {% column %} #### Inteligência Artificial A Clara é a assistente virtual inteligente integrada ao Consistem ERP, desenvolvida para facilitar a sua rotina de trabalho. Saiba mais {% endcolumn %} {% column %}
{% endcolumn %} {% endcolumns %} {% columns %} {% column width="50%" %}
{% endcolumn %} {% column width="50%" %} #### Workspace O Workspace organiza as informações essenciais para apoiar suas decisões estratégicas de forma rápida, visual e objetiva.\ \ Saiba mais {% endcolumn %} {% endcolumns %} {% columns %} {% column %} #### Interface Uma experiência de uso projetada para entregar a máxima produtividade no dia a dia da sua indústria, garantindo um ambiente de trabalho intuitivo, ágil e sem rupturas operacionais.\ \ Saiba mais {% endcolumn %} {% column %}
{% endcolumn %} {% endcolumns %} # Consistem API Interoperabilidade segura entre módulos e aplicações de terceiros. A **Consistem** desenvolveu APIs próprias para viabilizar e gerenciar a integração entre seus módulos e softwares de terceiros de forma segura. ### O que é uma API? A sigla API significa *Application Programming Interface* (Interface de Programação de Aplicação). Ela consiste em um conjunto de padrões e rotinas que atuam como uma ponte entre sistemas.\ \ Na prática, a API funciona como uma intermediária entre o **Consistem ERP** e outros programas: ela recebe uma solicitação, verifica se o solicitante possui as permissões adequadas e, se autorizado, entrega os dados conforme as regras estabelecidas. ### Licenciamento e Uso * **Ambiente de Homologação (Testes)**\ Todas as APIs desenvolvidas estão liberadas para uso e testes neste ambiente. * **Ambiente de Produção**\ Para utilizar as APIs no ambiente real de trabalho, é necessário realizar o licenciamento junto ao setor comercial da Consistem. {% hint style="warning" %} **Importante**\ Esta documentação de API reflete sempre a versão mais recente do sistema, em conformidade com a [Política de Ciclo de Vida do Consistem ERP](https://cliente.consistem.com.br/normas/ciclo-de-vida/).\ Caso sua instalação utilize uma versão anterior, algumas funcionalidades aqui descritas podem não estar disponíveis. {% endhint %}

Esse conteúdo foi útil?

Sim Não

# Chave de Acesso Consistem API ### Como obter a Chave de Acesso (API Token) A autenticação na API é feita através de um token único gerado diretamente no **Consistem ERP**.\ Siga os passos abaixo: 1. Acesse o programa [Cadastro de Usuário (CSMEN050)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-usuario). 2. Informe ou pesquise o **código do usuário** que será utilizado para a integração. 3. Clique na [Aba Segurança](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-usuario/aba-seguranca#gerar-token). 4. Pressione o botão **Gerar Token.** 5. O código será exibido no campo **API Token**. {% hint style="info" %} **Importante**\ Copie esta chave e armazene-a em local seguro, pois ela será exigida em todas as requisições da API. {% endhint %}

Cadastro de Usuário - Aba Segurança

### Liberar Permissões e Acessar Documentação Para definir quais APIs esse usuário pode acessar e visualizar a documentação técnica do seu ambiente: 1. Ainda no programa [Cadastro de Usuário (CSMEN050)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-usuario), acesse a [Aba Serviço](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-usuario/aba-servico); 2. Selecione o **Módulo** desejado no campo de filtro. 3. No grid, localize o serviço desejado e **marque a caixa de seleção (check)** na linha correspondente. 4. Acione o botão **Salvar** para gravar as alterações. 5. Clique no botão **Visualizar Documentação**.\ \&#xNAN;*Esta ação abrirá o portal de API correspondente à instalação do seu ambiente.* {% hint style="warning" %} **Atenção**\ A API só poderá ser executada se o serviço estiver marcado e o registro devidamente salvo. {% endhint %}

Cadastro de Usuário - Aba Serviço

Esse conteúdo foi útil?

Sim Não

# Portal da API Consistem API O **Consistem ERP** fornece uma interface interativa baseada em Swagger, permitindo a visualização dos endpoints disponíveis e a execução de testes de requisições em tempo real diretamente no seu ambiente.\ \ Para acessar o **Portal da API**, utilize o endereço do seu ambiente seguido de `/api/`: {% hint style="info" %} https\://**URL\_ACESSO\_ERP**/api/ {% endhint %} ## Como Testar as APIs Você pode testar as integrações diretamente através da interface do Swagger instalada no seu servidor do **Consistem ERP.**

Portal da API

### Obtenção da chave de acesso (Token) Utilize a chave gerada através do [Cadastro de Usuário (CSMEN050)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-usuario).\ Para instruções detalhadas de geração, acesse a documentação de [Chave de acesso](/consistem-api/autenticacao/obter-uma-chave-de-acesso). ### Autenticação no Portal Antes de realizar qualquer teste, é necessário autenticar sua sessão: 1. Clique no botão **Authorize** (cadeado). 2. No campo `Value`, informe o **token** gerado anteriormente. 3. Clique novamente em **Authorize** e, em seguida, em **Close**.
### Executando uma Requisição Com a sessão autenticada, você pode simular chamadas reais: 1. Selecione o grupo e o serviço desejado (Ex: `Cadastros Gerais` -> `GET /empresa/id`). 2. Clique no botão **Try it out** para habilitar a edição. 3. Preencha os parâmetros solicitados (campos marcados com `*` são obrigatórios). 4. Clique no botão **Execute**.
### Analisando a Resposta Logo abaixo, a interface exibirá o **Response body** (dados retornados) e o **Code** ([status da resposta,](/consistem-api/guias-tecnicos/codigos-de-status-das-respostas) ex: 200, 404, 500).
{% hint style="info" %} **Nota**\ As APIs seguem padrões de mercado e podem ser executadas em qualquer ferramenta externa de sua preferência, como o Postman ou Insomnia. {% endhint %}

Esse conteúdo foi útil?

Sim Não

# Comercial # Cadastros Gerais v1.0 # Empresa empresa ## GET /empresa > Obter Listagem de Empresas ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Empresa","description":"empresa"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaEmpresas":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Empresa"}}}},"Empresa":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa (1/2)"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Empresa"},"nome":{"type":"string","description":"Nome da Empresa"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"situacao":{"type":"integer","description":"Situação da Empresa (0-Inativo, 1-Ativo)","enum":[0,1]},"nomeFantasia":{"type":"string","description":"Descrição do Nome Fantasia da Empresa"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade da Empresa (1-Indústria, 2-Comércio, 3-Prestação de Serviços, 4-Indústria/Comércio, 5-Indústria/Serviço, 6-Indústria/Comércio/Serviço, 7-Comércio/Serviços, 9-Outros)","enum":[1,2,3,4,5,6,7,9]},"endereco":{"type":"string","description":"Endereço da Empresa"},"numero":{"type":"string","description":"Número do Endereço da Empresa"},"complemento":{"type":"string","description":"Complemento do Endereço da Empresa"},"bairro":{"type":"string","description":"Bairro da Empresa"},"cep":{"type":"string","description":"Código do CEP da Empresa (99999-999)"},"cidade":{"type":"string","description":"Nome da Cidade da Empresa"},"estado":{"type":"string","description":"Estado da Empresa"},"codIbge":{"type":"string","description":"Código do IBGE da Empresa"},"telefoneDDD":{"type":"string","description":"DDD do Telefone da Empresa (047/041)"},"telefonePrefixo":{"type":"string","description":"Prefixo do Telefone da Empresa"},"telefone":{"type":"string","description":"Telefone da Empresa"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/empresa":{"get":{"tags":["Empresa"],"summary":"Obter Listagem de Empresas","operationId":"ObterEmpresas","parameters":[{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Situação da Empresa (0 - Inativo, 1 - Ativo)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaEmpresas"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /empresa/{id} > Obter uma Empresa ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Empresa","description":"empresa"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Empresa":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa (1/2)"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Empresa"},"nome":{"type":"string","description":"Nome da Empresa"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"situacao":{"type":"integer","description":"Situação da Empresa (0-Inativo, 1-Ativo)","enum":[0,1]},"nomeFantasia":{"type":"string","description":"Descrição do Nome Fantasia da Empresa"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade da Empresa (1-Indústria, 2-Comércio, 3-Prestação de Serviços, 4-Indústria/Comércio, 5-Indústria/Serviço, 6-Indústria/Comércio/Serviço, 7-Comércio/Serviços, 9-Outros)","enum":[1,2,3,4,5,6,7,9]},"endereco":{"type":"string","description":"Endereço da Empresa"},"numero":{"type":"string","description":"Número do Endereço da Empresa"},"complemento":{"type":"string","description":"Complemento do Endereço da Empresa"},"bairro":{"type":"string","description":"Bairro da Empresa"},"cep":{"type":"string","description":"Código do CEP da Empresa (99999-999)"},"cidade":{"type":"string","description":"Nome da Cidade da Empresa"},"estado":{"type":"string","description":"Estado da Empresa"},"codIbge":{"type":"string","description":"Código do IBGE da Empresa"},"telefoneDDD":{"type":"string","description":"DDD do Telefone da Empresa (047/041)"},"telefonePrefixo":{"type":"string","description":"Prefixo do Telefone da Empresa"},"telefone":{"type":"string","description":"Telefone da Empresa"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/empresa/{id}":{"get":{"tags":["Empresa"],"summary":"Obter uma Empresa","operationId":"ObterEmpresa","parameters":[{"name":"id","in":"path","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empresa"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Representante representante ## GET /representante > Obter listagem de Representantes ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaRepresentantes":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Representante"}}}},"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (1 - Produto, 2 - Representante, 3 - Condição de Venda 1 Sequencia, 4 - Condição de Venda 2 Sequencia, 5 - Condição de Venda 3 Sequencia, 6 - Tabela de Preço)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante":{"get":{"tags":["Representante"],"summary":"Obter listagem de Representantes","operationId":"ObterRepresentantes","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Situações do Representante (1-Fisica, 2-Juridica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","schema":{"type":"string"}},{"name":"paginacao","in":"query","description":"Quantidade de itens na paginação de retorno","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaRepresentantes"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /representante > Cadastrar um Representante ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RepresentantePut":{"required":["bairro","cep","cpfCnpj","dataAdmissao","endereco","nome","situacao","tipoComissao"],"type":"object","properties":{"codRepresentante":{"maximum":9999,"type":"integer","description":"Código do Representante (1 / 124 / 45)"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Representante (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Representante (Rua / Logradouro)"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro do Representante"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"CEP do Representante (sem formatação)"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Representante"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Representante"},"codIbge":{"maxLength":7,"minLength":7,"type":"string","description":"Código do IBGE do Representante"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"maxLength":20,"type":"string","description":"Telefone Celular do Representante"},"contato":{"maxLength":30,"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão (1-Produto, 2-Representante, 3-Condição de Venda 1 Sequencia, 4-Condição de Venda 2 Sequencia, 5-Condição de Venda 3 Sequencia, 6-Tabela de Preço)","enum":[1,2,3,4,5,6]},"percComissao":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante (5.00%)"},"email":{"maxLength":60,"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante (YYYY-MM-DD)","format":"date"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (1 - Produto, 2 - Representante, 3 - Condição de Venda 1 Sequencia, 4 - Condição de Venda 2 Sequencia, 5 - Condição de Venda 3 Sequencia, 6 - Tabela de Preço)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante":{"put":{"tags":["Representante"],"summary":"Cadastrar um Representante","operationId":"CadastrarRepresentante","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Representante","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentantePut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Representante"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /representante/{id} > Obter um Representante ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (1 - Produto, 2 - Representante, 3 - Condição de Venda 1 Sequencia, 4 - Condição de Venda 2 Sequencia, 5 - Condição de Venda 3 Sequencia, 6 - Tabela de Preço)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante/{id}":{"get":{"tags":["Representante"],"summary":"Obter um Representante","operationId":"ObterRepresentante","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Representante","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Representante"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /representante/{id} > Atualizar um Representante ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RepresentantePut":{"required":["bairro","cep","cpfCnpj","dataAdmissao","endereco","nome","situacao","tipoComissao"],"type":"object","properties":{"codRepresentante":{"maximum":9999,"type":"integer","description":"Código do Representante (1 / 124 / 45)"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Representante (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Representante (Rua / Logradouro)"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro do Representante"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"CEP do Representante (sem formatação)"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Representante"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Representante"},"codIbge":{"maxLength":7,"minLength":7,"type":"string","description":"Código do IBGE do Representante"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"maxLength":20,"type":"string","description":"Telefone Celular do Representante"},"contato":{"maxLength":30,"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão (1-Produto, 2-Representante, 3-Condição de Venda 1 Sequencia, 4-Condição de Venda 2 Sequencia, 5-Condição de Venda 3 Sequencia, 6-Tabela de Preço)","enum":[1,2,3,4,5,6]},"percComissao":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante (5.00%)"},"email":{"maxLength":60,"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante (YYYY-MM-DD)","format":"date"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (1 - Produto, 2 - Representante, 3 - Condição de Venda 1 Sequencia, 4 - Condição de Venda 2 Sequencia, 5 - Condição de Venda 3 Sequencia, 6 - Tabela de Preço)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante/{id}":{"put":{"tags":["Representante"],"summary":"Atualizar um Representante","operationId":"AtualizarRepresentante","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Representante","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Representante","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepresentantePut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Representante"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /representante/{id} > Excluir um Representante ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Representante","description":"representante"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/representante/{id}":{"delete":{"tags":["Representante"],"summary":"Excluir um Representante","operationId":"ExcluirRepresentante","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Representante","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Clientes cliente ## GET /cliente > Obter Listagem de Clientes ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Clientes","description":"cliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaClientes":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Cliente"}}}},"Cliente":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Cliente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Cliente"},"nome":{"type":"string","description":"Nome do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"type":"integer","description":"Código do Terceiro Representante"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Representante"},"inscSuframa":{"type":"string","description":"Código da Inscrição Suframa Representante"},"contatoCompras":{"type":"string","description":"Contato de Compras do Cliente"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"codSetorVenda":{"type":"integer","description":"Código do Setor de venda do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Cliente"},"numero":{"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"type":"string","description":"Bairro do Cliente"},"cep":{"type":"string","description":"Código do CEP do Cliente"},"cidade":{"type":"string","description":"Cidade do Cliente"},"estado":{"type":"string","description":"Estado do Cliente"},"codIbge":{"type":"string","description":"Código do IBGE do Cliente"},"email":{"type":"string","description":"E-mail do Cliente"},"emailNfe":{"type":"string","description":"E-mail do Cliente para envio da Nota Fiscal Eletrônica"},"telefone":{"type":"string","description":"Telefone do Cliente"},"telefoneCobranca":{"type":"string","description":"Telefone de Cobrança do Cliente"},"fax":{"type":"string","description":"Fax do Cliente"},"telexCelular":{"type":"string","description":"Telefone Celular do Cliente"},"observacao":{"type":"string","description":"Observação do Cadastro do Cliente"},"aliqIcms":{"type":"string","description":"Aliquota de ICMS da UF do Cliente [Deprecado]"},"percAliqICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS da UF do Cliente"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito do Cliente"},"valorMaiorAcumulo":{"type":"number","description":"Valor Maior Acumulado do Cliente"},"dataMaiorFatura":{"type":"string","description":"Data da Maior Fatura do Cliente","format":"date"},"dataPrimeiraCompra":{"type":"string","description":"Data da Primeira Compra do Cliente","format":"date"},"dataCadastro":{"type":"string","description":"Data do Cadastro do Cliente","format":"date"},"valorTotalFaturado":{"multipleOf":0.01,"type":"number","description":"Valor Total já Faturado do Cliente"},"prazoMedioVendas":{"type":"string","description":"Prazo médio de Vendas do Cliente"},"clienteCentralizador":{"type":"integer","description":"Código do Cliente Centralizador"},"cnpjClienteCentralizador":{"type":"string","description":"Código do CNPJ do Cliente Centralizador"},"codSubRamoAtiv":{"type":"integer","description":"Sub Ramo de Atividade"},"codBacen":{"type":"integer","description":"Código do Bacen"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"dadosCobranca":{"type":"array","description":"Dados de Cobrança do Cliente","items":{"$ref":"#/components/schemas/ClienteDadosCobranca"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"informacoesComplementares":{"type":"array","description":"Informações Complementares do Cliente","items":{"$ref":"#/components/schemas/ClienteInfComplementares"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"grupoComercial":{"type":"array","description":"Grupo Comercial do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoComercial"}},"grupoCNPJ":{"type":"array","description":"Grupo CNPJ do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoCNPJ"}},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}},"ClienteDadosCobranca":{"type":"object","properties":{"codPortador":{"maxLength":4,"type":"string","description":"Código do Portador"},"codTipoCobranca":{"maxLength":3,"type":"string","description":"Código do Tipo de Cobrança"},"codCondicaoPagamento":{"maxLength":3,"type":"string","description":"Código da Condição de Pagamento"}}},"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}},"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}},"ClienteInfComplementares":{"type":"object","properties":{"codAtendente":{"maxLength":4,"type":"string","description":"Código do Atendente"},"nomeAtendente":{"maxLength":60,"type":"string","description":"Nome do Atendente"}}},"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}},"ListaGrupoComercial":{"type":"object","properties":{"clienteAgrupador":{"maximum":9999999,"type":"integer"},"clientesAgrupados":{"type":"array","items":{"$ref":"#/components/schemas/ListaClientesAgrupados"}}}},"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}},"ListaGrupoCNPJ":{"type":"object","properties":{"clienteAgrupado":{"type":"integer","description":"Código do Cliente Agrupado"},"cnpjAgrupado":{"type":"string","description":"CNPJ do Cliente Agrupado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cliente":{"get":{"tags":["Clientes"],"summary":"Obter Listagem de Clientes","operationId":"ObterClientes","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"campoFiltroDinamico","in":"query","description":"Campo para filtrar dinamicamente no SQL","schema":{"type":"string"}},{"name":"valorFiltroDinamico","in":"query","description":"Valor para filtrar dinamicamente no SQL","schema":{"type":"string"}},{"name":"paginacao","in":"query","description":"Quantidade de itens na paginação de retorno","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaClientes"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /cliente > Cadastrar um Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Clientes","description":"cliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ClientePut":{"required":["bairro","cep","codRamoAtividade","codRepresentante","consumidorFinal","cpfCnpj","endereco","nome","numero","situacao"],"type":"object","properties":{"codCliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Cliente (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Cliente"},"codRepresentante":{"maximum":9999,"minimum":1,"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"maximum":9999,"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"maximum":9999,"type":"integer","description":"Código do Terceiro Representante"},"codSetorVenda":{"maximum":999,"minimum":1,"type":"integer","description":"Código do Setor de Vendas do Cliente"},"inscEstadual":{"maxLength":17,"type":"string","description":"Código da Inscrição Estadual do Cliente (sem formatação)"},"inscSuframa":{"maxLength":9,"type":"string","description":"Código da Inscrição Suframa do Cliente (sem formatação)"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Equipara Cliente Contribuinte (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"maximum":99,"minimum":1,"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Não, 1-Sim)","enum":[0,1]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Cliente"},"numero":{"maxLength":10,"minLength":1,"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"maxLength":30,"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Cliente"},"parecerCredito":{"maxLength":9999,"type":"string","description":"Parecer de Crédito/Cobrança"},"qualificacaoCliente":{"maxLength":2,"type":"string","description":"Qualificação do Cliente"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP do Cliente (sem formatação)"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Cliente"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Cliente"},"codIbge":{"maxLength":7,"minLength":7,"type":"string","description":"Código do IBGE do Cliente"},"email":{"maxLength":100,"type":"string","description":"E-mail do Cliente (exemplo@exemplo.com.br)"},"emailNfe":{"maxLength":100,"type":"string","description":"E-mail do Cliente para Nota Fiscal Eletrônica (exemplo@exemplo.com.br)"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Cliente"},"fax":{"maxLength":20,"type":"string","description":"Fax do Cliente"},"telexCelular":{"maxLength":20,"type":"string","description":"Telefone Celular do Cliente"},"telefoneCobranca":{"maxLength":20,"type":"string","description":"Telefone Cobranca (whatsapp) do Cliente"},"codSubRamoAtiv":{"maximum":999,"type":"integer","description":"Código do Sub Ramo de Atividade"},"observacao":{"maxLength":70,"type":"string","description":"Observação do Cadastro do Cliente"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}},"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}},"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}},"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Cliente":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Cliente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Cliente"},"nome":{"type":"string","description":"Nome do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"type":"integer","description":"Código do Terceiro Representante"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Representante"},"inscSuframa":{"type":"string","description":"Código da Inscrição Suframa Representante"},"contatoCompras":{"type":"string","description":"Contato de Compras do Cliente"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"codSetorVenda":{"type":"integer","description":"Código do Setor de venda do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Cliente"},"numero":{"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"type":"string","description":"Bairro do Cliente"},"cep":{"type":"string","description":"Código do CEP do Cliente"},"cidade":{"type":"string","description":"Cidade do Cliente"},"estado":{"type":"string","description":"Estado do Cliente"},"codIbge":{"type":"string","description":"Código do IBGE do Cliente"},"email":{"type":"string","description":"E-mail do Cliente"},"emailNfe":{"type":"string","description":"E-mail do Cliente para envio da Nota Fiscal Eletrônica"},"telefone":{"type":"string","description":"Telefone do Cliente"},"telefoneCobranca":{"type":"string","description":"Telefone de Cobrança do Cliente"},"fax":{"type":"string","description":"Fax do Cliente"},"telexCelular":{"type":"string","description":"Telefone Celular do Cliente"},"observacao":{"type":"string","description":"Observação do Cadastro do Cliente"},"aliqIcms":{"type":"string","description":"Aliquota de ICMS da UF do Cliente [Deprecado]"},"percAliqICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS da UF do Cliente"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito do Cliente"},"valorMaiorAcumulo":{"type":"number","description":"Valor Maior Acumulado do Cliente"},"dataMaiorFatura":{"type":"string","description":"Data da Maior Fatura do Cliente","format":"date"},"dataPrimeiraCompra":{"type":"string","description":"Data da Primeira Compra do Cliente","format":"date"},"dataCadastro":{"type":"string","description":"Data do Cadastro do Cliente","format":"date"},"valorTotalFaturado":{"multipleOf":0.01,"type":"number","description":"Valor Total já Faturado do Cliente"},"prazoMedioVendas":{"type":"string","description":"Prazo médio de Vendas do Cliente"},"clienteCentralizador":{"type":"integer","description":"Código do Cliente Centralizador"},"cnpjClienteCentralizador":{"type":"string","description":"Código do CNPJ do Cliente Centralizador"},"codSubRamoAtiv":{"type":"integer","description":"Sub Ramo de Atividade"},"codBacen":{"type":"integer","description":"Código do Bacen"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"dadosCobranca":{"type":"array","description":"Dados de Cobrança do Cliente","items":{"$ref":"#/components/schemas/ClienteDadosCobranca"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"informacoesComplementares":{"type":"array","description":"Informações Complementares do Cliente","items":{"$ref":"#/components/schemas/ClienteInfComplementares"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"grupoComercial":{"type":"array","description":"Grupo Comercial do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoComercial"}},"grupoCNPJ":{"type":"array","description":"Grupo CNPJ do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoCNPJ"}},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteDadosCobranca":{"type":"object","properties":{"codPortador":{"maxLength":4,"type":"string","description":"Código do Portador"},"codTipoCobranca":{"maxLength":3,"type":"string","description":"Código do Tipo de Cobrança"},"codCondicaoPagamento":{"maxLength":3,"type":"string","description":"Código da Condição de Pagamento"}}},"ClienteInfComplementares":{"type":"object","properties":{"codAtendente":{"maxLength":4,"type":"string","description":"Código do Atendente"},"nomeAtendente":{"maxLength":60,"type":"string","description":"Nome do Atendente"}}},"ListaGrupoComercial":{"type":"object","properties":{"clienteAgrupador":{"maximum":9999999,"type":"integer"},"clientesAgrupados":{"type":"array","items":{"$ref":"#/components/schemas/ListaClientesAgrupados"}}}},"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}},"ListaGrupoCNPJ":{"type":"object","properties":{"clienteAgrupado":{"type":"integer","description":"Código do Cliente Agrupado"},"cnpjAgrupado":{"type":"string","description":"CNPJ do Cliente Agrupado"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cliente":{"put":{"tags":["Clientes"],"summary":"Cadastrar um Cliente","operationId":"CadastrarCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientePut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /cliente/{id} > Obter um Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Clientes","description":"cliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Cliente":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Cliente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Cliente"},"nome":{"type":"string","description":"Nome do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"type":"integer","description":"Código do Terceiro Representante"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Representante"},"inscSuframa":{"type":"string","description":"Código da Inscrição Suframa Representante"},"contatoCompras":{"type":"string","description":"Contato de Compras do Cliente"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"codSetorVenda":{"type":"integer","description":"Código do Setor de venda do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Cliente"},"numero":{"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"type":"string","description":"Bairro do Cliente"},"cep":{"type":"string","description":"Código do CEP do Cliente"},"cidade":{"type":"string","description":"Cidade do Cliente"},"estado":{"type":"string","description":"Estado do Cliente"},"codIbge":{"type":"string","description":"Código do IBGE do Cliente"},"email":{"type":"string","description":"E-mail do Cliente"},"emailNfe":{"type":"string","description":"E-mail do Cliente para envio da Nota Fiscal Eletrônica"},"telefone":{"type":"string","description":"Telefone do Cliente"},"telefoneCobranca":{"type":"string","description":"Telefone de Cobrança do Cliente"},"fax":{"type":"string","description":"Fax do Cliente"},"telexCelular":{"type":"string","description":"Telefone Celular do Cliente"},"observacao":{"type":"string","description":"Observação do Cadastro do Cliente"},"aliqIcms":{"type":"string","description":"Aliquota de ICMS da UF do Cliente [Deprecado]"},"percAliqICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS da UF do Cliente"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito do Cliente"},"valorMaiorAcumulo":{"type":"number","description":"Valor Maior Acumulado do Cliente"},"dataMaiorFatura":{"type":"string","description":"Data da Maior Fatura do Cliente","format":"date"},"dataPrimeiraCompra":{"type":"string","description":"Data da Primeira Compra do Cliente","format":"date"},"dataCadastro":{"type":"string","description":"Data do Cadastro do Cliente","format":"date"},"valorTotalFaturado":{"multipleOf":0.01,"type":"number","description":"Valor Total já Faturado do Cliente"},"prazoMedioVendas":{"type":"string","description":"Prazo médio de Vendas do Cliente"},"clienteCentralizador":{"type":"integer","description":"Código do Cliente Centralizador"},"cnpjClienteCentralizador":{"type":"string","description":"Código do CNPJ do Cliente Centralizador"},"codSubRamoAtiv":{"type":"integer","description":"Sub Ramo de Atividade"},"codBacen":{"type":"integer","description":"Código do Bacen"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"dadosCobranca":{"type":"array","description":"Dados de Cobrança do Cliente","items":{"$ref":"#/components/schemas/ClienteDadosCobranca"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"informacoesComplementares":{"type":"array","description":"Informações Complementares do Cliente","items":{"$ref":"#/components/schemas/ClienteInfComplementares"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"grupoComercial":{"type":"array","description":"Grupo Comercial do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoComercial"}},"grupoCNPJ":{"type":"array","description":"Grupo CNPJ do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoCNPJ"}},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}},"ClienteDadosCobranca":{"type":"object","properties":{"codPortador":{"maxLength":4,"type":"string","description":"Código do Portador"},"codTipoCobranca":{"maxLength":3,"type":"string","description":"Código do Tipo de Cobrança"},"codCondicaoPagamento":{"maxLength":3,"type":"string","description":"Código da Condição de Pagamento"}}},"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}},"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}},"ClienteInfComplementares":{"type":"object","properties":{"codAtendente":{"maxLength":4,"type":"string","description":"Código do Atendente"},"nomeAtendente":{"maxLength":60,"type":"string","description":"Nome do Atendente"}}},"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}},"ListaGrupoComercial":{"type":"object","properties":{"clienteAgrupador":{"maximum":9999999,"type":"integer"},"clientesAgrupados":{"type":"array","items":{"$ref":"#/components/schemas/ListaClientesAgrupados"}}}},"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}},"ListaGrupoCNPJ":{"type":"object","properties":{"clienteAgrupado":{"type":"integer","description":"Código do Cliente Agrupado"},"cnpjAgrupado":{"type":"string","description":"CNPJ do Cliente Agrupado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cliente/{id}":{"get":{"tags":["Clientes"],"summary":"Obter um Cliente","operationId":"ObterCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Cliente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /cliente/{id} > Atualizar um Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Clientes","description":"cliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ClientePut":{"required":["bairro","cep","codRamoAtividade","codRepresentante","consumidorFinal","cpfCnpj","endereco","nome","numero","situacao"],"type":"object","properties":{"codCliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Cliente (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Cliente"},"codRepresentante":{"maximum":9999,"minimum":1,"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"maximum":9999,"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"maximum":9999,"type":"integer","description":"Código do Terceiro Representante"},"codSetorVenda":{"maximum":999,"minimum":1,"type":"integer","description":"Código do Setor de Vendas do Cliente"},"inscEstadual":{"maxLength":17,"type":"string","description":"Código da Inscrição Estadual do Cliente (sem formatação)"},"inscSuframa":{"maxLength":9,"type":"string","description":"Código da Inscrição Suframa do Cliente (sem formatação)"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Equipara Cliente Contribuinte (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"maximum":99,"minimum":1,"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Não, 1-Sim)","enum":[0,1]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Cliente"},"numero":{"maxLength":10,"minLength":1,"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"maxLength":30,"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Cliente"},"parecerCredito":{"maxLength":9999,"type":"string","description":"Parecer de Crédito/Cobrança"},"qualificacaoCliente":{"maxLength":2,"type":"string","description":"Qualificação do Cliente"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP do Cliente (sem formatação)"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Cliente"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Cliente"},"codIbge":{"maxLength":7,"minLength":7,"type":"string","description":"Código do IBGE do Cliente"},"email":{"maxLength":100,"type":"string","description":"E-mail do Cliente (exemplo@exemplo.com.br)"},"emailNfe":{"maxLength":100,"type":"string","description":"E-mail do Cliente para Nota Fiscal Eletrônica (exemplo@exemplo.com.br)"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Cliente"},"fax":{"maxLength":20,"type":"string","description":"Fax do Cliente"},"telexCelular":{"maxLength":20,"type":"string","description":"Telefone Celular do Cliente"},"telefoneCobranca":{"maxLength":20,"type":"string","description":"Telefone Cobranca (whatsapp) do Cliente"},"codSubRamoAtiv":{"maximum":999,"type":"integer","description":"Código do Sub Ramo de Atividade"},"observacao":{"maxLength":70,"type":"string","description":"Observação do Cadastro do Cliente"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}},"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}},"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}},"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Cliente":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Cliente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Cliente"},"nome":{"type":"string","description":"Nome do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"type":"integer","description":"Código do Terceiro Representante"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Representante"},"inscSuframa":{"type":"string","description":"Código da Inscrição Suframa Representante"},"contatoCompras":{"type":"string","description":"Contato de Compras do Cliente"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"codSetorVenda":{"type":"integer","description":"Código do Setor de venda do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Cliente"},"numero":{"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"type":"string","description":"Bairro do Cliente"},"cep":{"type":"string","description":"Código do CEP do Cliente"},"cidade":{"type":"string","description":"Cidade do Cliente"},"estado":{"type":"string","description":"Estado do Cliente"},"codIbge":{"type":"string","description":"Código do IBGE do Cliente"},"email":{"type":"string","description":"E-mail do Cliente"},"emailNfe":{"type":"string","description":"E-mail do Cliente para envio da Nota Fiscal Eletrônica"},"telefone":{"type":"string","description":"Telefone do Cliente"},"telefoneCobranca":{"type":"string","description":"Telefone de Cobrança do Cliente"},"fax":{"type":"string","description":"Fax do Cliente"},"telexCelular":{"type":"string","description":"Telefone Celular do Cliente"},"observacao":{"type":"string","description":"Observação do Cadastro do Cliente"},"aliqIcms":{"type":"string","description":"Aliquota de ICMS da UF do Cliente [Deprecado]"},"percAliqICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS da UF do Cliente"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito do Cliente"},"valorMaiorAcumulo":{"type":"number","description":"Valor Maior Acumulado do Cliente"},"dataMaiorFatura":{"type":"string","description":"Data da Maior Fatura do Cliente","format":"date"},"dataPrimeiraCompra":{"type":"string","description":"Data da Primeira Compra do Cliente","format":"date"},"dataCadastro":{"type":"string","description":"Data do Cadastro do Cliente","format":"date"},"valorTotalFaturado":{"multipleOf":0.01,"type":"number","description":"Valor Total já Faturado do Cliente"},"prazoMedioVendas":{"type":"string","description":"Prazo médio de Vendas do Cliente"},"clienteCentralizador":{"type":"integer","description":"Código do Cliente Centralizador"},"cnpjClienteCentralizador":{"type":"string","description":"Código do CNPJ do Cliente Centralizador"},"codSubRamoAtiv":{"type":"integer","description":"Sub Ramo de Atividade"},"codBacen":{"type":"integer","description":"Código do Bacen"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"dadosCobranca":{"type":"array","description":"Dados de Cobrança do Cliente","items":{"$ref":"#/components/schemas/ClienteDadosCobranca"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"informacoesComplementares":{"type":"array","description":"Informações Complementares do Cliente","items":{"$ref":"#/components/schemas/ClienteInfComplementares"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"grupoComercial":{"type":"array","description":"Grupo Comercial do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoComercial"}},"grupoCNPJ":{"type":"array","description":"Grupo CNPJ do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoCNPJ"}},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteDadosCobranca":{"type":"object","properties":{"codPortador":{"maxLength":4,"type":"string","description":"Código do Portador"},"codTipoCobranca":{"maxLength":3,"type":"string","description":"Código do Tipo de Cobrança"},"codCondicaoPagamento":{"maxLength":3,"type":"string","description":"Código da Condição de Pagamento"}}},"ClienteInfComplementares":{"type":"object","properties":{"codAtendente":{"maxLength":4,"type":"string","description":"Código do Atendente"},"nomeAtendente":{"maxLength":60,"type":"string","description":"Nome do Atendente"}}},"ListaGrupoComercial":{"type":"object","properties":{"clienteAgrupador":{"maximum":9999999,"type":"integer"},"clientesAgrupados":{"type":"array","items":{"$ref":"#/components/schemas/ListaClientesAgrupados"}}}},"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}},"ListaGrupoCNPJ":{"type":"object","properties":{"clienteAgrupado":{"type":"integer","description":"Código do Cliente Agrupado"},"cnpjAgrupado":{"type":"string","description":"CNPJ do Cliente Agrupado"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cliente/{id}":{"put":{"tags":["Clientes"],"summary":"Atualizar um Cliente","operationId":"AtualizarCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Cliente","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientePut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /cliente/{id} > Excluir um Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Clientes","description":"cliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cliente/{id}":{"delete":{"tags":["Clientes"],"summary":"Excluir um Cliente","operationId":"ExcluirCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Cliente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /cliente/limite > Automação de Limite de Crédito de Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Clientes","description":"cliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"LimiteCliente":{"required":["cnpjCpf"],"type":"object","properties":{"cnpjCpf":{"type":"string","description":"Código do CPF/CNPJ"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito"},"usuario":{"type":"string","description":"Código do Usuário do Limite"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cliente/limite":{"post":{"tags":["Clientes"],"summary":"Automação de Limite de Crédito de Cliente","operationId":"AtualizarLimiteCredito","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados de Limite de Crédito do Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimiteCliente"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Grupo De Clientes grupoCliente ## GET /grupoCliente > Obter Listagem de Grupo de Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Clientes","description":"grupoCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaGrupoCliente":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GrupoCliente"}}}},"GrupoCliente":{"required":["ListaClienteAgrupado","clienteAgrupador"],"type":"object","properties":{"clienteAgrupador":{"type":"integer","description":"Código do Cliente Agrupador"},"ListaClienteAgrupado":{"type":"array","description":"Clientes Agrupados","items":{"type":"integer"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente":{"get":{"tags":["Grupo de Clientes"],"summary":"Obter Listagem de Grupo de Cliente","operationId":"ObterGruposCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaGrupoCliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /grupoCliente > Cadastrar/Atualizar um Grupo de Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Clientes","description":"grupoCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"GrupoCliente":{"required":["ListaClienteAgrupado","clienteAgrupador"],"type":"object","properties":{"clienteAgrupador":{"type":"integer","description":"Código do Cliente Agrupador"},"ListaClienteAgrupado":{"type":"array","description":"Clientes Agrupados","items":{"type":"integer"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Cliente":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Cliente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Cliente"},"nome":{"type":"string","description":"Nome do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"type":"integer","description":"Código do Terceiro Representante"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Representante"},"inscSuframa":{"type":"string","description":"Código da Inscrição Suframa Representante"},"contatoCompras":{"type":"string","description":"Contato de Compras do Cliente"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"codSetorVenda":{"type":"integer","description":"Código do Setor de venda do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Cliente"},"numero":{"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"type":"string","description":"Bairro do Cliente"},"cep":{"type":"string","description":"Código do CEP do Cliente"},"cidade":{"type":"string","description":"Cidade do Cliente"},"estado":{"type":"string","description":"Estado do Cliente"},"codIbge":{"type":"string","description":"Código do IBGE do Cliente"},"email":{"type":"string","description":"E-mail do Cliente"},"emailNfe":{"type":"string","description":"E-mail do Cliente para envio da Nota Fiscal Eletrônica"},"telefone":{"type":"string","description":"Telefone do Cliente"},"telefoneCobranca":{"type":"string","description":"Telefone de Cobrança do Cliente"},"fax":{"type":"string","description":"Fax do Cliente"},"telexCelular":{"type":"string","description":"Telefone Celular do Cliente"},"observacao":{"type":"string","description":"Observação do Cadastro do Cliente"},"aliqIcms":{"type":"string","description":"Aliquota de ICMS da UF do Cliente [Deprecado]"},"percAliqICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS da UF do Cliente"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito do Cliente"},"valorMaiorAcumulo":{"type":"number","description":"Valor Maior Acumulado do Cliente"},"dataMaiorFatura":{"type":"string","description":"Data da Maior Fatura do Cliente","format":"date"},"dataPrimeiraCompra":{"type":"string","description":"Data da Primeira Compra do Cliente","format":"date"},"dataCadastro":{"type":"string","description":"Data do Cadastro do Cliente","format":"date"},"valorTotalFaturado":{"multipleOf":0.01,"type":"number","description":"Valor Total já Faturado do Cliente"},"prazoMedioVendas":{"type":"string","description":"Prazo médio de Vendas do Cliente"},"clienteCentralizador":{"type":"integer","description":"Código do Cliente Centralizador"},"cnpjClienteCentralizador":{"type":"string","description":"Código do CNPJ do Cliente Centralizador"},"codSubRamoAtiv":{"type":"integer","description":"Sub Ramo de Atividade"},"codBacen":{"type":"integer","description":"Código do Bacen"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"dadosCobranca":{"type":"array","description":"Dados de Cobrança do Cliente","items":{"$ref":"#/components/schemas/ClienteDadosCobranca"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"informacoesComplementares":{"type":"array","description":"Informações Complementares do Cliente","items":{"$ref":"#/components/schemas/ClienteInfComplementares"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"grupoComercial":{"type":"array","description":"Grupo Comercial do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoComercial"}},"grupoCNPJ":{"type":"array","description":"Grupo CNPJ do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoCNPJ"}},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}},"ClienteDadosCobranca":{"type":"object","properties":{"codPortador":{"maxLength":4,"type":"string","description":"Código do Portador"},"codTipoCobranca":{"maxLength":3,"type":"string","description":"Código do Tipo de Cobrança"},"codCondicaoPagamento":{"maxLength":3,"type":"string","description":"Código da Condição de Pagamento"}}},"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}},"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}},"ClienteInfComplementares":{"type":"object","properties":{"codAtendente":{"maxLength":4,"type":"string","description":"Código do Atendente"},"nomeAtendente":{"maxLength":60,"type":"string","description":"Nome do Atendente"}}},"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}},"ListaGrupoComercial":{"type":"object","properties":{"clienteAgrupador":{"maximum":9999999,"type":"integer"},"clientesAgrupados":{"type":"array","items":{"$ref":"#/components/schemas/ListaClientesAgrupados"}}}},"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}},"ListaGrupoCNPJ":{"type":"object","properties":{"clienteAgrupado":{"type":"integer","description":"Código do Cliente Agrupado"},"cnpjAgrupado":{"type":"string","description":"CNPJ do Cliente Agrupado"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente":{"put":{"tags":["Grupo de Clientes"],"summary":"Cadastrar/Atualizar um Grupo de Cliente","operationId":"CadastrarAtualizarGrupoCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do grupo de Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrupoCliente"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /grupoCliente/{id} > Obter um Grupo de Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Clientes","description":"grupoCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"GrupoCliente":{"required":["ListaClienteAgrupado","clienteAgrupador"],"type":"object","properties":{"clienteAgrupador":{"type":"integer","description":"Código do Cliente Agrupador"},"ListaClienteAgrupado":{"type":"array","description":"Clientes Agrupados","items":{"type":"integer"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente/{id}":{"get":{"tags":["Grupo de Clientes"],"summary":"Obter um Grupo de Cliente","operationId":"ObterGrupoCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Grupo de Cliente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrupoCliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /grupoCliente/{id} > Excluir um Grupo de Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Clientes","description":"grupoCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente/{id}":{"delete":{"tags":["Grupo de Clientes"],"summary":"Excluir um Grupo de Cliente","operationId":"ExcluirGrupoCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Grupo de Cliente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Fornecedor fornecedor ## GET /fornecedor > Obter Listagem de Fornecedores ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Fornecedor","description":"fornecedor"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaFornecedores":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Fornecedor"}}}},"Fornecedor":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Fornecedor"},"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Fornecedor"},"nome":{"type":"string","description":"Nome do Fornecedor"},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Fornecedor"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Fornecedor"},"inscMunicipal":{"type":"string","description":"Código da Inscrição Municipal do Fornecedor"},"situacao":{"type":"integer","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Fornecedor"},"numero":{"type":"string","description":"Número do Endereço do Fornecedor"},"complemento":{"type":"string","description":"Complemento do Endereço do Fornecedor"},"bairro":{"type":"string","description":"Bairro do Fornecedor"},"cep":{"type":"string","description":"Código do CEP do Fornecedor"},"caixaPostal":{"type":"string","description":"Caixa Postal do Fornecedor"},"cidade":{"type":"string","description":"Cidade do Fornecedor"},"estado":{"type":"string","description":"Estado do Fornecedor"},"codPaisBacen":{"type":"string","description":"Código do Pais/Bacen do Fornecedor"},"codIbge":{"type":"string","description":"Código do IBGE do Fornecedor"},"codPais":{"type":"string","description":"Código do País do Fornecedor"},"telefone":{"type":"string","description":"Priemiro Telefone do Fornecedor"},"telefone1":{"type":"string","description":"Segundo Telefone do Fornecedor"},"contato":{"type":"string","description":"Contato do Fornecedor"},"classificacao":{"type":"integer","description":"Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)","enum":[1,2,3,4,5]},"codCategoria":{"type":"integer","description":"Código da Categoria do Fornecedor"},"codGrupo":{"type":"integer","description":"Código do Grupo do Fornecedor"},"item":{"type":"integer","description":"Item do Fornecedor"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior do Fornecedor"},"codNIF":{"type":"string","description":"Código NIF do Fornecedor"},"idPessoaEstrangeira":{"type":"string","description":"Id de PEssoa Estrangeira"},"contaContabil":{"type":"string","description":"Conta Contábil do Fornecedor"},"codigoEntidade":{"type":"integer","description":"Código da Entidade do Fornecedor"},"codTransportador":{"type":"integer","description":"Código do Transportador do Fornecedor"},"email":{"type":"string","description":"E-mail do Fornecedor"},"emailNfe":{"type":"string","description":"E-mail para Nota Fiscal Eletrônica do Fornecedor"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Continuação da Observação"},"observacao3":{"type":"string","description":"Continuação da Observação"},"observacao4":{"type":"string","description":"Continuação da Observação"},"codContaContJuros":{"type":"integer","description":"Conta Contábil de Juros do Fornecedor"},"codContaContMulta":{"type":"integer","description":"Conta Contábil de Multa do Fornecedor"},"codContaContDesconto":{"type":"integer","description":"Conta Contábil de Descontos do Fornecedor"},"obrigaFluxoCaixa":{"type":"integer","description":"Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/fornecedor":{"get":{"tags":["Fornecedor"],"summary":"Obter Listagem de Fornecedores","operationId":"ObterFornecedores","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"campoFiltroDinamico","in":"query","description":"Campo para filtrar dinamicamente no SQL","schema":{"type":"string"}},{"name":"valorFiltroDinamico","in":"query","description":"Valor para filtrar dinamicamente no SQL","schema":{"type":"string"}},{"name":"paginacao","in":"query","description":"Quantidade de itens na paginação de retorno","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaFornecedores"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /fornecedor > Cadastrar um Fornecedor ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Fornecedor","description":"fornecedor"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"FornecedorPut":{"required":["bairro","cep","classificacao","codCategoria","codGrupo","endereco","nome","numero","situacao"],"type":"object","properties":{"codFornecedor":{"maximum":99999,"type":"integer","description":"Código do Fornecedor"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Fornecedor (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Fornecedor"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia do Fornecedor"},"inscEstadual":{"maxLength":17,"minLength":1,"type":"string","description":"Código da Inscrição Estadual do Fornecedor (sem formatação)"},"inscMunicipal":{"maxLength":15,"type":"string","description":"Código da Inscrição Municipal do Fornecedor (sem formatação)"},"situacao":{"type":"integer","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","enum":[0,1]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Fornecedor"},"numero":{"maxLength":5,"minLength":1,"type":"string","description":"Número do Endereço do Fornecedor"},"complemento":{"maxLength":30,"type":"string","description":"Complemento do Endereço do Fornecedor"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro do Fornecedor"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP do Fornecedor (sem formatação)"},"caixaPostal":{"maxLength":10,"type":"string","description":"Caixa Postal do Fornecedor"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Fornecedor"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Fornecedor"},"codPaisBacen":{"maxLength":4,"type":"string","description":"Código do Pais/Bacen do Fornecedor"},"codIbge":{"maxLength":7,"type":"string","description":"Código do IBGE do Fornecedor"},"codPais":{"maxLength":3,"type":"string","description":"Código do País do Fornecedor"},"telefone":{"maxLength":15,"type":"string","description":"Priemiro Telefone do Fornecedor"},"telefone1":{"maxLength":15,"type":"string","description":"Segundo Telefone do Fornecedor"},"contato":{"maxLength":30,"type":"string","description":"Contato do Fornecedor"},"classificacao":{"type":"integer","description":"Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)","enum":[1,2,3,4,5]},"codCategoria":{"maximum":99,"minimum":1,"type":"integer","description":"Código da Categoria do Fornecedor"},"codGrupo":{"maximum":999,"minimum":1,"type":"integer","description":"Código do Grupo do Fornecedor"},"item":{"maximum":999,"minimum":1,"type":"integer","description":"Item do Fornecedor"},"paisCidadeExterior":{"maxLength":30,"type":"string","description":"País e Cidade do Exterior do Fornecedor"},"codNIF":{"maxLength":35,"type":"string","description":"Código NIF do Fornecedor"},"idPessoaEstrangeira":{"maxLength":20,"type":"string","description":"Id de Pessoa Estrangeira"},"contaContabil":{"maxLength":5,"type":"string","description":"Conta Contábil do Fornecedor"},"codigoEntidade":{"maximum":99999,"type":"integer","description":"Código da Entidade do Fornecedor"},"codTransportador":{"maximum":9999,"type":"integer","description":"Código do Transportador do Fornecedor"},"email":{"maxLength":50,"type":"string","description":"E-mail do Fornecedor"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail para Nota Fiscal Eletrônica do Fornecedor"},"observacao1":{"maxLength":35,"type":"string","description":"Observação"},"observacao2":{"maxLength":35,"type":"string","description":"Continuação da Observação"},"observacao3":{"maxLength":35,"type":"string","description":"Continuação da Observação"},"observacao4":{"maxLength":35,"type":"string","description":"Continuação da Observação"},"codContaContJuros":{"maxLength":5,"type":"string","description":"Conta Contábil de Juros do Fornecedor"},"codContaContMulta":{"maxLength":5,"type":"string","description":"Conta Contábil de Multa do Fornecedor"},"codContaContDesconto":{"maxLength":5,"type":"string","description":"Conta Contábil de Desconto do Fornecedor"},"obrigaFluxoCaixa":{"type":"integer","description":"Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Fornecedor":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Fornecedor"},"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Fornecedor"},"nome":{"type":"string","description":"Nome do Fornecedor"},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Fornecedor"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Fornecedor"},"inscMunicipal":{"type":"string","description":"Código da Inscrição Municipal do Fornecedor"},"situacao":{"type":"integer","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Fornecedor"},"numero":{"type":"string","description":"Número do Endereço do Fornecedor"},"complemento":{"type":"string","description":"Complemento do Endereço do Fornecedor"},"bairro":{"type":"string","description":"Bairro do Fornecedor"},"cep":{"type":"string","description":"Código do CEP do Fornecedor"},"caixaPostal":{"type":"string","description":"Caixa Postal do Fornecedor"},"cidade":{"type":"string","description":"Cidade do Fornecedor"},"estado":{"type":"string","description":"Estado do Fornecedor"},"codPaisBacen":{"type":"string","description":"Código do Pais/Bacen do Fornecedor"},"codIbge":{"type":"string","description":"Código do IBGE do Fornecedor"},"codPais":{"type":"string","description":"Código do País do Fornecedor"},"telefone":{"type":"string","description":"Priemiro Telefone do Fornecedor"},"telefone1":{"type":"string","description":"Segundo Telefone do Fornecedor"},"contato":{"type":"string","description":"Contato do Fornecedor"},"classificacao":{"type":"integer","description":"Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)","enum":[1,2,3,4,5]},"codCategoria":{"type":"integer","description":"Código da Categoria do Fornecedor"},"codGrupo":{"type":"integer","description":"Código do Grupo do Fornecedor"},"item":{"type":"integer","description":"Item do Fornecedor"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior do Fornecedor"},"codNIF":{"type":"string","description":"Código NIF do Fornecedor"},"idPessoaEstrangeira":{"type":"string","description":"Id de PEssoa Estrangeira"},"contaContabil":{"type":"string","description":"Conta Contábil do Fornecedor"},"codigoEntidade":{"type":"integer","description":"Código da Entidade do Fornecedor"},"codTransportador":{"type":"integer","description":"Código do Transportador do Fornecedor"},"email":{"type":"string","description":"E-mail do Fornecedor"},"emailNfe":{"type":"string","description":"E-mail para Nota Fiscal Eletrônica do Fornecedor"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Continuação da Observação"},"observacao3":{"type":"string","description":"Continuação da Observação"},"observacao4":{"type":"string","description":"Continuação da Observação"},"codContaContJuros":{"type":"integer","description":"Conta Contábil de Juros do Fornecedor"},"codContaContMulta":{"type":"integer","description":"Conta Contábil de Multa do Fornecedor"},"codContaContDesconto":{"type":"integer","description":"Conta Contábil de Descontos do Fornecedor"},"obrigaFluxoCaixa":{"type":"integer","description":"Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/fornecedor":{"put":{"tags":["Fornecedor"],"summary":"Cadastrar um Fornecedor","operationId":"CadastrarFornecedor","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Fornecedor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FornecedorPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fornecedor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /fornecedor/{id} > Obter um Fornecedor ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Fornecedor","description":"fornecedor"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Fornecedor":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Fornecedor"},"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Fornecedor"},"nome":{"type":"string","description":"Nome do Fornecedor"},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Fornecedor"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Fornecedor"},"inscMunicipal":{"type":"string","description":"Código da Inscrição Municipal do Fornecedor"},"situacao":{"type":"integer","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Fornecedor"},"numero":{"type":"string","description":"Número do Endereço do Fornecedor"},"complemento":{"type":"string","description":"Complemento do Endereço do Fornecedor"},"bairro":{"type":"string","description":"Bairro do Fornecedor"},"cep":{"type":"string","description":"Código do CEP do Fornecedor"},"caixaPostal":{"type":"string","description":"Caixa Postal do Fornecedor"},"cidade":{"type":"string","description":"Cidade do Fornecedor"},"estado":{"type":"string","description":"Estado do Fornecedor"},"codPaisBacen":{"type":"string","description":"Código do Pais/Bacen do Fornecedor"},"codIbge":{"type":"string","description":"Código do IBGE do Fornecedor"},"codPais":{"type":"string","description":"Código do País do Fornecedor"},"telefone":{"type":"string","description":"Priemiro Telefone do Fornecedor"},"telefone1":{"type":"string","description":"Segundo Telefone do Fornecedor"},"contato":{"type":"string","description":"Contato do Fornecedor"},"classificacao":{"type":"integer","description":"Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)","enum":[1,2,3,4,5]},"codCategoria":{"type":"integer","description":"Código da Categoria do Fornecedor"},"codGrupo":{"type":"integer","description":"Código do Grupo do Fornecedor"},"item":{"type":"integer","description":"Item do Fornecedor"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior do Fornecedor"},"codNIF":{"type":"string","description":"Código NIF do Fornecedor"},"idPessoaEstrangeira":{"type":"string","description":"Id de PEssoa Estrangeira"},"contaContabil":{"type":"string","description":"Conta Contábil do Fornecedor"},"codigoEntidade":{"type":"integer","description":"Código da Entidade do Fornecedor"},"codTransportador":{"type":"integer","description":"Código do Transportador do Fornecedor"},"email":{"type":"string","description":"E-mail do Fornecedor"},"emailNfe":{"type":"string","description":"E-mail para Nota Fiscal Eletrônica do Fornecedor"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Continuação da Observação"},"observacao3":{"type":"string","description":"Continuação da Observação"},"observacao4":{"type":"string","description":"Continuação da Observação"},"codContaContJuros":{"type":"integer","description":"Conta Contábil de Juros do Fornecedor"},"codContaContMulta":{"type":"integer","description":"Conta Contábil de Multa do Fornecedor"},"codContaContDesconto":{"type":"integer","description":"Conta Contábil de Descontos do Fornecedor"},"obrigaFluxoCaixa":{"type":"integer","description":"Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/fornecedor/{id}":{"get":{"tags":["Fornecedor"],"summary":"Obter um Fornecedor","operationId":"ObterFornecedor","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Fornecedor","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fornecedor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /fornecedor/{id} > Atualizar um Fornecedor ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Fornecedor","description":"fornecedor"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"FornecedorPut":{"required":["bairro","cep","classificacao","codCategoria","codGrupo","endereco","nome","numero","situacao"],"type":"object","properties":{"codFornecedor":{"maximum":99999,"type":"integer","description":"Código do Fornecedor"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Fornecedor (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Fornecedor"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia do Fornecedor"},"inscEstadual":{"maxLength":17,"minLength":1,"type":"string","description":"Código da Inscrição Estadual do Fornecedor (sem formatação)"},"inscMunicipal":{"maxLength":15,"type":"string","description":"Código da Inscrição Municipal do Fornecedor (sem formatação)"},"situacao":{"type":"integer","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","enum":[0,1]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Fornecedor"},"numero":{"maxLength":5,"minLength":1,"type":"string","description":"Número do Endereço do Fornecedor"},"complemento":{"maxLength":30,"type":"string","description":"Complemento do Endereço do Fornecedor"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro do Fornecedor"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP do Fornecedor (sem formatação)"},"caixaPostal":{"maxLength":10,"type":"string","description":"Caixa Postal do Fornecedor"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Fornecedor"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Fornecedor"},"codPaisBacen":{"maxLength":4,"type":"string","description":"Código do Pais/Bacen do Fornecedor"},"codIbge":{"maxLength":7,"type":"string","description":"Código do IBGE do Fornecedor"},"codPais":{"maxLength":3,"type":"string","description":"Código do País do Fornecedor"},"telefone":{"maxLength":15,"type":"string","description":"Priemiro Telefone do Fornecedor"},"telefone1":{"maxLength":15,"type":"string","description":"Segundo Telefone do Fornecedor"},"contato":{"maxLength":30,"type":"string","description":"Contato do Fornecedor"},"classificacao":{"type":"integer","description":"Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)","enum":[1,2,3,4,5]},"codCategoria":{"maximum":99,"minimum":1,"type":"integer","description":"Código da Categoria do Fornecedor"},"codGrupo":{"maximum":999,"minimum":1,"type":"integer","description":"Código do Grupo do Fornecedor"},"item":{"maximum":999,"minimum":1,"type":"integer","description":"Item do Fornecedor"},"paisCidadeExterior":{"maxLength":30,"type":"string","description":"País e Cidade do Exterior do Fornecedor"},"codNIF":{"maxLength":35,"type":"string","description":"Código NIF do Fornecedor"},"idPessoaEstrangeira":{"maxLength":20,"type":"string","description":"Id de Pessoa Estrangeira"},"contaContabil":{"maxLength":5,"type":"string","description":"Conta Contábil do Fornecedor"},"codigoEntidade":{"maximum":99999,"type":"integer","description":"Código da Entidade do Fornecedor"},"codTransportador":{"maximum":9999,"type":"integer","description":"Código do Transportador do Fornecedor"},"email":{"maxLength":50,"type":"string","description":"E-mail do Fornecedor"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail para Nota Fiscal Eletrônica do Fornecedor"},"observacao1":{"maxLength":35,"type":"string","description":"Observação"},"observacao2":{"maxLength":35,"type":"string","description":"Continuação da Observação"},"observacao3":{"maxLength":35,"type":"string","description":"Continuação da Observação"},"observacao4":{"maxLength":35,"type":"string","description":"Continuação da Observação"},"codContaContJuros":{"maxLength":5,"type":"string","description":"Conta Contábil de Juros do Fornecedor"},"codContaContMulta":{"maxLength":5,"type":"string","description":"Conta Contábil de Multa do Fornecedor"},"codContaContDesconto":{"maxLength":5,"type":"string","description":"Conta Contábil de Desconto do Fornecedor"},"obrigaFluxoCaixa":{"type":"integer","description":"Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Fornecedor":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Fornecedor"},"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Fornecedor"},"nome":{"type":"string","description":"Nome do Fornecedor"},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Fornecedor"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Fornecedor"},"inscMunicipal":{"type":"string","description":"Código da Inscrição Municipal do Fornecedor"},"situacao":{"type":"integer","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Fornecedor"},"numero":{"type":"string","description":"Número do Endereço do Fornecedor"},"complemento":{"type":"string","description":"Complemento do Endereço do Fornecedor"},"bairro":{"type":"string","description":"Bairro do Fornecedor"},"cep":{"type":"string","description":"Código do CEP do Fornecedor"},"caixaPostal":{"type":"string","description":"Caixa Postal do Fornecedor"},"cidade":{"type":"string","description":"Cidade do Fornecedor"},"estado":{"type":"string","description":"Estado do Fornecedor"},"codPaisBacen":{"type":"string","description":"Código do Pais/Bacen do Fornecedor"},"codIbge":{"type":"string","description":"Código do IBGE do Fornecedor"},"codPais":{"type":"string","description":"Código do País do Fornecedor"},"telefone":{"type":"string","description":"Priemiro Telefone do Fornecedor"},"telefone1":{"type":"string","description":"Segundo Telefone do Fornecedor"},"contato":{"type":"string","description":"Contato do Fornecedor"},"classificacao":{"type":"integer","description":"Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)","enum":[1,2,3,4,5]},"codCategoria":{"type":"integer","description":"Código da Categoria do Fornecedor"},"codGrupo":{"type":"integer","description":"Código do Grupo do Fornecedor"},"item":{"type":"integer","description":"Item do Fornecedor"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior do Fornecedor"},"codNIF":{"type":"string","description":"Código NIF do Fornecedor"},"idPessoaEstrangeira":{"type":"string","description":"Id de PEssoa Estrangeira"},"contaContabil":{"type":"string","description":"Conta Contábil do Fornecedor"},"codigoEntidade":{"type":"integer","description":"Código da Entidade do Fornecedor"},"codTransportador":{"type":"integer","description":"Código do Transportador do Fornecedor"},"email":{"type":"string","description":"E-mail do Fornecedor"},"emailNfe":{"type":"string","description":"E-mail para Nota Fiscal Eletrônica do Fornecedor"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Continuação da Observação"},"observacao3":{"type":"string","description":"Continuação da Observação"},"observacao4":{"type":"string","description":"Continuação da Observação"},"codContaContJuros":{"type":"integer","description":"Conta Contábil de Juros do Fornecedor"},"codContaContMulta":{"type":"integer","description":"Conta Contábil de Multa do Fornecedor"},"codContaContDesconto":{"type":"integer","description":"Conta Contábil de Descontos do Fornecedor"},"obrigaFluxoCaixa":{"type":"integer","description":"Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/fornecedor/{id}":{"put":{"tags":["Fornecedor"],"summary":"Atualizar um Fornecedor","operationId":"AtualizarFornecedor","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Fornecedor","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Fornecedor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FornecedorPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fornecedor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /fornecedor/{id} > Excluir um Fornecedor ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Fornecedor","description":"fornecedor"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/fornecedor/{id}":{"delete":{"tags":["Fornecedor"],"summary":"Excluir um Fornecedor","operationId":"ExcluirFornecedor","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Fornecedor","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Transportadora transportadora ## GET /transportadora > Obter Listagem de Transportadora ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Transportadora","description":"transportadora"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTransportadoras":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Transportadora"}}}},"Transportadora":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa da Transportadora"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"nome":{"maxLength":60,"type":"string","description":"Nome da Transportadora"},"endereco":{"maxLength":60,"type":"string","description":"Endereço da Transportadora"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP da Transportadora"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Transportadora"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia da Transportadora"},"inscEstadual":{"maxLength":15,"type":"string","description":"Inscrição Estadual da Transportadora"},"situacao":{"type":"integer","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"type":"string","description":"Telefone da Transportadora"},"teleFax":{"maxLength":15,"type":"string","description":"Telefone/Fax da Transportadora"},"bairro":{"maxLength":30,"type":"string","description":"Bairro da Transportadora"},"contato":{"maxLength":30,"type":"string","description":"Contato da Transportadora"},"email":{"maxLength":60,"type":"string","description":"E-mail da Transportadora"},"obsNotaFiscal":{"type":"integer","description":"Código da Observação para a Nota Fiscal"},"tipo":{"type":"integer","description":"Tipo da Transportadora (1-Transportadora, 2-Consignatário)","enum":[1,2]},"dataValidadeSeguro":{"type":"string","description":"Data de Validade do Seguro da Transportadora"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior da Transportadora"},"paisBacen":{"maximum":999999,"type":"integer","description":"Código do Pais/Bacen da Transportadora"},"codRUC":{"maximum":99999999999,"type":"integer","description":"Código RUC da Transportadora"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail da Nota Fiscal Eletrônica da Transportadora"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço da Transportadora"},"rntrc":{"maxLength":14,"type":"string","description":"Registro Nacional de Transportador da Transportadora"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/transportadora":{"get":{"tags":["Transportadora"],"summary":"Obter Listagem de Transportadora","operationId":"ObterTransportadoras","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"campoFiltroDinamico","in":"query","description":"Campo para filtrar dinamicamente no SQL","schema":{"type":"string"}},{"name":"valorFiltroDinamico","in":"query","description":"Valor para filtrar dinamicamente no SQL","schema":{"type":"string"}},{"name":"paginacao","in":"query","description":"Quantidade de itens na paginação de retorno","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTransportadoras"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /transportadora > Cadastrar uma Transportadora ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Transportadora","description":"transportadora"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TransportadoraPut":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa da Transportadora"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"nome":{"maxLength":60,"type":"string","description":"Nome da Transportadora"},"endereco":{"maxLength":60,"type":"string","description":"Endereço da Transportadora"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP da Transportadora (sem formatação)"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Transportadora (sem formatação)"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia da Transportadora"},"inscEstadual":{"maxLength":15,"type":"string","description":"Inscrição Estadual da Transportadora (sem formatação)"},"situacao":{"type":"integer","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"type":"string","description":"Telefone da Transportadora"},"teleFax":{"maxLength":15,"type":"string","description":"Telefone/Fax da Transportadora"},"bairro":{"maxLength":30,"type":"string","description":"Bairro da Transportadora"},"contato":{"maxLength":30,"type":"string","description":"Contato da Transportadora"},"email":{"maxLength":60,"type":"string","description":"E-mail da Transportadora"},"obsNotaFiscal":{"type":"integer","description":"Código da Observação para a Nota Fiscal"},"tipo":{"type":"integer","description":"Tipo da Transportadora (1-Transportadora, 2-Consignatário)","enum":[1,2]},"dataValidadeSeguro":{"type":"string","description":"Data de Validade do Seguro da Transportadora (YYYY-MM-DD)","format":"date"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior da Transportadora"},"paisBacen":{"maximum":999999,"type":"integer","description":"Código do Pais/Bacen da Transportadora"},"codRUC":{"maximum":99999999999,"type":"integer","description":"Código RUC da Transportadora"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail da Nota Fiscal Eletrônica da Transportadora"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço da Transportadora"},"rntrc":{"maxLength":14,"type":"string","description":"Registro Nacional de Transportador da Transportadora"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Transportadora":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa da Transportadora"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"nome":{"maxLength":60,"type":"string","description":"Nome da Transportadora"},"endereco":{"maxLength":60,"type":"string","description":"Endereço da Transportadora"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP da Transportadora"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Transportadora"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia da Transportadora"},"inscEstadual":{"maxLength":15,"type":"string","description":"Inscrição Estadual da Transportadora"},"situacao":{"type":"integer","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"type":"string","description":"Telefone da Transportadora"},"teleFax":{"maxLength":15,"type":"string","description":"Telefone/Fax da Transportadora"},"bairro":{"maxLength":30,"type":"string","description":"Bairro da Transportadora"},"contato":{"maxLength":30,"type":"string","description":"Contato da Transportadora"},"email":{"maxLength":60,"type":"string","description":"E-mail da Transportadora"},"obsNotaFiscal":{"type":"integer","description":"Código da Observação para a Nota Fiscal"},"tipo":{"type":"integer","description":"Tipo da Transportadora (1-Transportadora, 2-Consignatário)","enum":[1,2]},"dataValidadeSeguro":{"type":"string","description":"Data de Validade do Seguro da Transportadora"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior da Transportadora"},"paisBacen":{"maximum":999999,"type":"integer","description":"Código do Pais/Bacen da Transportadora"},"codRUC":{"maximum":99999999999,"type":"integer","description":"Código RUC da Transportadora"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail da Nota Fiscal Eletrônica da Transportadora"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço da Transportadora"},"rntrc":{"maxLength":14,"type":"string","description":"Registro Nacional de Transportador da Transportadora"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/transportadora":{"put":{"tags":["Transportadora"],"summary":"Cadastrar uma Transportadora","operationId":"CadastrarTransportadora","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da Transportadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransportadoraPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transportadora"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /transportadora/{id} > Obter uma Transportadora ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Transportadora","description":"transportadora"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Transportadora":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa da Transportadora"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"nome":{"maxLength":60,"type":"string","description":"Nome da Transportadora"},"endereco":{"maxLength":60,"type":"string","description":"Endereço da Transportadora"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP da Transportadora"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Transportadora"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia da Transportadora"},"inscEstadual":{"maxLength":15,"type":"string","description":"Inscrição Estadual da Transportadora"},"situacao":{"type":"integer","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"type":"string","description":"Telefone da Transportadora"},"teleFax":{"maxLength":15,"type":"string","description":"Telefone/Fax da Transportadora"},"bairro":{"maxLength":30,"type":"string","description":"Bairro da Transportadora"},"contato":{"maxLength":30,"type":"string","description":"Contato da Transportadora"},"email":{"maxLength":60,"type":"string","description":"E-mail da Transportadora"},"obsNotaFiscal":{"type":"integer","description":"Código da Observação para a Nota Fiscal"},"tipo":{"type":"integer","description":"Tipo da Transportadora (1-Transportadora, 2-Consignatário)","enum":[1,2]},"dataValidadeSeguro":{"type":"string","description":"Data de Validade do Seguro da Transportadora"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior da Transportadora"},"paisBacen":{"maximum":999999,"type":"integer","description":"Código do Pais/Bacen da Transportadora"},"codRUC":{"maximum":99999999999,"type":"integer","description":"Código RUC da Transportadora"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail da Nota Fiscal Eletrônica da Transportadora"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço da Transportadora"},"rntrc":{"maxLength":14,"type":"string","description":"Registro Nacional de Transportador da Transportadora"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/transportadora/{id}":{"get":{"tags":["Transportadora"],"summary":"Obter uma Transportadora","operationId":"ObterTransportadora","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Transportadora","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transportadora"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /transportadora/{id} > Atualizar uma Transportadora ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Transportadora","description":"transportadora"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TransportadoraPut":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa da Transportadora"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"nome":{"maxLength":60,"type":"string","description":"Nome da Transportadora"},"endereco":{"maxLength":60,"type":"string","description":"Endereço da Transportadora"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP da Transportadora (sem formatação)"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Transportadora (sem formatação)"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia da Transportadora"},"inscEstadual":{"maxLength":15,"type":"string","description":"Inscrição Estadual da Transportadora (sem formatação)"},"situacao":{"type":"integer","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"type":"string","description":"Telefone da Transportadora"},"teleFax":{"maxLength":15,"type":"string","description":"Telefone/Fax da Transportadora"},"bairro":{"maxLength":30,"type":"string","description":"Bairro da Transportadora"},"contato":{"maxLength":30,"type":"string","description":"Contato da Transportadora"},"email":{"maxLength":60,"type":"string","description":"E-mail da Transportadora"},"obsNotaFiscal":{"type":"integer","description":"Código da Observação para a Nota Fiscal"},"tipo":{"type":"integer","description":"Tipo da Transportadora (1-Transportadora, 2-Consignatário)","enum":[1,2]},"dataValidadeSeguro":{"type":"string","description":"Data de Validade do Seguro da Transportadora (YYYY-MM-DD)","format":"date"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior da Transportadora"},"paisBacen":{"maximum":999999,"type":"integer","description":"Código do Pais/Bacen da Transportadora"},"codRUC":{"maximum":99999999999,"type":"integer","description":"Código RUC da Transportadora"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail da Nota Fiscal Eletrônica da Transportadora"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço da Transportadora"},"rntrc":{"maxLength":14,"type":"string","description":"Registro Nacional de Transportador da Transportadora"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Transportadora":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa da Transportadora"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"nome":{"maxLength":60,"type":"string","description":"Nome da Transportadora"},"endereco":{"maxLength":60,"type":"string","description":"Endereço da Transportadora"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP da Transportadora"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Transportadora"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia da Transportadora"},"inscEstadual":{"maxLength":15,"type":"string","description":"Inscrição Estadual da Transportadora"},"situacao":{"type":"integer","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"type":"string","description":"Telefone da Transportadora"},"teleFax":{"maxLength":15,"type":"string","description":"Telefone/Fax da Transportadora"},"bairro":{"maxLength":30,"type":"string","description":"Bairro da Transportadora"},"contato":{"maxLength":30,"type":"string","description":"Contato da Transportadora"},"email":{"maxLength":60,"type":"string","description":"E-mail da Transportadora"},"obsNotaFiscal":{"type":"integer","description":"Código da Observação para a Nota Fiscal"},"tipo":{"type":"integer","description":"Tipo da Transportadora (1-Transportadora, 2-Consignatário)","enum":[1,2]},"dataValidadeSeguro":{"type":"string","description":"Data de Validade do Seguro da Transportadora"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior da Transportadora"},"paisBacen":{"maximum":999999,"type":"integer","description":"Código do Pais/Bacen da Transportadora"},"codRUC":{"maximum":99999999999,"type":"integer","description":"Código RUC da Transportadora"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail da Nota Fiscal Eletrônica da Transportadora"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço da Transportadora"},"rntrc":{"maxLength":14,"type":"string","description":"Registro Nacional de Transportador da Transportadora"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/transportadora/{id}":{"put":{"tags":["Transportadora"],"summary":"Atualizar uma Transportadora","operationId":"AtualizarTransportadora","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Transportadora","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da Transportadora","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransportadoraPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transportadora"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /transportadora/{id} > Excluir uma Transportadora ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Transportadora","description":"transportadora"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/transportadora/{id}":{"delete":{"tags":["Transportadora"],"summary":"Excluir uma Transportadora","operationId":"ExcluirTransportadora","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Transportadora","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Portador portador ## GET /portador > Obter Listagem de Portadores ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaPortadores":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Portador"}}}},"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/portador":{"get":{"tags":["Portador"],"summary":"Obter Listagem de Portadores","operationId":"ObterPortadores","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaPortadores"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /portador > Cadastrar um Portador ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PortadorPut":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Portador"}}}},"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/portador":{"put":{"tags":["Portador"],"summary":"Cadastrar um Portador","operationId":"CadastrarPortador","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Portador","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortadorPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portador"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /portador/{id} > Obter um Portador ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/portador/{id}":{"get":{"tags":["Portador"],"summary":"Obter um Portador","operationId":"ObterPortador","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Portador","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portador"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /portador/{id} > Atualizar um Portador ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PortadorPut":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Portador"}}}},"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/portador/{id}":{"put":{"tags":["Portador"],"summary":"Atualizar um Portador","operationId":"AtualizarPortador","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Portador","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Portador","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortadorPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portador"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /portador/{id} > Excluir um Portador ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Portador","description":"portador"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/portador/{id}":{"delete":{"tags":["Portador"],"summary":"Excluir um Portador","operationId":"ExcluirPortador","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Portador","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Condição De Venda condicaoVenda ## GET /condicaoVenda > Obter Listagem de Condição de Venda ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Condição de Venda","description":"condicaoVenda"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaCondicoesVendas":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CondicaoVenda"}}}},"CondicaoVenda":{"type":"object","properties":{"codCondicaoVenda":{"maximum":999,"minimum":1,"type":"integer","description":"Código da Condição de Venda"},"percDesc6":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"percComissao3":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Representante"},"percReposicao":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição"},"percReposicaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição do Representante"},"prazoVencimento1":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 1"},"prazoVencimento2":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 2"},"prazoVencimento3":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 3"},"prazoVencimento4":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 4"},"prazoVencimento5":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 5"},"prazoVencimento6":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 6"},"descricao":{"type":"string","description":"Descrição da Condição de Venda"},"descricaoNaNF":{"type":"integer","description":"Descrição da Condição de Venda na Nota Fiscal (1 - Sim, 0 - Não)","enum":[1,0]},"percAcrescimo":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo da Condição de Venda"},"listaNaTabela":{"type":"integer","description":"Lista na Tabela? (1 - Sim, 0 - Não)","enum":[1,0]},"situacao":{"type":"integer","description":"Situação da Condição de Venda (0-Inativo, 1-Ativo)","enum":[0,1]},"observacao1":{"maxLength":50,"type":"string","description":"Observação da Condição de Venda"},"observacao2":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao3":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao4":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"prazoVencimento7":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 7"},"prazoVencimento8":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 8"},"prazoVencimento9":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 9"},"prazoVencimento10":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 10"},"prazoVencimento11":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 11"},"prazoVencimento12":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 12"},"prazoVencimento13":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 13"},"prazoVencimento14":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 14"},"prazoVencimento15":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 15"},"prazoVencimento16":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 16"},"prazoVencimento17":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 17"},"prazoVencimento18":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 18"},"formaPagamento":{"type":"string","description":"Código da Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 14 - Duplicata Mercantil, 15 - Boleto Bancário, 90 - Sem pagamento)","enum":["01","02","03","04","05","10","11","12","13","14","15","90"]},"tipoIntegracao":{"type":"integer","description":"Código do Tipo da Integração (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Comércio Eletrônico)","enum":[1,2]},"CNPJCreden":{"type":"string","description":"Código do CNPJ da Credenciadora"},"bandOperadora":{"type":"string","description":"Código da Bandeira da Operadora (01 - Visa, 02 - Mastercard, 03 - American Expres, 04 - Sorocred, 05 - Diners Club, 06 - Elo, 07 - Hipercard, 08 - Aura, 09 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"numAutCartao":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Autorização do Cartão"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/condicaoVenda":{"get":{"tags":["Condição de Venda"],"summary":"Obter Listagem de Condição de Venda","operationId":"ObterCondicoesVendas","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaCondicoesVendas"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /condicaoVenda > Cadastrar uma Condição de Venda ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Condição de Venda","description":"condicaoVenda"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"CondicaoVendaPut":{"type":"object","properties":{"percDesc6":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"percComissao3":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Representante"},"percReposicao":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição"},"percReposicaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição do Representante"},"prazoVencimento1":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 1"},"prazoVencimento2":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 2"},"prazoVencimento3":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 3"},"prazoVencimento4":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 4"},"prazoVencimento5":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 5"},"prazoVencimento6":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 6"},"descricao":{"type":"string","description":"Descrição da Condição de Venda"},"descricaoNaNF":{"type":"integer","description":"Descrição da Condição de Venda na Nota Fiscal (1 - Sim, 0 - Não)","enum":[1,0]},"percAcrescimo":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo da Condição de Venda"},"listaNaTabela":{"type":"integer","description":"Lista na Tabela? (1 - Sim, 0 - Não)","enum":[1,0]},"situacao":{"type":"integer","description":"Situação da Condição de Venda (0-Inativo, 1-Ativo)","enum":[0,1]},"observacao1":{"maxLength":50,"type":"string","description":"Observação da Condição de Venda"},"observacao2":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao3":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao4":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"prazoVencimento7":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 7"},"prazoVencimento8":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 8"},"prazoVencimento9":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 9"},"prazoVencimento10":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 10"},"prazoVencimento11":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 11"},"prazoVencimento12":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 12"},"prazoVencimento13":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 13"},"prazoVencimento14":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 14"},"prazoVencimento15":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 15"},"prazoVencimento16":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 16"},"prazoVencimento17":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 17"},"prazoVencimento18":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 18"},"formaPagamento":{"type":"string","description":"Código da Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 14 - Duplicata Mercantil, 15 - Boleto Bancário, 90 - Sem pagamento)","enum":["01","02","03","04","05","10","11","12","13","14","15","90"]},"tipoIntegracao":{"type":"integer","description":"Código do Tipo da Integração (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Comércio Eletrônico)","enum":[1,2]},"CNPJCreden":{"type":"string","description":"Código do CNPJ da Credenciadora"},"bandOperadora":{"type":"string","description":"Código da Bandeira da Operadora (01 - Visa, 02 - Mastercard, 03 - American Expres, 04 - Sorocred, 05 - Diners Club, 06 - Elo, 07 - Hipercard, 08 - Aura, 09 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"numAutCartao":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Autorização do Cartão"}}},"CondicaoVenda":{"type":"object","properties":{"codCondicaoVenda":{"maximum":999,"minimum":1,"type":"integer","description":"Código da Condição de Venda"},"percDesc6":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"percComissao3":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Representante"},"percReposicao":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição"},"percReposicaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição do Representante"},"prazoVencimento1":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 1"},"prazoVencimento2":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 2"},"prazoVencimento3":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 3"},"prazoVencimento4":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 4"},"prazoVencimento5":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 5"},"prazoVencimento6":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 6"},"descricao":{"type":"string","description":"Descrição da Condição de Venda"},"descricaoNaNF":{"type":"integer","description":"Descrição da Condição de Venda na Nota Fiscal (1 - Sim, 0 - Não)","enum":[1,0]},"percAcrescimo":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo da Condição de Venda"},"listaNaTabela":{"type":"integer","description":"Lista na Tabela? (1 - Sim, 0 - Não)","enum":[1,0]},"situacao":{"type":"integer","description":"Situação da Condição de Venda (0-Inativo, 1-Ativo)","enum":[0,1]},"observacao1":{"maxLength":50,"type":"string","description":"Observação da Condição de Venda"},"observacao2":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao3":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao4":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"prazoVencimento7":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 7"},"prazoVencimento8":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 8"},"prazoVencimento9":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 9"},"prazoVencimento10":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 10"},"prazoVencimento11":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 11"},"prazoVencimento12":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 12"},"prazoVencimento13":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 13"},"prazoVencimento14":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 14"},"prazoVencimento15":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 15"},"prazoVencimento16":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 16"},"prazoVencimento17":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 17"},"prazoVencimento18":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 18"},"formaPagamento":{"type":"string","description":"Código da Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 14 - Duplicata Mercantil, 15 - Boleto Bancário, 90 - Sem pagamento)","enum":["01","02","03","04","05","10","11","12","13","14","15","90"]},"tipoIntegracao":{"type":"integer","description":"Código do Tipo da Integração (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Comércio Eletrônico)","enum":[1,2]},"CNPJCreden":{"type":"string","description":"Código do CNPJ da Credenciadora"},"bandOperadora":{"type":"string","description":"Código da Bandeira da Operadora (01 - Visa, 02 - Mastercard, 03 - American Expres, 04 - Sorocred, 05 - Diners Club, 06 - Elo, 07 - Hipercard, 08 - Aura, 09 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"numAutCartao":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Autorização do Cartão"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/condicaoVenda":{"put":{"tags":["Condição de Venda"],"summary":"Cadastrar uma Condição de Venda","operationId":"CadastrarCondicaoVenda","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da Condição de venda","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CondicaoVendaPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CondicaoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /condicaoVenda/{id} > Obter uma Condição de Venda ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Condição de Venda","description":"condicaoVenda"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"CondicaoVenda":{"type":"object","properties":{"codCondicaoVenda":{"maximum":999,"minimum":1,"type":"integer","description":"Código da Condição de Venda"},"percDesc6":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"percComissao3":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Representante"},"percReposicao":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição"},"percReposicaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição do Representante"},"prazoVencimento1":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 1"},"prazoVencimento2":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 2"},"prazoVencimento3":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 3"},"prazoVencimento4":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 4"},"prazoVencimento5":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 5"},"prazoVencimento6":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 6"},"descricao":{"type":"string","description":"Descrição da Condição de Venda"},"descricaoNaNF":{"type":"integer","description":"Descrição da Condição de Venda na Nota Fiscal (1 - Sim, 0 - Não)","enum":[1,0]},"percAcrescimo":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo da Condição de Venda"},"listaNaTabela":{"type":"integer","description":"Lista na Tabela? (1 - Sim, 0 - Não)","enum":[1,0]},"situacao":{"type":"integer","description":"Situação da Condição de Venda (0-Inativo, 1-Ativo)","enum":[0,1]},"observacao1":{"maxLength":50,"type":"string","description":"Observação da Condição de Venda"},"observacao2":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao3":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao4":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"prazoVencimento7":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 7"},"prazoVencimento8":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 8"},"prazoVencimento9":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 9"},"prazoVencimento10":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 10"},"prazoVencimento11":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 11"},"prazoVencimento12":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 12"},"prazoVencimento13":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 13"},"prazoVencimento14":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 14"},"prazoVencimento15":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 15"},"prazoVencimento16":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 16"},"prazoVencimento17":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 17"},"prazoVencimento18":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 18"},"formaPagamento":{"type":"string","description":"Código da Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 14 - Duplicata Mercantil, 15 - Boleto Bancário, 90 - Sem pagamento)","enum":["01","02","03","04","05","10","11","12","13","14","15","90"]},"tipoIntegracao":{"type":"integer","description":"Código do Tipo da Integração (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Comércio Eletrônico)","enum":[1,2]},"CNPJCreden":{"type":"string","description":"Código do CNPJ da Credenciadora"},"bandOperadora":{"type":"string","description":"Código da Bandeira da Operadora (01 - Visa, 02 - Mastercard, 03 - American Expres, 04 - Sorocred, 05 - Diners Club, 06 - Elo, 07 - Hipercard, 08 - Aura, 09 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"numAutCartao":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Autorização do Cartão"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/condicaoVenda/{id}":{"get":{"tags":["Condição de Venda"],"summary":"Obter uma Condição de Venda","operationId":"ObterCondicaoVenda","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Condição de Venda","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CondicaoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /condicaoVenda/{id} > Atualizar uma Condição de Venda ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Condição de Venda","description":"condicaoVenda"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"CondicaoVendaPut":{"type":"object","properties":{"percDesc6":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"percComissao3":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Representante"},"percReposicao":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição"},"percReposicaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição do Representante"},"prazoVencimento1":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 1"},"prazoVencimento2":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 2"},"prazoVencimento3":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 3"},"prazoVencimento4":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 4"},"prazoVencimento5":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 5"},"prazoVencimento6":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 6"},"descricao":{"type":"string","description":"Descrição da Condição de Venda"},"descricaoNaNF":{"type":"integer","description":"Descrição da Condição de Venda na Nota Fiscal (1 - Sim, 0 - Não)","enum":[1,0]},"percAcrescimo":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo da Condição de Venda"},"listaNaTabela":{"type":"integer","description":"Lista na Tabela? (1 - Sim, 0 - Não)","enum":[1,0]},"situacao":{"type":"integer","description":"Situação da Condição de Venda (0-Inativo, 1-Ativo)","enum":[0,1]},"observacao1":{"maxLength":50,"type":"string","description":"Observação da Condição de Venda"},"observacao2":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao3":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao4":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"prazoVencimento7":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 7"},"prazoVencimento8":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 8"},"prazoVencimento9":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 9"},"prazoVencimento10":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 10"},"prazoVencimento11":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 11"},"prazoVencimento12":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 12"},"prazoVencimento13":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 13"},"prazoVencimento14":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 14"},"prazoVencimento15":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 15"},"prazoVencimento16":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 16"},"prazoVencimento17":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 17"},"prazoVencimento18":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 18"},"formaPagamento":{"type":"string","description":"Código da Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 14 - Duplicata Mercantil, 15 - Boleto Bancário, 90 - Sem pagamento)","enum":["01","02","03","04","05","10","11","12","13","14","15","90"]},"tipoIntegracao":{"type":"integer","description":"Código do Tipo da Integração (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Comércio Eletrônico)","enum":[1,2]},"CNPJCreden":{"type":"string","description":"Código do CNPJ da Credenciadora"},"bandOperadora":{"type":"string","description":"Código da Bandeira da Operadora (01 - Visa, 02 - Mastercard, 03 - American Expres, 04 - Sorocred, 05 - Diners Club, 06 - Elo, 07 - Hipercard, 08 - Aura, 09 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"numAutCartao":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Autorização do Cartão"}}},"CondicaoVenda":{"type":"object","properties":{"codCondicaoVenda":{"maximum":999,"minimum":1,"type":"integer","description":"Código da Condição de Venda"},"percDesc6":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"percComissao3":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Representante"},"percReposicao":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição"},"percReposicaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição do Representante"},"prazoVencimento1":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 1"},"prazoVencimento2":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 2"},"prazoVencimento3":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 3"},"prazoVencimento4":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 4"},"prazoVencimento5":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 5"},"prazoVencimento6":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 6"},"descricao":{"type":"string","description":"Descrição da Condição de Venda"},"descricaoNaNF":{"type":"integer","description":"Descrição da Condição de Venda na Nota Fiscal (1 - Sim, 0 - Não)","enum":[1,0]},"percAcrescimo":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo da Condição de Venda"},"listaNaTabela":{"type":"integer","description":"Lista na Tabela? (1 - Sim, 0 - Não)","enum":[1,0]},"situacao":{"type":"integer","description":"Situação da Condição de Venda (0-Inativo, 1-Ativo)","enum":[0,1]},"observacao1":{"maxLength":50,"type":"string","description":"Observação da Condição de Venda"},"observacao2":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao3":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao4":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"prazoVencimento7":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 7"},"prazoVencimento8":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 8"},"prazoVencimento9":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 9"},"prazoVencimento10":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 10"},"prazoVencimento11":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 11"},"prazoVencimento12":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 12"},"prazoVencimento13":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 13"},"prazoVencimento14":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 14"},"prazoVencimento15":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 15"},"prazoVencimento16":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 16"},"prazoVencimento17":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 17"},"prazoVencimento18":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 18"},"formaPagamento":{"type":"string","description":"Código da Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 14 - Duplicata Mercantil, 15 - Boleto Bancário, 90 - Sem pagamento)","enum":["01","02","03","04","05","10","11","12","13","14","15","90"]},"tipoIntegracao":{"type":"integer","description":"Código do Tipo da Integração (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Comércio Eletrônico)","enum":[1,2]},"CNPJCreden":{"type":"string","description":"Código do CNPJ da Credenciadora"},"bandOperadora":{"type":"string","description":"Código da Bandeira da Operadora (01 - Visa, 02 - Mastercard, 03 - American Expres, 04 - Sorocred, 05 - Diners Club, 06 - Elo, 07 - Hipercard, 08 - Aura, 09 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"numAutCartao":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Autorização do Cartão"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/condicaoVenda/{id}":{"put":{"tags":["Condição de Venda"],"summary":"Atualizar uma Condição de Venda","operationId":"AtualizarCondicaoVenda","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Condição de Venda","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da Condição de Venda","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CondicaoVendaPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CondicaoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /condicaoVenda/{id} > Excluir uma Condição Venda ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Condição de Venda","description":"condicaoVenda"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/condicaoVenda/{id}":{"delete":{"tags":["Condição de Venda"],"summary":"Excluir uma Condição Venda","operationId":"ExcluirCondicaoVenda","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Condição de Venda","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Cores cor ## GET /cor > Obter Listagem de Cores ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Cores","description":"cor"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaCores":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Cor"}}}},"Cor":{"type":"object","properties":{"codCor":{"type":"string","description":"Código da Cor"},"descricao":{"type":"string","description":"Descrição da Cor"},"codigoGrupo":{"type":"integer","description":"Código do Grupo de Cor"},"abreviatura":{"type":"string","description":"Abreviatura da Descrição da Cor"},"tipoCor":{"type":"integer","description":"Tipo da Cor (1 - Cor, 2 - Variante)","enum":[1,2]},"utilizacaoCor":{"type":"integer","description":"Tipo de Utilização a Cor (1 - Produto, 2 - Material, 3 - Produto ou Matrial)","enum":[1,2,3]},"status":{"type":"boolean","description":"Status da Cor (1 - Ativa, 0 - Inativa)"},"rgb":{"type":"string","description":"Código do RGB da Cor"},"grauDificuldade":{"type":"integer","description":"Código do Grau de Dificuldade da Cor"},"codTomCor":{"type":"integer","description":"Código do Tom da Cor"},"sequenciaCor":{"type":"integer","description":"Sequência da Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cor":{"get":{"tags":["Cores"],"summary":"Obter Listagem de Cores","operationId":"ObterCores","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaCores"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /cor/{id} > Obter uma Cor ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Cores","description":"cor"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Cor":{"type":"object","properties":{"codCor":{"type":"string","description":"Código da Cor"},"descricao":{"type":"string","description":"Descrição da Cor"},"codigoGrupo":{"type":"integer","description":"Código do Grupo de Cor"},"abreviatura":{"type":"string","description":"Abreviatura da Descrição da Cor"},"tipoCor":{"type":"integer","description":"Tipo da Cor (1 - Cor, 2 - Variante)","enum":[1,2]},"utilizacaoCor":{"type":"integer","description":"Tipo de Utilização a Cor (1 - Produto, 2 - Material, 3 - Produto ou Matrial)","enum":[1,2,3]},"status":{"type":"boolean","description":"Status da Cor (1 - Ativa, 0 - Inativa)"},"rgb":{"type":"string","description":"Código do RGB da Cor"},"grauDificuldade":{"type":"integer","description":"Código do Grau de Dificuldade da Cor"},"codTomCor":{"type":"integer","description":"Código do Tom da Cor"},"sequenciaCor":{"type":"integer","description":"Sequência da Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cor/{id}":{"get":{"tags":["Cores"],"summary":"Obter uma Cor","operationId":"ObterCor","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Cor","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Grupo De Cor grupoCor ## GET /grupoCor > Obter Listagem de Grupos de Cores ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Cor","description":"grupoCor"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaGrupoCores":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GrupoCor"}}}},"GrupoCor":{"type":"object","properties":{"codGrupoCor":{"type":"string","description":"Código do Grupo de Cor"},"descricao":{"type":"string","description":"Descrição do Grupo de Cor"},"tipoCor":{"type":"integer","description":"Tipo do Grupo de Cor (0 - Tinturaria, 1 - Estamparia Cilíndrica, 2 - Estamparia Digital, 3 - Semiacabados, 4 - Acabados Outros)","enum":[0,1,2,3,4]},"sequencia":{"type":"integer","description":"Sequência do Grupo de Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCor":{"get":{"tags":["Grupo de Cor"],"summary":"Obter Listagem de Grupos de Cores","operationId":"ObterGruposCor","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaGrupoCores"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /grupoCor/{id} > Obter um Grupo de Cor ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Cor","description":"grupoCor"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"GrupoCor":{"type":"object","properties":{"codGrupoCor":{"type":"string","description":"Código do Grupo de Cor"},"descricao":{"type":"string","description":"Descrição do Grupo de Cor"},"tipoCor":{"type":"integer","description":"Tipo do Grupo de Cor (0 - Tinturaria, 1 - Estamparia Cilíndrica, 2 - Estamparia Digital, 3 - Semiacabados, 4 - Acabados Outros)","enum":[0,1,2,3,4]},"sequencia":{"type":"integer","description":"Sequência do Grupo de Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCor/{id}":{"get":{"tags":["Grupo de Cor"],"summary":"Obter um Grupo de Cor","operationId":"ObterGrupoCor","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Grupo de Cor","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrupoCor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Catálogo De Cores De Tecido catalogoCorTecido ## GET /catalogoCorTecido > Obter Listagem de Catálogo de Cores de Tecido ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Catálogo de Cores de Tecido","description":"catalogoCorTecido"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaCatalogoCorTec":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogoCorTec"}}}},"CatalogoCorTec":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Catálogo de Cor"},"descricao":{"type":"string","description":"Descrição do Catálogo de Cor"},"dataLancamento":{"type":"string","description":"Data do Lançamento do Catálogo de Cor (YYYY-MM-DD)","format":"date"},"situacao":{"type":"boolean","description":"Situação do Catálogo de Cor"},"tabPrecoPicotada":{"type":"string","description":"Tabela de Preço Picotada do Catálogo de Cor"},"tabPrecoPromocional":{"type":"string","description":"Tabela de Preço Promocional do Catálogo de Cor"},"tabPrecoFechada":{"type":"string","description":"Tabela de Preço Fechada do Catálogo de Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/catalogoCorTecido":{"get":{"tags":["Catálogo de Cores de Tecido"],"summary":"Obter Listagem de Catálogo de Cores de Tecido","operationId":"ObterCatalogosCorTec","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","schema":{"type":"string"}},{"name":"mascaras","in":"query","description":"Código da Máscara do Produto","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"tipoFiltroMascara","in":"query","description":"Tipo do Filtro da Máscara do Produto: 1 - Desconsiderar Catálogo Cores, 2 - Considerar Catálogo Cores, 3 - Considerar Apenas Itens","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaCatalogoCorTec"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /catalogoCorTecido/{id} > Obter um Catálogo de Cor de Tecido ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Catálogo de Cores de Tecido","description":"catalogoCorTecido"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"CatalogoCorTec":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Catálogo de Cor"},"descricao":{"type":"string","description":"Descrição do Catálogo de Cor"},"dataLancamento":{"type":"string","description":"Data do Lançamento do Catálogo de Cor (YYYY-MM-DD)","format":"date"},"situacao":{"type":"boolean","description":"Situação do Catálogo de Cor"},"tabPrecoPicotada":{"type":"string","description":"Tabela de Preço Picotada do Catálogo de Cor"},"tabPrecoPromocional":{"type":"string","description":"Tabela de Preço Promocional do Catálogo de Cor"},"tabPrecoFechada":{"type":"string","description":"Tabela de Preço Fechada do Catálogo de Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/catalogoCorTecido/{id}":{"get":{"tags":["Catálogo de Cores de Tecido"],"summary":"Obter um Catálogo de Cor de Tecido","operationId":"ObterCatalogoCorTec","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Catálogo de Cor de tecido","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogoCorTec"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /catalogoCorTecido/{id}/produto > Obter Listagem dos Produtos do Catálogo de Cor ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Catálogo de Cores de Tecido","description":"catalogoCorTecido"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaProdCatalogoCorTec":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProdutoCatalogoCorTec"}}}},"ProdutoCatalogoCorTec":{"required":["codigoProduto"],"type":"object","properties":{"codigoProduto":{"type":"string","description":"Código do Produto para o Catálogo de Cor"},"situacao":{"type":"integer","description":"Situação do Produto no Catálogo de Cor (1-Ativo, 2-Inativo, 3-Cancelado)","enum":[1,2,3]},"prontaEntrega":{"type":"boolean","description":"Produto a Pronta Entrega?"},"operadorAprovProntaEntrega":{"type":"string","description":"Operador da Aprovação de Pronta Entrega"},"dataHoraAprovProntaEntrega":{"type":"string","description":"Data da Aprovação de Pronta Entrega (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"itemForaDeLinha":{"type":"boolean","description":"Item Fora de Linha?"},"operadorItemForaLinha":{"type":"string","description":"Operador que Gravou o Item como Fora de Linha"},"dataHoraItemForaLinha":{"type":"string","description":"Data da Aprovação do Item Fora de Linha (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"promocao":{"type":"boolean","description":"Item é de Promoção?"},"operadorPromocao":{"type":"string","description":"Operador que Gravou o Item como Promocional"},"dataHoraPromocao":{"type":"string","description":"Data da Aprovação do Item como Promocional (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"cores":{"type":"array","description":"Cores do Produto no Catálogo de Cor","items":{"$ref":"#/components/schemas/CorProdutoCatalogoTec"}},"acessorios":{"type":"array","description":"Código dos Acessórios do Produto no Catálogo de Cor","items":{"type":"string"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"CorProdutoCatalogoTec":{"required":["codCor"],"type":"object","properties":{"codCor":{"type":"string","description":"Código da Cor do Produto no Catálogo de Cor"},"codProdutoReduzido":{"type":"string","description":"Código Item Reduzido no Catálogo de Cor"},"situacao":{"type":"integer","description":"Situação da Cor no Catálogo de Cor (1-Ativo, 2-Inativo, 3-Cancelado)","enum":[1,2,3]},"foraDeLinha":{"type":"boolean","description":"Item Fora de Linha?"},"operadorItemForaLinha":{"type":"string","description":"Operador que Gravou o Item como Fora de Linha"},"dataHoraItemForaLinha":{"type":"string","description":"Data da Aprovação do Item Fora de Linha (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"promocao":{"type":"boolean","description":"Item é de Promoção?"},"operadorPromocao":{"type":"string","description":"Operador que Gravou o Item como Promocional"},"dataHoraPromocao":{"type":"string","description":"Data da Aprovação do Item como Promocional (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"liberacaoMinimaVenda":{"multipleOf":0.001,"type":"number","description":"Liberação Mínima para Venda"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/catalogoCorTecido/{id}/produto":{"get":{"tags":["Catálogo de Cores de Tecido"],"summary":"Obter Listagem dos Produtos do Catálogo de Cor","operationId":"ObterProdutosCatalogoCor","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Catálogo de Cor","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"mascaras","in":"query","description":"Código da Máscara do Produto","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaProdCatalogoCorTec"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /catalogoCorTecido/{id}/produto/{codProduto} > Obter um Produto do Catálogo de Cor de Tecido ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Catálogo de Cores de Tecido","description":"catalogoCorTecido"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ProdutoCatalogoCorTec":{"required":["codigoProduto"],"type":"object","properties":{"codigoProduto":{"type":"string","description":"Código do Produto para o Catálogo de Cor"},"situacao":{"type":"integer","description":"Situação do Produto no Catálogo de Cor (1-Ativo, 2-Inativo, 3-Cancelado)","enum":[1,2,3]},"prontaEntrega":{"type":"boolean","description":"Produto a Pronta Entrega?"},"operadorAprovProntaEntrega":{"type":"string","description":"Operador da Aprovação de Pronta Entrega"},"dataHoraAprovProntaEntrega":{"type":"string","description":"Data da Aprovação de Pronta Entrega (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"itemForaDeLinha":{"type":"boolean","description":"Item Fora de Linha?"},"operadorItemForaLinha":{"type":"string","description":"Operador que Gravou o Item como Fora de Linha"},"dataHoraItemForaLinha":{"type":"string","description":"Data da Aprovação do Item Fora de Linha (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"promocao":{"type":"boolean","description":"Item é de Promoção?"},"operadorPromocao":{"type":"string","description":"Operador que Gravou o Item como Promocional"},"dataHoraPromocao":{"type":"string","description":"Data da Aprovação do Item como Promocional (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"cores":{"type":"array","description":"Cores do Produto no Catálogo de Cor","items":{"$ref":"#/components/schemas/CorProdutoCatalogoTec"}},"acessorios":{"type":"array","description":"Código dos Acessórios do Produto no Catálogo de Cor","items":{"type":"string"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"CorProdutoCatalogoTec":{"required":["codCor"],"type":"object","properties":{"codCor":{"type":"string","description":"Código da Cor do Produto no Catálogo de Cor"},"codProdutoReduzido":{"type":"string","description":"Código Item Reduzido no Catálogo de Cor"},"situacao":{"type":"integer","description":"Situação da Cor no Catálogo de Cor (1-Ativo, 2-Inativo, 3-Cancelado)","enum":[1,2,3]},"foraDeLinha":{"type":"boolean","description":"Item Fora de Linha?"},"operadorItemForaLinha":{"type":"string","description":"Operador que Gravou o Item como Fora de Linha"},"dataHoraItemForaLinha":{"type":"string","description":"Data da Aprovação do Item Fora de Linha (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"promocao":{"type":"boolean","description":"Item é de Promoção?"},"operadorPromocao":{"type":"string","description":"Operador que Gravou o Item como Promocional"},"dataHoraPromocao":{"type":"string","description":"Data da Aprovação do Item como Promocional (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"liberacaoMinimaVenda":{"multipleOf":0.001,"type":"number","description":"Liberação Mínima para Venda"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/catalogoCorTecido/{id}/produto/{codProduto}":{"get":{"tags":["Catálogo de Cores de Tecido"],"summary":"Obter um Produto do Catálogo de Cor de Tecido","operationId":"ObterProdutoCatalogoCorTec","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Catálogo de Cor de tecido","required":true,"schema":{"type":"string"}},{"name":"codProduto","in":"path","description":"Código do Produto do catálogo","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProdutoCatalogoCorTec"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Modelagem Comercial modelagemComercial ## GET /modelagemComercial/{id} > Obter uma Modelagem Comercial ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Modelagem Comercial","description":"modelagemComercial"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ModelagemComercial":{"type":"object","properties":{"codModelagem":{"type":"string","description":"Código da Modelagem"},"descricao":{"type":"string","description":"Descrição da Modelagem"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/modelagemComercial/{id}":{"get":{"tags":["Modelagem Comercial"],"summary":"Obter uma Modelagem Comercial","operationId":"ObterModelagemComercial","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Modelagem Comercial","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelagemComercial"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Tipo De Nota tipoNota ## GET /tipoNota > Obter Listagem de Tipos de Nota ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tipo de Nota","description":"tipoNota"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTiposNota":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TipoNota"}}}},"TipoNota":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Tipo de Nota Fiscal"},"descricao":{"type":"string","description":"Descrição do Tipo de Nota Fiscal"},"possuiDuplicata":{"type":"boolean","description":"O Tipo de Nota Fiscal Possui Duplicata?"},"situacaoIpi":{"type":"integer","description":"Situação do IPI (0 - Sem IPI Isentas, 1 - Com IPI, 2 - Sem IPI Outras)","enum":[0,1,2]},"situacaoIcms":{"type":"integer","description":"Situação do ICMS (0 - Sem ICMS Isentas, 1 - Com ICMS, 2 - Sem ICMS Outras)","enum":[0,1,2]},"tipoIcms":{"type":"integer","description":"Tipo do ICMS (0 - Depende do Estado, 1 - Sempre 17%, 2 - Multiplas Aliquotas (Depende do Produto))","enum":[0,1,2]},"codCstIcms":{"type":"string","description":"Código do CST/ICMS do Tipo de Nota Fiscal"},"codCstIpi":{"type":"string","description":"Código do CST/IPI do Tipo de Nota Fiscal"},"situacaoComissao":{"type":"boolean","description":"Código do CST/ICMS do Tipo de Nota Fiscal"},"codMensagemNF":{"type":"integer","description":"Código da Mensagem para a Nota Fiscal"},"mercadoriaComercInd":{"type":"boolean","description":"Mercadoria para coml. Industrialização"},"codSerieFiscal":{"type":"integer","description":"Código da Série Fiscal do Tipo de Nota"},"codNaturezaOperacao":{"type":"integer","description":"Código da Natureza de Operação do Tipo de Nota"},"geraEstatisticaVenda":{"type":"boolean","description":"Gera Estatística de Vendas?"},"geraEstatisticaFaturamento":{"type":"boolean","description":"Gera Estatística de Faturamento?"},"entraLivroFiscal":{"type":"boolean","description":"Entra no Livro Fiscal?"},"percReducaoBaseIcms":{"multipleOf":0.00001,"type":"number","description":"Percentual de Redução da Base de ICMS"},"notaFiscalEspecial":{"type":"boolean","description":"Nota Fiscal será Especial?"},"zonaFrancaManaus":{"type":"boolean","description":"É para Zona Franca de Manaus?"},"codTransacaoEstoque":{"type":"integer","description":"Código da TRansação de Estoque para Movimentação"},"situacaoPisCofins":{"type":"integer","description":"Situação do PIS/COFINS (0 - Não Incide, 1 - PIS, 2 - COFINS, 3 - Ambos)","enum":[0,1,2,3]},"notaFiscalReferenciada":{"type":"boolean","description":"É Nota Fiscal Referenciada?"},"finalidadeNFe":{"type":"integer","description":"Código da Finalidade (0 - NF-e normal (1), 1 - NF-e complementar (2), 2 - NF-e de ajuste (3), 3 -Devolução (4))","enum":[0,1,2,3]},"descricaoNatOperacao":{"type":"string","description":"Descrição da Natureza de Operação do Tipo de Nota"},"codAjusteIcms":{"type":"string","description":"Código do Ajuste do ICMS"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"observEscrituracao":{"type":"string","description":"Observação da Escrituação"},"IcmsZonaFranca":{"type":"boolean","description":"ICMS para Zona Franca"},"codCstPisCofins":{"type":"string","description":"Código do CST/PIS/COFINS"},"codCfopPisCofins":{"type":"array","description":"Código da CFOP PIS/COFINS","items":{"type":"integer"}},"tipoContribuicaoPisCofins":{"type":"string","description":"Tipo de Contribuição de PIS/COFINS"},"codCsosn":{"type":"string","description":"CSOSN Código de Situação da Operação - SIMPLES NACIONAL"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tipoNota":{"get":{"tags":["Tipo de Nota"],"summary":"Obter Listagem de Tipos de Nota","operationId":"ObterTiposNota","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTiposNota"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tipoNota/{id} > Obter um Tipo de Nota ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tipo de Nota","description":"tipoNota"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TipoNota":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Tipo de Nota Fiscal"},"descricao":{"type":"string","description":"Descrição do Tipo de Nota Fiscal"},"possuiDuplicata":{"type":"boolean","description":"O Tipo de Nota Fiscal Possui Duplicata?"},"situacaoIpi":{"type":"integer","description":"Situação do IPI (0 - Sem IPI Isentas, 1 - Com IPI, 2 - Sem IPI Outras)","enum":[0,1,2]},"situacaoIcms":{"type":"integer","description":"Situação do ICMS (0 - Sem ICMS Isentas, 1 - Com ICMS, 2 - Sem ICMS Outras)","enum":[0,1,2]},"tipoIcms":{"type":"integer","description":"Tipo do ICMS (0 - Depende do Estado, 1 - Sempre 17%, 2 - Multiplas Aliquotas (Depende do Produto))","enum":[0,1,2]},"codCstIcms":{"type":"string","description":"Código do CST/ICMS do Tipo de Nota Fiscal"},"codCstIpi":{"type":"string","description":"Código do CST/IPI do Tipo de Nota Fiscal"},"situacaoComissao":{"type":"boolean","description":"Código do CST/ICMS do Tipo de Nota Fiscal"},"codMensagemNF":{"type":"integer","description":"Código da Mensagem para a Nota Fiscal"},"mercadoriaComercInd":{"type":"boolean","description":"Mercadoria para coml. Industrialização"},"codSerieFiscal":{"type":"integer","description":"Código da Série Fiscal do Tipo de Nota"},"codNaturezaOperacao":{"type":"integer","description":"Código da Natureza de Operação do Tipo de Nota"},"geraEstatisticaVenda":{"type":"boolean","description":"Gera Estatística de Vendas?"},"geraEstatisticaFaturamento":{"type":"boolean","description":"Gera Estatística de Faturamento?"},"entraLivroFiscal":{"type":"boolean","description":"Entra no Livro Fiscal?"},"percReducaoBaseIcms":{"multipleOf":0.00001,"type":"number","description":"Percentual de Redução da Base de ICMS"},"notaFiscalEspecial":{"type":"boolean","description":"Nota Fiscal será Especial?"},"zonaFrancaManaus":{"type":"boolean","description":"É para Zona Franca de Manaus?"},"codTransacaoEstoque":{"type":"integer","description":"Código da TRansação de Estoque para Movimentação"},"situacaoPisCofins":{"type":"integer","description":"Situação do PIS/COFINS (0 - Não Incide, 1 - PIS, 2 - COFINS, 3 - Ambos)","enum":[0,1,2,3]},"notaFiscalReferenciada":{"type":"boolean","description":"É Nota Fiscal Referenciada?"},"finalidadeNFe":{"type":"integer","description":"Código da Finalidade (0 - NF-e normal (1), 1 - NF-e complementar (2), 2 - NF-e de ajuste (3), 3 -Devolução (4))","enum":[0,1,2,3]},"descricaoNatOperacao":{"type":"string","description":"Descrição da Natureza de Operação do Tipo de Nota"},"codAjusteIcms":{"type":"string","description":"Código do Ajuste do ICMS"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"observEscrituracao":{"type":"string","description":"Observação da Escrituação"},"IcmsZonaFranca":{"type":"boolean","description":"ICMS para Zona Franca"},"codCstPisCofins":{"type":"string","description":"Código do CST/PIS/COFINS"},"codCfopPisCofins":{"type":"array","description":"Código da CFOP PIS/COFINS","items":{"type":"integer"}},"tipoContribuicaoPisCofins":{"type":"string","description":"Tipo de Contribuição de PIS/COFINS"},"codCsosn":{"type":"string","description":"CSOSN Código de Situação da Operação - SIMPLES NACIONAL"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tipoNota/{id}":{"get":{"tags":["Tipo de Nota"],"summary":"Obter um Tipo de Nota","operationId":"ObterTipoNota","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Tipo de Nota","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TipoNota"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Tabela De Preço Malharia tabelaPrecoMalharia ## GET /tabelaPrecoMalharia > Obter Listagem de Tabelas de Preço da Malharia ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Malharia","description":"tabelaPrecoMalharia"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTabPrecoMalharia":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoMalharia"}}}},"TabelaPrecoMalharia":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço da Malharia"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço da Malharia"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço da Malharia (0 - Inativa / 1 - Ativa)"},"tipoTabela":{"type":"integer","description":"Tipo de Tabela de Preço (0 - Grupo/Referência, 1-Referencia/Cor)","enum":[0,1]},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço da Malharia (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPrecoMalharia":{"get":{"tags":["Tabela de Preço Malharia"],"summary":"Obter Listagem de Tabelas de Preço da Malharia","operationId":"ObterTabelasPrecoMalharia","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Situação (0 - Inativa, 1 - Ativa)","schema":{"type":"boolean"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"mascaras","in":"query","description":"Código da Máscara do Produto","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"tipoFiltroMascara","in":"query","description":"Tipo do Filtro da Máscara do Produto: 1 - Desconsiderar Tabela Preço, 2 - Considerar Tabela Preço, 3 - Considerar Apenas Itens","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTabPrecoMalharia"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaPrecoMalharia/{id} > Obter uma Tabela de Preço da Malharia ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Malharia","description":"tabelaPrecoMalharia"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabelaPrecoMalharia":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço da Malharia"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço da Malharia"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço da Malharia (0 - Inativa / 1 - Ativa)"},"tipoTabela":{"type":"integer","description":"Tipo de Tabela de Preço (0 - Grupo/Referência, 1-Referencia/Cor)","enum":[0,1]},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço da Malharia (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPrecoMalharia/{id}":{"get":{"tags":["Tabela de Preço Malharia"],"summary":"Obter uma Tabela de Preço da Malharia","operationId":"ObterTabelaPrecoMalharia","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Tabela de Preço","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPrecoMalharia"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaPrecoMalharia/{id}/produto > Consulta Produtos da Tabela de Preço da Malharia ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Malharia","description":"tabelaPrecoMalharia"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaProdTabPrecoMalharia":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProdutoTabPrecoMalharia"}}}},"ProdutoTabPrecoMalharia":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Preço da Malharia"},"grupoCor":{"type":"string","description":"Código do Grupo de Cor da Tabela de Preço da Malharia"},"codProduto":{"type":"string","description":"Código do Produto na Tabela de Preço da Malharia"},"preco":{"type":"number","description":"Preço do Produto na Tabela de Preço"},"qtdLimiteParaPreco":{"type":"array","description":"Quantidade Limite para Este Preço","items":{"$ref":"#/components/schemas/LimiteQtdProdTabPreco"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"LimiteQtdProdTabPreco":{"type":"object","properties":{"qtdAteLimiteDe":{"multipleOf":0.001,"type":"number","description":"Quantidade Limite para Este Preço"},"preco":{"type":"number","description":"Preço para a Quantidade Limite"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPrecoMalharia/{id}/produto":{"get":{"tags":["Tabela de Preço Malharia"],"summary":"Consulta Produtos da Tabela de Preço da Malharia","operationId":"ObterProdutosTabPrecoMalharia","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Tabela de preço","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"mascaras","in":"query","description":"Código da Máscara do Produto","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaProdTabPrecoMalharia"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaPrecoMalharia/{id}/produto/{grupoCor}/{codProduto} > Obter um Produto da Tabela de Preço da Malharia ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Malharia","description":"tabelaPrecoMalharia"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ProdutoTabPrecoMalharia":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Preço da Malharia"},"grupoCor":{"type":"string","description":"Código do Grupo de Cor da Tabela de Preço da Malharia"},"codProduto":{"type":"string","description":"Código do Produto na Tabela de Preço da Malharia"},"preco":{"type":"number","description":"Preço do Produto na Tabela de Preço"},"qtdLimiteParaPreco":{"type":"array","description":"Quantidade Limite para Este Preço","items":{"$ref":"#/components/schemas/LimiteQtdProdTabPreco"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"LimiteQtdProdTabPreco":{"type":"object","properties":{"qtdAteLimiteDe":{"multipleOf":0.001,"type":"number","description":"Quantidade Limite para Este Preço"},"preco":{"type":"number","description":"Preço para a Quantidade Limite"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPrecoMalharia/{id}/produto/{grupoCor}/{codProduto}":{"get":{"tags":["Tabela de Preço Malharia"],"summary":"Obter um Produto da Tabela de Preço da Malharia","operationId":"ObterProdutoTabPrecoMalharia","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Tabela de preço","required":true,"schema":{"type":"string"}},{"name":"grupoCor","in":"path","description":"Código do Grupo de Cor","required":true,"schema":{"type":"string"}},{"name":"codProduto","in":"path","description":"Código do Produto","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProdutoTabPrecoMalharia"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Tabela De Preço Geral tabelaPrecos ## GET /tabelaPreco > Obter Listagem de tabelas de preço geral ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTabPreco":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPreco"}}}},"TabelaPreco":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço (0-Inativo 1-Ativo)"},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço (YYYY-MM-DD)","format":"date"},"codMensagem1":{"type":"string","description":"Mensagem da Tabela de Preço"},"codMensagem2":{"type":"string","description":"Complemento da Mensagem da Tabela de Preço"},"dataGeracao":{"type":"string","description":"Data da Geração da Tabela de Preço (YYYY-MM-DD)","format":"date"},"moeda":{"type":"integer","description":"Moeda da Tabela de Preço"},"situacaoICMS":{"type":"boolean","description":"Situação do ICMS (0-ICMS NAO 1-ATIVO)"},"situacaoPISCOFINS":{"type":"boolean","description":"Situação do PIS/COFINS (0-Inativo 1-Ativo)"},"produtosTabelaPreco":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutos"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"TabelaPrecoProdutos":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"multipleOf":0.01,"type":"number","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informado/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPreco":{"get":{"tags":["Tabela de Preço Geral"],"summary":"Obter Listagem de tabelas de preço geral","operationId":"ObterTabelasPrecoGeral","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Situação (0-Inativo 1-Ativo)","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"listarProdutos","in":"query","description":"Listar Produtos da Tabela de Preços (0 - Não, 1 - Sim)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTabPreco"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /tabelaPreco > Cadastrar uma Tabela de Preço Geral ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabelaPrecoPut":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço (0-Inativo 1-Ativo)"},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço (YYYY-MM-DD)","format":"date"},"codMensagem1":{"type":"string","description":"Mensagem da Tabela de Preço"},"codMensagem2":{"type":"string","description":"Complemento da Mensagem da Tabela de Preço"},"dataGeracao":{"type":"string","description":"Data da Geração da Tabela de Preço (YYYY-MM-DD)","format":"date"},"moeda":{"type":"integer","description":"Moeda da Tabela de Preço"},"situacaoICMS":{"type":"boolean","description":"Situação do ICMS (0-ICMS NAO 1-ATIVO)"},"situacaoPISCOFINS":{"type":"boolean","description":"Situação do PIS/COFINS (0-Inativo 1-Ativo)"},"produtosTabelaPreco":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutosPut"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"TabelaPrecoProdutosPut":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"type":"integer","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informad/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"TabelaPreco":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço (0-Inativo 1-Ativo)"},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço (YYYY-MM-DD)","format":"date"},"codMensagem1":{"type":"string","description":"Mensagem da Tabela de Preço"},"codMensagem2":{"type":"string","description":"Complemento da Mensagem da Tabela de Preço"},"dataGeracao":{"type":"string","description":"Data da Geração da Tabela de Preço (YYYY-MM-DD)","format":"date"},"moeda":{"type":"integer","description":"Moeda da Tabela de Preço"},"situacaoICMS":{"type":"boolean","description":"Situação do ICMS (0-ICMS NAO 1-ATIVO)"},"situacaoPISCOFINS":{"type":"boolean","description":"Situação do PIS/COFINS (0-Inativo 1-Ativo)"},"produtosTabelaPreco":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutos"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"TabelaPrecoProdutos":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"multipleOf":0.01,"type":"number","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informado/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPreco":{"put":{"tags":["Tabela de Preço Geral"],"summary":"Cadastrar uma Tabela de Preço Geral","operationId":"CadastrarTabelaGeral","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da Tabela","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPrecoPut"}}},"required":false},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPreco"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaPrecoEAN/{id} > Obter preço de venda a partir do código EAN ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTabPreco":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPreco"}}}},"TabelaPreco":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço (0-Inativo 1-Ativo)"},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço (YYYY-MM-DD)","format":"date"},"codMensagem1":{"type":"string","description":"Mensagem da Tabela de Preço"},"codMensagem2":{"type":"string","description":"Complemento da Mensagem da Tabela de Preço"},"dataGeracao":{"type":"string","description":"Data da Geração da Tabela de Preço (YYYY-MM-DD)","format":"date"},"moeda":{"type":"integer","description":"Moeda da Tabela de Preço"},"situacaoICMS":{"type":"boolean","description":"Situação do ICMS (0-ICMS NAO 1-ATIVO)"},"situacaoPISCOFINS":{"type":"boolean","description":"Situação do PIS/COFINS (0-Inativo 1-Ativo)"},"produtosTabelaPreco":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutos"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"TabelaPrecoProdutos":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"multipleOf":0.01,"type":"number","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informado/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPrecoEAN/{id}":{"get":{"tags":["Tabela de Preço Geral"],"summary":"Obter preço de venda a partir do código EAN","operationId":"ObterTabelaPrecoEAN","parameters":[{"name":"empresa","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da tabela","required":true,"schema":{"type":"string"}},{"name":"codEAN","in":"query","description":"Código EAN do produto","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTabPreco"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaPreco/{id} > Obter uma Tabela de Preço Geral ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTabPreco":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPreco"}}}},"TabelaPreco":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço (0-Inativo 1-Ativo)"},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço (YYYY-MM-DD)","format":"date"},"codMensagem1":{"type":"string","description":"Mensagem da Tabela de Preço"},"codMensagem2":{"type":"string","description":"Complemento da Mensagem da Tabela de Preço"},"dataGeracao":{"type":"string","description":"Data da Geração da Tabela de Preço (YYYY-MM-DD)","format":"date"},"moeda":{"type":"integer","description":"Moeda da Tabela de Preço"},"situacaoICMS":{"type":"boolean","description":"Situação do ICMS (0-ICMS NAO 1-ATIVO)"},"situacaoPISCOFINS":{"type":"boolean","description":"Situação do PIS/COFINS (0-Inativo 1-Ativo)"},"produtosTabelaPreco":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutos"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"TabelaPrecoProdutos":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"multipleOf":0.01,"type":"number","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informado/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPreco/{id}":{"get":{"tags":["Tabela de Preço Geral"],"summary":"Obter uma Tabela de Preço Geral","operationId":"ObterDadosTabelaPreco","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Tabela","required":true,"schema":{"type":"string"}},{"name":"codProduto","in":"query","description":"Código do Produto","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTabPreco"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /tabelaPreco/{id} > Atualizar Tabela de Preço Geral ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabelaPrecoPut":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço (0-Inativo 1-Ativo)"},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço (YYYY-MM-DD)","format":"date"},"codMensagem1":{"type":"string","description":"Mensagem da Tabela de Preço"},"codMensagem2":{"type":"string","description":"Complemento da Mensagem da Tabela de Preço"},"dataGeracao":{"type":"string","description":"Data da Geração da Tabela de Preço (YYYY-MM-DD)","format":"date"},"moeda":{"type":"integer","description":"Moeda da Tabela de Preço"},"situacaoICMS":{"type":"boolean","description":"Situação do ICMS (0-ICMS NAO 1-ATIVO)"},"situacaoPISCOFINS":{"type":"boolean","description":"Situação do PIS/COFINS (0-Inativo 1-Ativo)"},"produtosTabelaPreco":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutosPut"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"TabelaPrecoProdutosPut":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"type":"integer","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informad/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPreco/{id}":{"put":{"tags":["Tabela de Preço Geral"],"summary":"Atualizar Tabela de Preço Geral","operationId":"AtualizarTabelaGeral","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Tabela","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da Tabela","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPrecoPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPrecoPut"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /tabelaPreco/{id} > Excluir uma Tabela Geral ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPreco/{id}":{"delete":{"tags":["Tabela de Preço Geral"],"summary":"Excluir uma Tabela Geral","operationId":"ExcluirTabelaGeral","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Tabela","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /tabelaPreco/{id}/produto > Cadastrar uma Tabela de Preço Item ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabelaPrecoProdutosArrayPut":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutosPut"}}}},"TabelaPrecoProdutosPut":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"type":"integer","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informad/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"TabelaPrecoProdutos":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"multipleOf":0.01,"type":"number","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informado/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPreco/{id}/produto":{"put":{"tags":["Tabela de Preço Geral"],"summary":"Cadastrar uma Tabela de Preço Item","operationId":"CadastrarTabelaItem","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Tabela","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da Tabela","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPrecoProdutosArrayPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPrecoProdutos"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /tabelaPreco/{id}/produto/{codProduto} > Atualizar uma Tabela de Preço Item ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabelaPrecoProdutosPut":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"type":"integer","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informad/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"TabelaPrecoProdutos":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"multipleOf":0.01,"type":"number","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informado/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPreco/{id}/produto/{codProduto}":{"put":{"tags":["Tabela de Preço Geral"],"summary":"Atualizar uma Tabela de Preço Item","operationId":"AtualizarTabelaPrecoItem","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Tabela","required":true,"schema":{"type":"string"}},{"name":"codProduto","in":"path","description":"Código do Produto","required":true,"schema":{"type":"string"}},{"name":"codFaixa","in":"query","description":"Código da Faixa","schema":{"type":"string"}}],"requestBody":{"description":"Dados da Tabela","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPrecoProdutosPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaPrecoProdutos"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /tabelaPreco/{id}/produto/{codProduto} > Excluir uma Tabela de Preço Item ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPreco/{id}/produto/{codProduto}":{"delete":{"tags":["Tabela de Preço Geral"],"summary":"Excluir uma Tabela de Preço Item","operationId":"ExcluirTabelaPrecoItem","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Tabela","required":true,"schema":{"type":"string"}},{"name":"codProduto","in":"path","description":"Código do Produto","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaPrecoCliente/{id} > Obter Tabelas de Preço por Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tabela de Preço Geral","description":"tabelaPrecos"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabelasPrecoCliente":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codCliente":{"type":"string","description":"Código do Cliente"},"tabelasPrecoCliente":{"type":"array","items":{"$ref":"#/components/schemas/ListaTabelasPrecoCliente"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaTabelasPrecoCliente":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaPrecoCliente/{id}":{"get":{"tags":["Tabela de Preço Geral"],"summary":"Obter Tabelas de Preço por Cliente","operationId":"ObterTabelaPrecoCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Cliente","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelasPrecoCliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Tipo De Cobrança tipoCobranca ## GET /tipoCobranca > Obter Listagem de Tipos de Cobrança ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tipo de Cobrança","description":"tipoCobranca"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTipoCobranca":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TipoCobranca"}}}},"TipoCobranca":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do Tipo de Cobrança"},"descricao":{"type":"string","description":"Descrição do Tipo de Cobrança"},"contabAux":{"type":"boolean","description":"Possui Contabilização Auxiliar? (0 - Não, 1 - Sim)"},"bloqContBan":{"type":"boolean","description":"Bloqueia Lançamentos no Controle Bancário? (0 - Não, 1 - Sim)"},"tipoCobrancaVendor":{"type":"boolean","description":"Tipo de Cobrança Vendor? (0 - Não, 1 - Sim)"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tipoCobranca":{"get":{"tags":["Tipo de Cobrança"],"summary":"Obter Listagem de Tipos de Cobrança","operationId":"ConsultarTiposCobranca","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTipoCobranca"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tipoCobranca/{id} > Obter Tipo de Cobrança ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Tipo de Cobrança","description":"tipoCobranca"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TipoCobranca":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do Tipo de Cobrança"},"descricao":{"type":"string","description":"Descrição do Tipo de Cobrança"},"contabAux":{"type":"boolean","description":"Possui Contabilização Auxiliar? (0 - Não, 1 - Sim)"},"bloqContBan":{"type":"boolean","description":"Bloqueia Lançamentos no Controle Bancário? (0 - Não, 1 - Sim)"},"tipoCobrancaVendor":{"type":"boolean","description":"Tipo de Cobrança Vendor? (0 - Não, 1 - Sim)"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tipoCobranca/{id}":{"get":{"tags":["Tipo de Cobrança"],"summary":"Obter Tipo de Cobrança","operationId":"ObterTipoCobranca","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Tipo de Cobrança","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TipoCobranca"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Ramo De Atividade ramoAtividade ## GET /ramoAtividade > Obter Listagem de Ramos de Atividade ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ramo de Atividade","description":"ramoAtividade"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaRamosAtividades":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RamoAtividade"}}}},"RamoAtividade":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codRamoAtiv":{"type":"string","description":"Código do Ramo de Atividade"},"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/ramoAtividade":{"get":{"tags":["Ramo de Atividade"],"summary":"Obter Listagem de Ramos de Atividade","operationId":"ObterRamosAtividades","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaRamosAtividades"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /ramoAtividade/{id} > Obter um Ramo de Atividade ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ramo de Atividade","description":"ramoAtividade"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RamoAtividade":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codRamoAtiv":{"type":"string","description":"Código do Ramo de Atividade"},"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/ramoAtividade/{id}":{"get":{"tags":["Ramo de Atividade"],"summary":"Obter um Ramo de Atividade","operationId":"ObterRamoAtividade","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Ramo de Atividade","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RamoAtividade"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Ocorrência Do Cliente ocorrenciaCliente ## GET /ocorrencia > Obter Listagem de Ocorrências do Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ocorrência do Cliente","description":"ocorrenciaCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaOcorrencia":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ListaOcorrenciasClientes"}}}},"ListaOcorrenciasClientes":{"type":"object","properties":{"codSequencia":{"type":"integer","description":"Código da Sequencia"},"descricao":{"type":"string","description":"Descrição da Ocorrência"},"situacao":{"type":"integer","description":"Situação da Ocorrência (0-Cadastrado, 1-Gerado pelo cadastro de clientes, 2-Gerada pela cobrança escritural, 3-Gerada pelo Agendamento, 4-Gerada pela API)","enum":[0,1,2,3,4]},"codArea":{"type":"integer","description":"Código da Área"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/ocorrencia":{"get":{"tags":["Ocorrência do Cliente"],"summary":"Obter Listagem de Ocorrências do Cliente","operationId":"ObterListagemOcorrenciasClientes","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codCliente","in":"query","description":"Código do Cliente","required":true,"schema":{"type":"integer"}},{"name":"dataLancamento","in":"query","description":"Data de Lançamento da Ocorrência (YYYY-MM-DD)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaOcorrencia"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /ocorrencia/{codCliente} > Obter uma Ocorrência do Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ocorrência do Cliente","description":"ocorrenciaCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"OcorrenciaCliente":{"type":"object","properties":{"descricao":{"type":"string","description":"Descrição da Ocorrência"},"situacao":{"type":"integer","description":"Situação da Ocorrência (0-Cadastrado, 1-Gerado pelo cadastro de clientes, 2-Gerada pela cobrança escritural, 3-Gerada pelo Agendamento, 4-Gerada pela API)","enum":[0,1,2,3,4]},"codArea":{"type":"integer","description":"Código da Área"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/ocorrencia/{codCliente}":{"get":{"tags":["Ocorrência do Cliente"],"summary":"Obter uma Ocorrência do Cliente","operationId":"ObterOcorrenciaCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codCliente","in":"path","description":"Código do Cliente","required":true,"schema":{"type":"integer"}},{"name":"dataLancamento","in":"query","description":"Data de Lançamento da Ocorrência (YYYY-MM-DD)","required":true,"schema":{"type":"string"}},{"name":"sequencia","in":"query","description":"Código da Sequência","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OcorrenciaCliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /ocorrencia/{codCliente} > Cadastrar uma Ocorrência do Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ocorrência do Cliente","description":"ocorrenciaCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"OcorrenciaPut":{"required":["codArea","dataLancamento","descricao"],"type":"object","properties":{"dataLancamento":{"type":"string","description":"Data de Lançamento da Ocorrência (DD-MM-YYYY)","format":"date"},"descricao":{"type":"string","description":"Descrição da Ocorrência"},"codArea":{"maximum":9999,"type":"integer","description":"Código da Área"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"OcorrenciaCliente":{"type":"object","properties":{"descricao":{"type":"string","description":"Descrição da Ocorrência"},"situacao":{"type":"integer","description":"Situação da Ocorrência (0-Cadastrado, 1-Gerado pelo cadastro de clientes, 2-Gerada pela cobrança escritural, 3-Gerada pelo Agendamento, 4-Gerada pela API)","enum":[0,1,2,3,4]},"codArea":{"type":"integer","description":"Código da Área"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/ocorrencia/{codCliente}":{"put":{"tags":["Ocorrência do Cliente"],"summary":"Cadastrar uma Ocorrência do Cliente","operationId":"CadastrarOcorrenciaCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codCliente","in":"path","description":"Código do Cliente","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Dados da Ocorrência","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OcorrenciaPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OcorrenciaCliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /ocorrencia/{codCliente} > Excluir uma Ocorrência do Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Ocorrência do Cliente","description":"ocorrenciaCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/ocorrencia/{codCliente}":{"delete":{"tags":["Ocorrência do Cliente"],"summary":"Excluir uma Ocorrência do Cliente","operationId":"ExcluirOcorrenciaCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codCliente","in":"path","description":"Código do Cliente","required":true,"schema":{"type":"integer"}},{"name":"dataLancamento","in":"query","description":"Data de Lançamento da Ocorrência (YYYY-MM-DD)","schema":{"type":"string"}},{"name":"sequencia","in":"query","description":"Código da Sequência","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Unidade Monetária unidadeMonetaria ## GET /unidadeMonetaria > Obter Listagem de Unidades Monetárias ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Unidade Monetária","description":"unidadeMonetaria"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaUnidadesMonetarias":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UnidadeMonetaria"}}}},"UnidadeMonetaria":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Unidade Monetária"},"descricao":{"type":"string","description":"Descrição da Unidade Monetária"},"simbologia":{"type":"string","description":"Simbologia da Unidade Monetária"},"abreviatura":{"type":"string","description":"Abreviatura da Unidade Monetária"},"numeroDecimais":{"type":"integer","description":"Decimais da Unidade Monetária"},"variacao":{"type":"integer","description":"Variação da Unidade Monetária (1-Fixo, 2-Diário, 3-Mensal)","enum":[1,2,3]},"tipoUnidade":{"type":"integer","description":"Tipo da Unidade Monetária (1-Por Cotação, 2-Fixo)","enum":[1,2]}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/unidadeMonetaria":{"get":{"tags":["Unidade Monetária"],"summary":"Obter Listagem de Unidades Monetárias","operationId":"ObterUnidadesMonetarias","parameters":[{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaUnidadesMonetarias"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /unidadeMonetaria/{id} > Obter Unidade Monetária ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Unidade Monetária","description":"unidadeMonetaria"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"UnidadeMonetaria":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Unidade Monetária"},"descricao":{"type":"string","description":"Descrição da Unidade Monetária"},"simbologia":{"type":"string","description":"Simbologia da Unidade Monetária"},"abreviatura":{"type":"string","description":"Abreviatura da Unidade Monetária"},"numeroDecimais":{"type":"integer","description":"Decimais da Unidade Monetária"},"variacao":{"type":"integer","description":"Variação da Unidade Monetária (1-Fixo, 2-Diário, 3-Mensal)","enum":[1,2,3]},"tipoUnidade":{"type":"integer","description":"Tipo da Unidade Monetária (1-Por Cotação, 2-Fixo)","enum":[1,2]}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/unidadeMonetaria/{id}":{"get":{"tags":["Unidade Monetária"],"summary":"Obter Unidade Monetária","operationId":"ObterUnidadeMonetaria","parameters":[{"name":"id","in":"path","description":"Código da Unidade Monetária","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnidadeMonetaria"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /unidadeMonetariaCotacao/{id} > Obter Cotação de uma Unidade Monetária ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Unidade Monetária","description":"unidadeMonetaria"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaCotacoesUnidadeMonetaria":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Unidade Monetária"},"dataReferencia":{"type":"string","description":"Data de Referência para Cotação (YYYY-MM-DD)","format":"date"},"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaCotacoesUniMonetaria":{"type":"array","description":"Cotações da Unidade Monetária","items":{"$ref":"#/components/schemas/CotacoesUnidadeMonetaria"}}}},"CotacoesUnidadeMonetaria":{"type":"object","properties":{"dataCotacao":{"type":"string","description":"Data da Cotação (YYYY-MM-DD)","format":"date"},"valorUniMonetData":{"multipleOf":0.01,"type":"number","description":"Cotação da Unidade Monetária na Data"},"variacaoUniMonetData":{"multipleOf":0.01,"type":"number","description":"Variação da Cotação da Unidade Monetária na Data"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/unidadeMonetariaCotacao/{id}":{"get":{"tags":["Unidade Monetária"],"summary":"Obter Cotação de uma Unidade Monetária","operationId":"ObterCotacaoUnidadeMonetaria","parameters":[{"name":"id","in":"path","description":"Código da Unidade Monetária","required":true,"schema":{"type":"string"}},{"name":"dataReferencia","in":"query","description":"Data de Referência para Obter Cotação da Unidade Monetária (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}},{"name":"qtdDiasCotacoes","in":"query","description":"Quantidade de Cotações Anteriores a Data de Referência","schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaCotacoesUnidadeMonetaria"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The Empresa object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"Empresa":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa (1/2)"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Empresa"},"nome":{"type":"string","description":"Nome da Empresa"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"situacao":{"type":"integer","description":"Situação da Empresa (0-Inativo, 1-Ativo)","enum":[0,1]},"nomeFantasia":{"type":"string","description":"Descrição do Nome Fantasia da Empresa"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade da Empresa (1-Indústria, 2-Comércio, 3-Prestação de Serviços, 4-Indústria/Comércio, 5-Indústria/Serviço, 6-Indústria/Comércio/Serviço, 7-Comércio/Serviços, 9-Outros)","enum":[1,2,3,4,5,6,7,9]},"endereco":{"type":"string","description":"Endereço da Empresa"},"numero":{"type":"string","description":"Número do Endereço da Empresa"},"complemento":{"type":"string","description":"Complemento do Endereço da Empresa"},"bairro":{"type":"string","description":"Bairro da Empresa"},"cep":{"type":"string","description":"Código do CEP da Empresa (99999-999)"},"cidade":{"type":"string","description":"Nome da Cidade da Empresa"},"estado":{"type":"string","description":"Estado da Empresa"},"codIbge":{"type":"string","description":"Código do IBGE da Empresa"},"telefoneDDD":{"type":"string","description":"DDD do Telefone da Empresa (047/041)"},"telefonePrefixo":{"type":"string","description":"Prefixo do Telefone da Empresa"},"telefone":{"type":"string","description":"Telefone da Empresa"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaEmpresas object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaEmpresas":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Empresa"}}}},"Empresa":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa (1/2)"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Empresa"},"nome":{"type":"string","description":"Nome da Empresa"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"situacao":{"type":"integer","description":"Situação da Empresa (0-Inativo, 1-Ativo)","enum":[0,1]},"nomeFantasia":{"type":"string","description":"Descrição do Nome Fantasia da Empresa"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade da Empresa (1-Indústria, 2-Comércio, 3-Prestação de Serviços, 4-Indústria/Comércio, 5-Indústria/Serviço, 6-Indústria/Comércio/Serviço, 7-Comércio/Serviços, 9-Outros)","enum":[1,2,3,4,5,6,7,9]},"endereco":{"type":"string","description":"Endereço da Empresa"},"numero":{"type":"string","description":"Número do Endereço da Empresa"},"complemento":{"type":"string","description":"Complemento do Endereço da Empresa"},"bairro":{"type":"string","description":"Bairro da Empresa"},"cep":{"type":"string","description":"Código do CEP da Empresa (99999-999)"},"cidade":{"type":"string","description":"Nome da Cidade da Empresa"},"estado":{"type":"string","description":"Estado da Empresa"},"codIbge":{"type":"string","description":"Código do IBGE da Empresa"},"telefoneDDD":{"type":"string","description":"DDD do Telefone da Empresa (047/041)"},"telefonePrefixo":{"type":"string","description":"Prefixo do Telefone da Empresa"},"telefone":{"type":"string","description":"Telefone da Empresa"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The LimiteCliente object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"LimiteCliente":{"required":["cnpjCpf"],"type":"object","properties":{"cnpjCpf":{"type":"string","description":"Código do CPF/CNPJ"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito"},"usuario":{"type":"string","description":"Código do Usuário do Limite"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Representante object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (1 - Produto, 2 - Representante, 3 - Condição de Venda 1 Sequencia, 4 - Condição de Venda 2 Sequencia, 5 - Condição de Venda 3 Sequencia, 6 - Tabela de Preço)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The RepresentantePut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"RepresentantePut":{"required":["bairro","cep","cpfCnpj","dataAdmissao","endereco","nome","situacao","tipoComissao"],"type":"object","properties":{"codRepresentante":{"maximum":9999,"type":"integer","description":"Código do Representante (1 / 124 / 45)"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Representante (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Representante (Rua / Logradouro)"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro do Representante"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"CEP do Representante (sem formatação)"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Representante"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Representante"},"codIbge":{"maxLength":7,"minLength":7,"type":"string","description":"Código do IBGE do Representante"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"maxLength":20,"type":"string","description":"Telefone Celular do Representante"},"contato":{"maxLength":30,"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão (1-Produto, 2-Representante, 3-Condição de Venda 1 Sequencia, 4-Condição de Venda 2 Sequencia, 5-Condição de Venda 3 Sequencia, 6-Tabela de Preço)","enum":[1,2,3,4,5,6]},"percComissao":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante (5.00%)"},"email":{"maxLength":60,"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante (YYYY-MM-DD)","format":"date"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaRepresentantes object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaRepresentantes":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Representante"}}}},"Representante":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Representante"},"nome":{"type":"string","description":"Nome do Representante"},"situacao":{"type":"integer","description":"Situação do Representante (1-Física, 2-Jurídica, 3-Empregado, 4-Micro-Empresa, 5-Inativo)","enum":[1,2,3,4,5]},"endereco":{"type":"string","description":"Endereço do Representante"},"bairro":{"type":"string","description":"Bairro do Representante"},"cep":{"type":"string","description":"CEP do Representante"},"cidade":{"type":"string","description":"Cidade do Representante"},"estado":{"type":"string","description":"Estado do Representante"},"codIbge":{"type":"string","description":"Código do IBGE do Representante"},"telefone":{"type":"string","description":"Telefone do Representante"},"telefoneCelular":{"type":"string","description":"Telefone Celular do Representante"},"contato":{"type":"string","description":"Contato do Representante"},"tipoComissao":{"type":"integer","description":"Código do Tipo de Comissão do Representante (1 - Produto, 2 - Representante, 3 - Condição de Venda 1 Sequencia, 4 - Condição de Venda 2 Sequencia, 5 - Condição de Venda 3 Sequencia, 6 - Tabela de Preço)","enum":[1,2,3,4,5,6]},"percComissao":{"type":"number","description":"Percentual de Comissão do Representante"},"email":{"type":"string","description":"E-mail do Representante"},"dataAdmissao":{"type":"string","description":"Data de Admissão do Representante"},"dataDesligamento":{"type":"string","description":"Data de Desligamento do Representante"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Cliente object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"Cliente":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Cliente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Cliente"},"nome":{"type":"string","description":"Nome do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"type":"integer","description":"Código do Terceiro Representante"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Representante"},"inscSuframa":{"type":"string","description":"Código da Inscrição Suframa Representante"},"contatoCompras":{"type":"string","description":"Contato de Compras do Cliente"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"codSetorVenda":{"type":"integer","description":"Código do Setor de venda do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Cliente"},"numero":{"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"type":"string","description":"Bairro do Cliente"},"cep":{"type":"string","description":"Código do CEP do Cliente"},"cidade":{"type":"string","description":"Cidade do Cliente"},"estado":{"type":"string","description":"Estado do Cliente"},"codIbge":{"type":"string","description":"Código do IBGE do Cliente"},"email":{"type":"string","description":"E-mail do Cliente"},"emailNfe":{"type":"string","description":"E-mail do Cliente para envio da Nota Fiscal Eletrônica"},"telefone":{"type":"string","description":"Telefone do Cliente"},"telefoneCobranca":{"type":"string","description":"Telefone de Cobrança do Cliente"},"fax":{"type":"string","description":"Fax do Cliente"},"telexCelular":{"type":"string","description":"Telefone Celular do Cliente"},"observacao":{"type":"string","description":"Observação do Cadastro do Cliente"},"aliqIcms":{"type":"string","description":"Aliquota de ICMS da UF do Cliente [Deprecado]"},"percAliqICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS da UF do Cliente"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito do Cliente"},"valorMaiorAcumulo":{"type":"number","description":"Valor Maior Acumulado do Cliente"},"dataMaiorFatura":{"type":"string","description":"Data da Maior Fatura do Cliente","format":"date"},"dataPrimeiraCompra":{"type":"string","description":"Data da Primeira Compra do Cliente","format":"date"},"dataCadastro":{"type":"string","description":"Data do Cadastro do Cliente","format":"date"},"valorTotalFaturado":{"multipleOf":0.01,"type":"number","description":"Valor Total já Faturado do Cliente"},"prazoMedioVendas":{"type":"string","description":"Prazo médio de Vendas do Cliente"},"clienteCentralizador":{"type":"integer","description":"Código do Cliente Centralizador"},"cnpjClienteCentralizador":{"type":"string","description":"Código do CNPJ do Cliente Centralizador"},"codSubRamoAtiv":{"type":"integer","description":"Sub Ramo de Atividade"},"codBacen":{"type":"integer","description":"Código do Bacen"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"dadosCobranca":{"type":"array","description":"Dados de Cobrança do Cliente","items":{"$ref":"#/components/schemas/ClienteDadosCobranca"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"informacoesComplementares":{"type":"array","description":"Informações Complementares do Cliente","items":{"$ref":"#/components/schemas/ClienteInfComplementares"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"grupoComercial":{"type":"array","description":"Grupo Comercial do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoComercial"}},"grupoCNPJ":{"type":"array","description":"Grupo CNPJ do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoCNPJ"}},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}},"ClienteDadosCobranca":{"type":"object","properties":{"codPortador":{"maxLength":4,"type":"string","description":"Código do Portador"},"codTipoCobranca":{"maxLength":3,"type":"string","description":"Código do Tipo de Cobrança"},"codCondicaoPagamento":{"maxLength":3,"type":"string","description":"Código da Condição de Pagamento"}}},"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}},"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}},"ClienteInfComplementares":{"type":"object","properties":{"codAtendente":{"maxLength":4,"type":"string","description":"Código do Atendente"},"nomeAtendente":{"maxLength":60,"type":"string","description":"Nome do Atendente"}}},"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}},"ListaGrupoComercial":{"type":"object","properties":{"clienteAgrupador":{"maximum":9999999,"type":"integer"},"clientesAgrupados":{"type":"array","items":{"$ref":"#/components/schemas/ListaClientesAgrupados"}}}},"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}},"ListaGrupoCNPJ":{"type":"object","properties":{"clienteAgrupado":{"type":"integer","description":"Código do Cliente Agrupado"},"cnpjAgrupado":{"type":"string","description":"CNPJ do Cliente Agrupado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ClientePut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ClientePut":{"required":["bairro","cep","codRamoAtividade","codRepresentante","consumidorFinal","cpfCnpj","endereco","nome","numero","situacao"],"type":"object","properties":{"codCliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Cliente (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Cliente"},"codRepresentante":{"maximum":9999,"minimum":1,"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"maximum":9999,"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"maximum":9999,"type":"integer","description":"Código do Terceiro Representante"},"codSetorVenda":{"maximum":999,"minimum":1,"type":"integer","description":"Código do Setor de Vendas do Cliente"},"inscEstadual":{"maxLength":17,"type":"string","description":"Código da Inscrição Estadual do Cliente (sem formatação)"},"inscSuframa":{"maxLength":9,"type":"string","description":"Código da Inscrição Suframa do Cliente (sem formatação)"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Equipara Cliente Contribuinte (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"maximum":99,"minimum":1,"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Não, 1-Sim)","enum":[0,1]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Cliente"},"numero":{"maxLength":10,"minLength":1,"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"maxLength":30,"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Cliente"},"parecerCredito":{"maxLength":9999,"type":"string","description":"Parecer de Crédito/Cobrança"},"qualificacaoCliente":{"maxLength":2,"type":"string","description":"Qualificação do Cliente"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP do Cliente (sem formatação)"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Cliente"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Cliente"},"codIbge":{"maxLength":7,"minLength":7,"type":"string","description":"Código do IBGE do Cliente"},"email":{"maxLength":100,"type":"string","description":"E-mail do Cliente (exemplo@exemplo.com.br)"},"emailNfe":{"maxLength":100,"type":"string","description":"E-mail do Cliente para Nota Fiscal Eletrônica (exemplo@exemplo.com.br)"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Cliente"},"fax":{"maxLength":20,"type":"string","description":"Fax do Cliente"},"telexCelular":{"maxLength":20,"type":"string","description":"Telefone Celular do Cliente"},"telefoneCobranca":{"maxLength":20,"type":"string","description":"Telefone Cobranca (whatsapp) do Cliente"},"codSubRamoAtiv":{"maximum":999,"type":"integer","description":"Código do Sub Ramo de Atividade"},"observacao":{"maxLength":70,"type":"string","description":"Observação do Cadastro do Cliente"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}},"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}},"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}},"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ClienteEnderecoEntrega object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}}}}} ``` ## The ClienteDadosCobranca object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ClienteDadosCobranca":{"type":"object","properties":{"codPortador":{"maxLength":4,"type":"string","description":"Código do Portador"},"codTipoCobranca":{"maxLength":3,"type":"string","description":"Código do Tipo de Cobrança"},"codCondicaoPagamento":{"maxLength":3,"type":"string","description":"Código da Condição de Pagamento"}}}}}} ``` ## The CompradorPrincipalCliente object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}}}}} ``` ## The CompradoresCliente object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}}}}} ``` ## The ClienteInfComplementares object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ClienteInfComplementares":{"type":"object","properties":{"codAtendente":{"maxLength":4,"type":"string","description":"Código do Atendente"},"nomeAtendente":{"maxLength":60,"type":"string","description":"Nome do Atendente"}}}}}} ``` ## The ClienteEstruturaComercial object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}}}}} ``` ## The ListaGrupoComercial object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaGrupoComercial":{"type":"object","properties":{"clienteAgrupador":{"maximum":9999999,"type":"integer"},"clientesAgrupados":{"type":"array","items":{"$ref":"#/components/schemas/ListaClientesAgrupados"}}}},"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}}}}} ``` ## The ListaClientesAgrupados object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}}}}} ``` ## The ListaGrupoCNPJ object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaGrupoCNPJ":{"type":"object","properties":{"clienteAgrupado":{"type":"integer","description":"Código do Cliente Agrupado"},"cnpjAgrupado":{"type":"string","description":"CNPJ do Cliente Agrupado"}}}}}} ``` ## The ListaClientes object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaClientes":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Cliente"}}}},"Cliente":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Cliente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Cliente"},"nome":{"type":"string","description":"Nome do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"type":"integer","description":"Código do Terceiro Representante"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Representante"},"inscSuframa":{"type":"string","description":"Código da Inscrição Suframa Representante"},"contatoCompras":{"type":"string","description":"Contato de Compras do Cliente"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"codSetorVenda":{"type":"integer","description":"Código do Setor de venda do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Cliente"},"numero":{"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"type":"string","description":"Bairro do Cliente"},"cep":{"type":"string","description":"Código do CEP do Cliente"},"cidade":{"type":"string","description":"Cidade do Cliente"},"estado":{"type":"string","description":"Estado do Cliente"},"codIbge":{"type":"string","description":"Código do IBGE do Cliente"},"email":{"type":"string","description":"E-mail do Cliente"},"emailNfe":{"type":"string","description":"E-mail do Cliente para envio da Nota Fiscal Eletrônica"},"telefone":{"type":"string","description":"Telefone do Cliente"},"telefoneCobranca":{"type":"string","description":"Telefone de Cobrança do Cliente"},"fax":{"type":"string","description":"Fax do Cliente"},"telexCelular":{"type":"string","description":"Telefone Celular do Cliente"},"observacao":{"type":"string","description":"Observação do Cadastro do Cliente"},"aliqIcms":{"type":"string","description":"Aliquota de ICMS da UF do Cliente [Deprecado]"},"percAliqICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS da UF do Cliente"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito do Cliente"},"valorMaiorAcumulo":{"type":"number","description":"Valor Maior Acumulado do Cliente"},"dataMaiorFatura":{"type":"string","description":"Data da Maior Fatura do Cliente","format":"date"},"dataPrimeiraCompra":{"type":"string","description":"Data da Primeira Compra do Cliente","format":"date"},"dataCadastro":{"type":"string","description":"Data do Cadastro do Cliente","format":"date"},"valorTotalFaturado":{"multipleOf":0.01,"type":"number","description":"Valor Total já Faturado do Cliente"},"prazoMedioVendas":{"type":"string","description":"Prazo médio de Vendas do Cliente"},"clienteCentralizador":{"type":"integer","description":"Código do Cliente Centralizador"},"cnpjClienteCentralizador":{"type":"string","description":"Código do CNPJ do Cliente Centralizador"},"codSubRamoAtiv":{"type":"integer","description":"Sub Ramo de Atividade"},"codBacen":{"type":"integer","description":"Código do Bacen"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"dadosCobranca":{"type":"array","description":"Dados de Cobrança do Cliente","items":{"$ref":"#/components/schemas/ClienteDadosCobranca"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"informacoesComplementares":{"type":"array","description":"Informações Complementares do Cliente","items":{"$ref":"#/components/schemas/ClienteInfComplementares"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"grupoComercial":{"type":"array","description":"Grupo Comercial do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoComercial"}},"grupoCNPJ":{"type":"array","description":"Grupo CNPJ do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoCNPJ"}},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}},"ClienteDadosCobranca":{"type":"object","properties":{"codPortador":{"maxLength":4,"type":"string","description":"Código do Portador"},"codTipoCobranca":{"maxLength":3,"type":"string","description":"Código do Tipo de Cobrança"},"codCondicaoPagamento":{"maxLength":3,"type":"string","description":"Código da Condição de Pagamento"}}},"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}},"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}},"ClienteInfComplementares":{"type":"object","properties":{"codAtendente":{"maxLength":4,"type":"string","description":"Código do Atendente"},"nomeAtendente":{"maxLength":60,"type":"string","description":"Nome do Atendente"}}},"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}},"ListaGrupoComercial":{"type":"object","properties":{"clienteAgrupador":{"maximum":9999999,"type":"integer"},"clientesAgrupados":{"type":"array","items":{"$ref":"#/components/schemas/ListaClientesAgrupados"}}}},"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}},"ListaGrupoCNPJ":{"type":"object","properties":{"clienteAgrupado":{"type":"integer","description":"Código do Cliente Agrupado"},"cnpjAgrupado":{"type":"string","description":"CNPJ do Cliente Agrupado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Fornecedor object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"Fornecedor":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Fornecedor"},"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Fornecedor"},"nome":{"type":"string","description":"Nome do Fornecedor"},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Fornecedor"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Fornecedor"},"inscMunicipal":{"type":"string","description":"Código da Inscrição Municipal do Fornecedor"},"situacao":{"type":"integer","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Fornecedor"},"numero":{"type":"string","description":"Número do Endereço do Fornecedor"},"complemento":{"type":"string","description":"Complemento do Endereço do Fornecedor"},"bairro":{"type":"string","description":"Bairro do Fornecedor"},"cep":{"type":"string","description":"Código do CEP do Fornecedor"},"caixaPostal":{"type":"string","description":"Caixa Postal do Fornecedor"},"cidade":{"type":"string","description":"Cidade do Fornecedor"},"estado":{"type":"string","description":"Estado do Fornecedor"},"codPaisBacen":{"type":"string","description":"Código do Pais/Bacen do Fornecedor"},"codIbge":{"type":"string","description":"Código do IBGE do Fornecedor"},"codPais":{"type":"string","description":"Código do País do Fornecedor"},"telefone":{"type":"string","description":"Priemiro Telefone do Fornecedor"},"telefone1":{"type":"string","description":"Segundo Telefone do Fornecedor"},"contato":{"type":"string","description":"Contato do Fornecedor"},"classificacao":{"type":"integer","description":"Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)","enum":[1,2,3,4,5]},"codCategoria":{"type":"integer","description":"Código da Categoria do Fornecedor"},"codGrupo":{"type":"integer","description":"Código do Grupo do Fornecedor"},"item":{"type":"integer","description":"Item do Fornecedor"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior do Fornecedor"},"codNIF":{"type":"string","description":"Código NIF do Fornecedor"},"idPessoaEstrangeira":{"type":"string","description":"Id de PEssoa Estrangeira"},"contaContabil":{"type":"string","description":"Conta Contábil do Fornecedor"},"codigoEntidade":{"type":"integer","description":"Código da Entidade do Fornecedor"},"codTransportador":{"type":"integer","description":"Código do Transportador do Fornecedor"},"email":{"type":"string","description":"E-mail do Fornecedor"},"emailNfe":{"type":"string","description":"E-mail para Nota Fiscal Eletrônica do Fornecedor"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Continuação da Observação"},"observacao3":{"type":"string","description":"Continuação da Observação"},"observacao4":{"type":"string","description":"Continuação da Observação"},"codContaContJuros":{"type":"integer","description":"Conta Contábil de Juros do Fornecedor"},"codContaContMulta":{"type":"integer","description":"Conta Contábil de Multa do Fornecedor"},"codContaContDesconto":{"type":"integer","description":"Conta Contábil de Descontos do Fornecedor"},"obrigaFluxoCaixa":{"type":"integer","description":"Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The FornecedorPut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"FornecedorPut":{"required":["bairro","cep","classificacao","codCategoria","codGrupo","endereco","nome","numero","situacao"],"type":"object","properties":{"codFornecedor":{"maximum":99999,"type":"integer","description":"Código do Fornecedor"},"cpfCnpj":{"maxLength":14,"minLength":1,"type":"string","description":"Código do CPF ou CNPJ do Fornecedor (sem formatação)"},"nome":{"maxLength":60,"minLength":1,"type":"string","description":"Nome do Fornecedor"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia do Fornecedor"},"inscEstadual":{"maxLength":17,"minLength":1,"type":"string","description":"Código da Inscrição Estadual do Fornecedor (sem formatação)"},"inscMunicipal":{"maxLength":15,"type":"string","description":"Código da Inscrição Municipal do Fornecedor (sem formatação)"},"situacao":{"type":"integer","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","enum":[0,1]},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço do Fornecedor"},"numero":{"maxLength":5,"minLength":1,"type":"string","description":"Número do Endereço do Fornecedor"},"complemento":{"maxLength":30,"type":"string","description":"Complemento do Endereço do Fornecedor"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro do Fornecedor"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP do Fornecedor (sem formatação)"},"caixaPostal":{"maxLength":10,"type":"string","description":"Caixa Postal do Fornecedor"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Fornecedor"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Fornecedor"},"codPaisBacen":{"maxLength":4,"type":"string","description":"Código do Pais/Bacen do Fornecedor"},"codIbge":{"maxLength":7,"type":"string","description":"Código do IBGE do Fornecedor"},"codPais":{"maxLength":3,"type":"string","description":"Código do País do Fornecedor"},"telefone":{"maxLength":15,"type":"string","description":"Priemiro Telefone do Fornecedor"},"telefone1":{"maxLength":15,"type":"string","description":"Segundo Telefone do Fornecedor"},"contato":{"maxLength":30,"type":"string","description":"Contato do Fornecedor"},"classificacao":{"type":"integer","description":"Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)","enum":[1,2,3,4,5]},"codCategoria":{"maximum":99,"minimum":1,"type":"integer","description":"Código da Categoria do Fornecedor"},"codGrupo":{"maximum":999,"minimum":1,"type":"integer","description":"Código do Grupo do Fornecedor"},"item":{"maximum":999,"minimum":1,"type":"integer","description":"Item do Fornecedor"},"paisCidadeExterior":{"maxLength":30,"type":"string","description":"País e Cidade do Exterior do Fornecedor"},"codNIF":{"maxLength":35,"type":"string","description":"Código NIF do Fornecedor"},"idPessoaEstrangeira":{"maxLength":20,"type":"string","description":"Id de Pessoa Estrangeira"},"contaContabil":{"maxLength":5,"type":"string","description":"Conta Contábil do Fornecedor"},"codigoEntidade":{"maximum":99999,"type":"integer","description":"Código da Entidade do Fornecedor"},"codTransportador":{"maximum":9999,"type":"integer","description":"Código do Transportador do Fornecedor"},"email":{"maxLength":50,"type":"string","description":"E-mail do Fornecedor"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail para Nota Fiscal Eletrônica do Fornecedor"},"observacao1":{"maxLength":35,"type":"string","description":"Observação"},"observacao2":{"maxLength":35,"type":"string","description":"Continuação da Observação"},"observacao3":{"maxLength":35,"type":"string","description":"Continuação da Observação"},"observacao4":{"maxLength":35,"type":"string","description":"Continuação da Observação"},"codContaContJuros":{"maxLength":5,"type":"string","description":"Conta Contábil de Juros do Fornecedor"},"codContaContMulta":{"maxLength":5,"type":"string","description":"Conta Contábil de Multa do Fornecedor"},"codContaContDesconto":{"maxLength":5,"type":"string","description":"Conta Contábil de Desconto do Fornecedor"},"obrigaFluxoCaixa":{"type":"integer","description":"Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaFornecedores object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaFornecedores":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Fornecedor"}}}},"Fornecedor":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Fornecedor"},"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Fornecedor"},"nome":{"type":"string","description":"Nome do Fornecedor"},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Fornecedor"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Fornecedor"},"inscMunicipal":{"type":"string","description":"Código da Inscrição Municipal do Fornecedor"},"situacao":{"type":"integer","description":"Situação do Fornecedor (0-Inativo, 1-Ativo)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Fornecedor"},"numero":{"type":"string","description":"Número do Endereço do Fornecedor"},"complemento":{"type":"string","description":"Complemento do Endereço do Fornecedor"},"bairro":{"type":"string","description":"Bairro do Fornecedor"},"cep":{"type":"string","description":"Código do CEP do Fornecedor"},"caixaPostal":{"type":"string","description":"Caixa Postal do Fornecedor"},"cidade":{"type":"string","description":"Cidade do Fornecedor"},"estado":{"type":"string","description":"Estado do Fornecedor"},"codPaisBacen":{"type":"string","description":"Código do Pais/Bacen do Fornecedor"},"codIbge":{"type":"string","description":"Código do IBGE do Fornecedor"},"codPais":{"type":"string","description":"Código do País do Fornecedor"},"telefone":{"type":"string","description":"Priemiro Telefone do Fornecedor"},"telefone1":{"type":"string","description":"Segundo Telefone do Fornecedor"},"contato":{"type":"string","description":"Contato do Fornecedor"},"classificacao":{"type":"integer","description":"Classificação do Fornecedor (1-Física, 2-Jurídica, 3-Outros, 4-Produtor,5-Exterior)","enum":[1,2,3,4,5]},"codCategoria":{"type":"integer","description":"Código da Categoria do Fornecedor"},"codGrupo":{"type":"integer","description":"Código do Grupo do Fornecedor"},"item":{"type":"integer","description":"Item do Fornecedor"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior do Fornecedor"},"codNIF":{"type":"string","description":"Código NIF do Fornecedor"},"idPessoaEstrangeira":{"type":"string","description":"Id de PEssoa Estrangeira"},"contaContabil":{"type":"string","description":"Conta Contábil do Fornecedor"},"codigoEntidade":{"type":"integer","description":"Código da Entidade do Fornecedor"},"codTransportador":{"type":"integer","description":"Código do Transportador do Fornecedor"},"email":{"type":"string","description":"E-mail do Fornecedor"},"emailNfe":{"type":"string","description":"E-mail para Nota Fiscal Eletrônica do Fornecedor"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Continuação da Observação"},"observacao3":{"type":"string","description":"Continuação da Observação"},"observacao4":{"type":"string","description":"Continuação da Observação"},"codContaContJuros":{"type":"integer","description":"Conta Contábil de Juros do Fornecedor"},"codContaContMulta":{"type":"integer","description":"Conta Contábil de Multa do Fornecedor"},"codContaContDesconto":{"type":"integer","description":"Conta Contábil de Descontos do Fornecedor"},"obrigaFluxoCaixa":{"type":"integer","description":"Obriga o Fluxo de Caixa para o Fornecedor? (0-Não, 1-Sim)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Transportadora object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"Transportadora":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa da Transportadora"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"nome":{"maxLength":60,"type":"string","description":"Nome da Transportadora"},"endereco":{"maxLength":60,"type":"string","description":"Endereço da Transportadora"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP da Transportadora"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Transportadora"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia da Transportadora"},"inscEstadual":{"maxLength":15,"type":"string","description":"Inscrição Estadual da Transportadora"},"situacao":{"type":"integer","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"type":"string","description":"Telefone da Transportadora"},"teleFax":{"maxLength":15,"type":"string","description":"Telefone/Fax da Transportadora"},"bairro":{"maxLength":30,"type":"string","description":"Bairro da Transportadora"},"contato":{"maxLength":30,"type":"string","description":"Contato da Transportadora"},"email":{"maxLength":60,"type":"string","description":"E-mail da Transportadora"},"obsNotaFiscal":{"type":"integer","description":"Código da Observação para a Nota Fiscal"},"tipo":{"type":"integer","description":"Tipo da Transportadora (1-Transportadora, 2-Consignatário)","enum":[1,2]},"dataValidadeSeguro":{"type":"string","description":"Data de Validade do Seguro da Transportadora"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior da Transportadora"},"paisBacen":{"maximum":999999,"type":"integer","description":"Código do Pais/Bacen da Transportadora"},"codRUC":{"maximum":99999999999,"type":"integer","description":"Código RUC da Transportadora"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail da Nota Fiscal Eletrônica da Transportadora"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço da Transportadora"},"rntrc":{"maxLength":14,"type":"string","description":"Registro Nacional de Transportador da Transportadora"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TransportadoraPut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TransportadoraPut":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa da Transportadora"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"nome":{"maxLength":60,"type":"string","description":"Nome da Transportadora"},"endereco":{"maxLength":60,"type":"string","description":"Endereço da Transportadora"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP da Transportadora (sem formatação)"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Transportadora (sem formatação)"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia da Transportadora"},"inscEstadual":{"maxLength":15,"type":"string","description":"Inscrição Estadual da Transportadora (sem formatação)"},"situacao":{"type":"integer","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"type":"string","description":"Telefone da Transportadora"},"teleFax":{"maxLength":15,"type":"string","description":"Telefone/Fax da Transportadora"},"bairro":{"maxLength":30,"type":"string","description":"Bairro da Transportadora"},"contato":{"maxLength":30,"type":"string","description":"Contato da Transportadora"},"email":{"maxLength":60,"type":"string","description":"E-mail da Transportadora"},"obsNotaFiscal":{"type":"integer","description":"Código da Observação para a Nota Fiscal"},"tipo":{"type":"integer","description":"Tipo da Transportadora (1-Transportadora, 2-Consignatário)","enum":[1,2]},"dataValidadeSeguro":{"type":"string","description":"Data de Validade do Seguro da Transportadora (YYYY-MM-DD)","format":"date"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior da Transportadora"},"paisBacen":{"maximum":999999,"type":"integer","description":"Código do Pais/Bacen da Transportadora"},"codRUC":{"maximum":99999999999,"type":"integer","description":"Código RUC da Transportadora"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail da Nota Fiscal Eletrônica da Transportadora"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço da Transportadora"},"rntrc":{"maxLength":14,"type":"string","description":"Registro Nacional de Transportador da Transportadora"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaTransportadoras object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaTransportadoras":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Transportadora"}}}},"Transportadora":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa da Transportadora"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"nome":{"maxLength":60,"type":"string","description":"Nome da Transportadora"},"endereco":{"maxLength":60,"type":"string","description":"Endereço da Transportadora"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP da Transportadora"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Transportadora"},"nomeFantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia da Transportadora"},"inscEstadual":{"maxLength":15,"type":"string","description":"Inscrição Estadual da Transportadora"},"situacao":{"type":"integer","description":"Situação da Transportadora (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"type":"string","description":"Telefone da Transportadora"},"teleFax":{"maxLength":15,"type":"string","description":"Telefone/Fax da Transportadora"},"bairro":{"maxLength":30,"type":"string","description":"Bairro da Transportadora"},"contato":{"maxLength":30,"type":"string","description":"Contato da Transportadora"},"email":{"maxLength":60,"type":"string","description":"E-mail da Transportadora"},"obsNotaFiscal":{"type":"integer","description":"Código da Observação para a Nota Fiscal"},"tipo":{"type":"integer","description":"Tipo da Transportadora (1-Transportadora, 2-Consignatário)","enum":[1,2]},"dataValidadeSeguro":{"type":"string","description":"Data de Validade do Seguro da Transportadora"},"paisCidadeExterior":{"type":"string","description":"País e Cidade do Exterior da Transportadora"},"paisBacen":{"maximum":999999,"type":"integer","description":"Código do Pais/Bacen da Transportadora"},"codRUC":{"maximum":99999999999,"type":"integer","description":"Código RUC da Transportadora"},"emailNfe":{"maxLength":60,"type":"string","description":"E-mail da Nota Fiscal Eletrônica da Transportadora"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço da Transportadora"},"rntrc":{"maxLength":14,"type":"string","description":"Registro Nacional de Transportador da Transportadora"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Portador object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}}}}} ``` ## The PortadorPut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"PortadorPut":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Portador"}}}},"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}}}}} ``` ## The ListaPortadores object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaPortadores":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Portador"}}}},"Portador":{"required":["aceitaProrrogacao","cep","codPortador","fantasia","nome"],"type":"object","properties":{"codPortador":{"type":"integer","description":"Código do Portador"},"nome":{"type":"string","description":"Nome do Portador"},"endereco":{"type":"string","description":"Endereço do Portador"},"cep":{"maxLength":8,"type":"string","description":"Código do CEP do Portador"},"agencia":{"type":"string","description":"Agência do Portador"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente do Portador"},"fantasia":{"type":"string","description":"Nome Fantasia do Portador"},"aceitaProrrogacao":{"type":"integer","description":"Aceita Prorrogação? (0-Não,1-Sim)"},"codigoBACEN":{"maximum":999,"type":"integer","description":"Código BACEN do Portador"},"cnpj":{"type":"string","description":"Código do CNPJ do Portador (sem formatação)"}}}}}} ``` ## The CondicaoVenda object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"CondicaoVenda":{"type":"object","properties":{"codCondicaoVenda":{"maximum":999,"minimum":1,"type":"integer","description":"Código da Condição de Venda"},"percDesc6":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"percComissao3":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Representante"},"percReposicao":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição"},"percReposicaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição do Representante"},"prazoVencimento1":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 1"},"prazoVencimento2":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 2"},"prazoVencimento3":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 3"},"prazoVencimento4":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 4"},"prazoVencimento5":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 5"},"prazoVencimento6":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 6"},"descricao":{"type":"string","description":"Descrição da Condição de Venda"},"descricaoNaNF":{"type":"integer","description":"Descrição da Condição de Venda na Nota Fiscal (1 - Sim, 0 - Não)","enum":[1,0]},"percAcrescimo":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo da Condição de Venda"},"listaNaTabela":{"type":"integer","description":"Lista na Tabela? (1 - Sim, 0 - Não)","enum":[1,0]},"situacao":{"type":"integer","description":"Situação da Condição de Venda (0-Inativo, 1-Ativo)","enum":[0,1]},"observacao1":{"maxLength":50,"type":"string","description":"Observação da Condição de Venda"},"observacao2":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao3":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao4":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"prazoVencimento7":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 7"},"prazoVencimento8":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 8"},"prazoVencimento9":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 9"},"prazoVencimento10":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 10"},"prazoVencimento11":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 11"},"prazoVencimento12":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 12"},"prazoVencimento13":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 13"},"prazoVencimento14":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 14"},"prazoVencimento15":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 15"},"prazoVencimento16":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 16"},"prazoVencimento17":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 17"},"prazoVencimento18":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 18"},"formaPagamento":{"type":"string","description":"Código da Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 14 - Duplicata Mercantil, 15 - Boleto Bancário, 90 - Sem pagamento)","enum":["01","02","03","04","05","10","11","12","13","14","15","90"]},"tipoIntegracao":{"type":"integer","description":"Código do Tipo da Integração (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Comércio Eletrônico)","enum":[1,2]},"CNPJCreden":{"type":"string","description":"Código do CNPJ da Credenciadora"},"bandOperadora":{"type":"string","description":"Código da Bandeira da Operadora (01 - Visa, 02 - Mastercard, 03 - American Expres, 04 - Sorocred, 05 - Diners Club, 06 - Elo, 07 - Hipercard, 08 - Aura, 09 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"numAutCartao":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Autorização do Cartão"}}}}}} ``` ## The CondicaoVendaPut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"CondicaoVendaPut":{"type":"object","properties":{"percDesc6":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"percComissao3":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Representante"},"percReposicao":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição"},"percReposicaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição do Representante"},"prazoVencimento1":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 1"},"prazoVencimento2":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 2"},"prazoVencimento3":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 3"},"prazoVencimento4":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 4"},"prazoVencimento5":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 5"},"prazoVencimento6":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 6"},"descricao":{"type":"string","description":"Descrição da Condição de Venda"},"descricaoNaNF":{"type":"integer","description":"Descrição da Condição de Venda na Nota Fiscal (1 - Sim, 0 - Não)","enum":[1,0]},"percAcrescimo":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo da Condição de Venda"},"listaNaTabela":{"type":"integer","description":"Lista na Tabela? (1 - Sim, 0 - Não)","enum":[1,0]},"situacao":{"type":"integer","description":"Situação da Condição de Venda (0-Inativo, 1-Ativo)","enum":[0,1]},"observacao1":{"maxLength":50,"type":"string","description":"Observação da Condição de Venda"},"observacao2":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao3":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao4":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"prazoVencimento7":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 7"},"prazoVencimento8":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 8"},"prazoVencimento9":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 9"},"prazoVencimento10":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 10"},"prazoVencimento11":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 11"},"prazoVencimento12":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 12"},"prazoVencimento13":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 13"},"prazoVencimento14":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 14"},"prazoVencimento15":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 15"},"prazoVencimento16":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 16"},"prazoVencimento17":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 17"},"prazoVencimento18":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 18"},"formaPagamento":{"type":"string","description":"Código da Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 14 - Duplicata Mercantil, 15 - Boleto Bancário, 90 - Sem pagamento)","enum":["01","02","03","04","05","10","11","12","13","14","15","90"]},"tipoIntegracao":{"type":"integer","description":"Código do Tipo da Integração (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Comércio Eletrônico)","enum":[1,2]},"CNPJCreden":{"type":"string","description":"Código do CNPJ da Credenciadora"},"bandOperadora":{"type":"string","description":"Código da Bandeira da Operadora (01 - Visa, 02 - Mastercard, 03 - American Expres, 04 - Sorocred, 05 - Diners Club, 06 - Elo, 07 - Hipercard, 08 - Aura, 09 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"numAutCartao":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Autorização do Cartão"}}}}}} ``` ## The ListaCondicoesVendas object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaCondicoesVendas":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CondicaoVenda"}}}},"CondicaoVenda":{"type":"object","properties":{"codCondicaoVenda":{"maximum":999,"minimum":1,"type":"integer","description":"Código da Condição de Venda"},"percDesc6":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"percComissao3":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Representante"},"percReposicao":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição"},"percReposicaoRepres":{"multipleOf":0.01,"type":"number","description":"Percentual de Reposição do Representante"},"prazoVencimento1":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 1"},"prazoVencimento2":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 2"},"prazoVencimento3":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 3"},"prazoVencimento4":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 4"},"prazoVencimento5":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 5"},"prazoVencimento6":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 6"},"descricao":{"type":"string","description":"Descrição da Condição de Venda"},"descricaoNaNF":{"type":"integer","description":"Descrição da Condição de Venda na Nota Fiscal (1 - Sim, 0 - Não)","enum":[1,0]},"percAcrescimo":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo da Condição de Venda"},"listaNaTabela":{"type":"integer","description":"Lista na Tabela? (1 - Sim, 0 - Não)","enum":[1,0]},"situacao":{"type":"integer","description":"Situação da Condição de Venda (0-Inativo, 1-Ativo)","enum":[0,1]},"observacao1":{"maxLength":50,"type":"string","description":"Observação da Condição de Venda"},"observacao2":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao3":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"observacao4":{"maxLength":50,"type":"string","description":"Complemento da Observação da Condição de Venda"},"prazoVencimento7":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 7"},"prazoVencimento8":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 8"},"prazoVencimento9":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 9"},"prazoVencimento10":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 10"},"prazoVencimento11":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 11"},"prazoVencimento12":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 12"},"prazoVencimento13":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 13"},"prazoVencimento14":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 14"},"prazoVencimento15":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 15"},"prazoVencimento16":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 16"},"prazoVencimento17":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 17"},"prazoVencimento18":{"maximum":999,"minimum":1,"type":"integer","description":"Prazo de Vencimento 18"},"formaPagamento":{"type":"string","description":"Código da Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 14 - Duplicata Mercantil, 15 - Boleto Bancário, 90 - Sem pagamento)","enum":["01","02","03","04","05","10","11","12","13","14","15","90"]},"tipoIntegracao":{"type":"integer","description":"Código do Tipo da Integração (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Comércio Eletrônico)","enum":[1,2]},"CNPJCreden":{"type":"string","description":"Código do CNPJ da Credenciadora"},"bandOperadora":{"type":"string","description":"Código da Bandeira da Operadora (01 - Visa, 02 - Mastercard, 03 - American Expres, 04 - Sorocred, 05 - Diners Club, 06 - Elo, 07 - Hipercard, 08 - Aura, 09 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"numAutCartao":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Autorização do Cartão"}}}}}} ``` ## The Cor object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"Cor":{"type":"object","properties":{"codCor":{"type":"string","description":"Código da Cor"},"descricao":{"type":"string","description":"Descrição da Cor"},"codigoGrupo":{"type":"integer","description":"Código do Grupo de Cor"},"abreviatura":{"type":"string","description":"Abreviatura da Descrição da Cor"},"tipoCor":{"type":"integer","description":"Tipo da Cor (1 - Cor, 2 - Variante)","enum":[1,2]},"utilizacaoCor":{"type":"integer","description":"Tipo de Utilização a Cor (1 - Produto, 2 - Material, 3 - Produto ou Matrial)","enum":[1,2,3]},"status":{"type":"boolean","description":"Status da Cor (1 - Ativa, 0 - Inativa)"},"rgb":{"type":"string","description":"Código do RGB da Cor"},"grauDificuldade":{"type":"integer","description":"Código do Grau de Dificuldade da Cor"},"codTomCor":{"type":"integer","description":"Código do Tom da Cor"},"sequenciaCor":{"type":"integer","description":"Sequência da Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaCores object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaCores":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Cor"}}}},"Cor":{"type":"object","properties":{"codCor":{"type":"string","description":"Código da Cor"},"descricao":{"type":"string","description":"Descrição da Cor"},"codigoGrupo":{"type":"integer","description":"Código do Grupo de Cor"},"abreviatura":{"type":"string","description":"Abreviatura da Descrição da Cor"},"tipoCor":{"type":"integer","description":"Tipo da Cor (1 - Cor, 2 - Variante)","enum":[1,2]},"utilizacaoCor":{"type":"integer","description":"Tipo de Utilização a Cor (1 - Produto, 2 - Material, 3 - Produto ou Matrial)","enum":[1,2,3]},"status":{"type":"boolean","description":"Status da Cor (1 - Ativa, 0 - Inativa)"},"rgb":{"type":"string","description":"Código do RGB da Cor"},"grauDificuldade":{"type":"integer","description":"Código do Grau de Dificuldade da Cor"},"codTomCor":{"type":"integer","description":"Código do Tom da Cor"},"sequenciaCor":{"type":"integer","description":"Sequência da Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The GrupoCor object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"GrupoCor":{"type":"object","properties":{"codGrupoCor":{"type":"string","description":"Código do Grupo de Cor"},"descricao":{"type":"string","description":"Descrição do Grupo de Cor"},"tipoCor":{"type":"integer","description":"Tipo do Grupo de Cor (0 - Tinturaria, 1 - Estamparia Cilíndrica, 2 - Estamparia Digital, 3 - Semiacabados, 4 - Acabados Outros)","enum":[0,1,2,3,4]},"sequencia":{"type":"integer","description":"Sequência do Grupo de Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaGrupoCores object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaGrupoCores":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GrupoCor"}}}},"GrupoCor":{"type":"object","properties":{"codGrupoCor":{"type":"string","description":"Código do Grupo de Cor"},"descricao":{"type":"string","description":"Descrição do Grupo de Cor"},"tipoCor":{"type":"integer","description":"Tipo do Grupo de Cor (0 - Tinturaria, 1 - Estamparia Cilíndrica, 2 - Estamparia Digital, 3 - Semiacabados, 4 - Acabados Outros)","enum":[0,1,2,3,4]},"sequencia":{"type":"integer","description":"Sequência do Grupo de Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ModelagemComercial object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ModelagemComercial":{"type":"object","properties":{"codModelagem":{"type":"string","description":"Código da Modelagem"},"descricao":{"type":"string","description":"Descrição da Modelagem"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The CatalogoCorTec object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"CatalogoCorTec":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Catálogo de Cor"},"descricao":{"type":"string","description":"Descrição do Catálogo de Cor"},"dataLancamento":{"type":"string","description":"Data do Lançamento do Catálogo de Cor (YYYY-MM-DD)","format":"date"},"situacao":{"type":"boolean","description":"Situação do Catálogo de Cor"},"tabPrecoPicotada":{"type":"string","description":"Tabela de Preço Picotada do Catálogo de Cor"},"tabPrecoPromocional":{"type":"string","description":"Tabela de Preço Promocional do Catálogo de Cor"},"tabPrecoFechada":{"type":"string","description":"Tabela de Preço Fechada do Catálogo de Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaCatalogoCorTec object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaCatalogoCorTec":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogoCorTec"}}}},"CatalogoCorTec":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Catálogo de Cor"},"descricao":{"type":"string","description":"Descrição do Catálogo de Cor"},"dataLancamento":{"type":"string","description":"Data do Lançamento do Catálogo de Cor (YYYY-MM-DD)","format":"date"},"situacao":{"type":"boolean","description":"Situação do Catálogo de Cor"},"tabPrecoPicotada":{"type":"string","description":"Tabela de Preço Picotada do Catálogo de Cor"},"tabPrecoPromocional":{"type":"string","description":"Tabela de Preço Promocional do Catálogo de Cor"},"tabPrecoFechada":{"type":"string","description":"Tabela de Preço Fechada do Catálogo de Cor"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ProdutoCatalogoCorTec object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ProdutoCatalogoCorTec":{"required":["codigoProduto"],"type":"object","properties":{"codigoProduto":{"type":"string","description":"Código do Produto para o Catálogo de Cor"},"situacao":{"type":"integer","description":"Situação do Produto no Catálogo de Cor (1-Ativo, 2-Inativo, 3-Cancelado)","enum":[1,2,3]},"prontaEntrega":{"type":"boolean","description":"Produto a Pronta Entrega?"},"operadorAprovProntaEntrega":{"type":"string","description":"Operador da Aprovação de Pronta Entrega"},"dataHoraAprovProntaEntrega":{"type":"string","description":"Data da Aprovação de Pronta Entrega (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"itemForaDeLinha":{"type":"boolean","description":"Item Fora de Linha?"},"operadorItemForaLinha":{"type":"string","description":"Operador que Gravou o Item como Fora de Linha"},"dataHoraItemForaLinha":{"type":"string","description":"Data da Aprovação do Item Fora de Linha (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"promocao":{"type":"boolean","description":"Item é de Promoção?"},"operadorPromocao":{"type":"string","description":"Operador que Gravou o Item como Promocional"},"dataHoraPromocao":{"type":"string","description":"Data da Aprovação do Item como Promocional (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"cores":{"type":"array","description":"Cores do Produto no Catálogo de Cor","items":{"$ref":"#/components/schemas/CorProdutoCatalogoTec"}},"acessorios":{"type":"array","description":"Código dos Acessórios do Produto no Catálogo de Cor","items":{"type":"string"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"CorProdutoCatalogoTec":{"required":["codCor"],"type":"object","properties":{"codCor":{"type":"string","description":"Código da Cor do Produto no Catálogo de Cor"},"codProdutoReduzido":{"type":"string","description":"Código Item Reduzido no Catálogo de Cor"},"situacao":{"type":"integer","description":"Situação da Cor no Catálogo de Cor (1-Ativo, 2-Inativo, 3-Cancelado)","enum":[1,2,3]},"foraDeLinha":{"type":"boolean","description":"Item Fora de Linha?"},"operadorItemForaLinha":{"type":"string","description":"Operador que Gravou o Item como Fora de Linha"},"dataHoraItemForaLinha":{"type":"string","description":"Data da Aprovação do Item Fora de Linha (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"promocao":{"type":"boolean","description":"Item é de Promoção?"},"operadorPromocao":{"type":"string","description":"Operador que Gravou o Item como Promocional"},"dataHoraPromocao":{"type":"string","description":"Data da Aprovação do Item como Promocional (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"liberacaoMinimaVenda":{"multipleOf":0.001,"type":"number","description":"Liberação Mínima para Venda"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The CorProdutoCatalogoTec object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"CorProdutoCatalogoTec":{"required":["codCor"],"type":"object","properties":{"codCor":{"type":"string","description":"Código da Cor do Produto no Catálogo de Cor"},"codProdutoReduzido":{"type":"string","description":"Código Item Reduzido no Catálogo de Cor"},"situacao":{"type":"integer","description":"Situação da Cor no Catálogo de Cor (1-Ativo, 2-Inativo, 3-Cancelado)","enum":[1,2,3]},"foraDeLinha":{"type":"boolean","description":"Item Fora de Linha?"},"operadorItemForaLinha":{"type":"string","description":"Operador que Gravou o Item como Fora de Linha"},"dataHoraItemForaLinha":{"type":"string","description":"Data da Aprovação do Item Fora de Linha (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"promocao":{"type":"boolean","description":"Item é de Promoção?"},"operadorPromocao":{"type":"string","description":"Operador que Gravou o Item como Promocional"},"dataHoraPromocao":{"type":"string","description":"Data da Aprovação do Item como Promocional (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"liberacaoMinimaVenda":{"multipleOf":0.001,"type":"number","description":"Liberação Mínima para Venda"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaProdCatalogoCorTec object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaProdCatalogoCorTec":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProdutoCatalogoCorTec"}}}},"ProdutoCatalogoCorTec":{"required":["codigoProduto"],"type":"object","properties":{"codigoProduto":{"type":"string","description":"Código do Produto para o Catálogo de Cor"},"situacao":{"type":"integer","description":"Situação do Produto no Catálogo de Cor (1-Ativo, 2-Inativo, 3-Cancelado)","enum":[1,2,3]},"prontaEntrega":{"type":"boolean","description":"Produto a Pronta Entrega?"},"operadorAprovProntaEntrega":{"type":"string","description":"Operador da Aprovação de Pronta Entrega"},"dataHoraAprovProntaEntrega":{"type":"string","description":"Data da Aprovação de Pronta Entrega (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"itemForaDeLinha":{"type":"boolean","description":"Item Fora de Linha?"},"operadorItemForaLinha":{"type":"string","description":"Operador que Gravou o Item como Fora de Linha"},"dataHoraItemForaLinha":{"type":"string","description":"Data da Aprovação do Item Fora de Linha (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"promocao":{"type":"boolean","description":"Item é de Promoção?"},"operadorPromocao":{"type":"string","description":"Operador que Gravou o Item como Promocional"},"dataHoraPromocao":{"type":"string","description":"Data da Aprovação do Item como Promocional (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"cores":{"type":"array","description":"Cores do Produto no Catálogo de Cor","items":{"$ref":"#/components/schemas/CorProdutoCatalogoTec"}},"acessorios":{"type":"array","description":"Código dos Acessórios do Produto no Catálogo de Cor","items":{"type":"string"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"CorProdutoCatalogoTec":{"required":["codCor"],"type":"object","properties":{"codCor":{"type":"string","description":"Código da Cor do Produto no Catálogo de Cor"},"codProdutoReduzido":{"type":"string","description":"Código Item Reduzido no Catálogo de Cor"},"situacao":{"type":"integer","description":"Situação da Cor no Catálogo de Cor (1-Ativo, 2-Inativo, 3-Cancelado)","enum":[1,2,3]},"foraDeLinha":{"type":"boolean","description":"Item Fora de Linha?"},"operadorItemForaLinha":{"type":"string","description":"Operador que Gravou o Item como Fora de Linha"},"dataHoraItemForaLinha":{"type":"string","description":"Data da Aprovação do Item Fora de Linha (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"promocao":{"type":"boolean","description":"Item é de Promoção?"},"operadorPromocao":{"type":"string","description":"Operador que Gravou o Item como Promocional"},"dataHoraPromocao":{"type":"string","description":"Data da Aprovação do Item como Promocional (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"liberacaoMinimaVenda":{"multipleOf":0.001,"type":"number","description":"Liberação Mínima para Venda"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TipoNota object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TipoNota":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Tipo de Nota Fiscal"},"descricao":{"type":"string","description":"Descrição do Tipo de Nota Fiscal"},"possuiDuplicata":{"type":"boolean","description":"O Tipo de Nota Fiscal Possui Duplicata?"},"situacaoIpi":{"type":"integer","description":"Situação do IPI (0 - Sem IPI Isentas, 1 - Com IPI, 2 - Sem IPI Outras)","enum":[0,1,2]},"situacaoIcms":{"type":"integer","description":"Situação do ICMS (0 - Sem ICMS Isentas, 1 - Com ICMS, 2 - Sem ICMS Outras)","enum":[0,1,2]},"tipoIcms":{"type":"integer","description":"Tipo do ICMS (0 - Depende do Estado, 1 - Sempre 17%, 2 - Multiplas Aliquotas (Depende do Produto))","enum":[0,1,2]},"codCstIcms":{"type":"string","description":"Código do CST/ICMS do Tipo de Nota Fiscal"},"codCstIpi":{"type":"string","description":"Código do CST/IPI do Tipo de Nota Fiscal"},"situacaoComissao":{"type":"boolean","description":"Código do CST/ICMS do Tipo de Nota Fiscal"},"codMensagemNF":{"type":"integer","description":"Código da Mensagem para a Nota Fiscal"},"mercadoriaComercInd":{"type":"boolean","description":"Mercadoria para coml. Industrialização"},"codSerieFiscal":{"type":"integer","description":"Código da Série Fiscal do Tipo de Nota"},"codNaturezaOperacao":{"type":"integer","description":"Código da Natureza de Operação do Tipo de Nota"},"geraEstatisticaVenda":{"type":"boolean","description":"Gera Estatística de Vendas?"},"geraEstatisticaFaturamento":{"type":"boolean","description":"Gera Estatística de Faturamento?"},"entraLivroFiscal":{"type":"boolean","description":"Entra no Livro Fiscal?"},"percReducaoBaseIcms":{"multipleOf":0.00001,"type":"number","description":"Percentual de Redução da Base de ICMS"},"notaFiscalEspecial":{"type":"boolean","description":"Nota Fiscal será Especial?"},"zonaFrancaManaus":{"type":"boolean","description":"É para Zona Franca de Manaus?"},"codTransacaoEstoque":{"type":"integer","description":"Código da TRansação de Estoque para Movimentação"},"situacaoPisCofins":{"type":"integer","description":"Situação do PIS/COFINS (0 - Não Incide, 1 - PIS, 2 - COFINS, 3 - Ambos)","enum":[0,1,2,3]},"notaFiscalReferenciada":{"type":"boolean","description":"É Nota Fiscal Referenciada?"},"finalidadeNFe":{"type":"integer","description":"Código da Finalidade (0 - NF-e normal (1), 1 - NF-e complementar (2), 2 - NF-e de ajuste (3), 3 -Devolução (4))","enum":[0,1,2,3]},"descricaoNatOperacao":{"type":"string","description":"Descrição da Natureza de Operação do Tipo de Nota"},"codAjusteIcms":{"type":"string","description":"Código do Ajuste do ICMS"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"observEscrituracao":{"type":"string","description":"Observação da Escrituação"},"IcmsZonaFranca":{"type":"boolean","description":"ICMS para Zona Franca"},"codCstPisCofins":{"type":"string","description":"Código do CST/PIS/COFINS"},"codCfopPisCofins":{"type":"array","description":"Código da CFOP PIS/COFINS","items":{"type":"integer"}},"tipoContribuicaoPisCofins":{"type":"string","description":"Tipo de Contribuição de PIS/COFINS"},"codCsosn":{"type":"string","description":"CSOSN Código de Situação da Operação - SIMPLES NACIONAL"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaTiposNota object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaTiposNota":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TipoNota"}}}},"TipoNota":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Tipo de Nota Fiscal"},"descricao":{"type":"string","description":"Descrição do Tipo de Nota Fiscal"},"possuiDuplicata":{"type":"boolean","description":"O Tipo de Nota Fiscal Possui Duplicata?"},"situacaoIpi":{"type":"integer","description":"Situação do IPI (0 - Sem IPI Isentas, 1 - Com IPI, 2 - Sem IPI Outras)","enum":[0,1,2]},"situacaoIcms":{"type":"integer","description":"Situação do ICMS (0 - Sem ICMS Isentas, 1 - Com ICMS, 2 - Sem ICMS Outras)","enum":[0,1,2]},"tipoIcms":{"type":"integer","description":"Tipo do ICMS (0 - Depende do Estado, 1 - Sempre 17%, 2 - Multiplas Aliquotas (Depende do Produto))","enum":[0,1,2]},"codCstIcms":{"type":"string","description":"Código do CST/ICMS do Tipo de Nota Fiscal"},"codCstIpi":{"type":"string","description":"Código do CST/IPI do Tipo de Nota Fiscal"},"situacaoComissao":{"type":"boolean","description":"Código do CST/ICMS do Tipo de Nota Fiscal"},"codMensagemNF":{"type":"integer","description":"Código da Mensagem para a Nota Fiscal"},"mercadoriaComercInd":{"type":"boolean","description":"Mercadoria para coml. Industrialização"},"codSerieFiscal":{"type":"integer","description":"Código da Série Fiscal do Tipo de Nota"},"codNaturezaOperacao":{"type":"integer","description":"Código da Natureza de Operação do Tipo de Nota"},"geraEstatisticaVenda":{"type":"boolean","description":"Gera Estatística de Vendas?"},"geraEstatisticaFaturamento":{"type":"boolean","description":"Gera Estatística de Faturamento?"},"entraLivroFiscal":{"type":"boolean","description":"Entra no Livro Fiscal?"},"percReducaoBaseIcms":{"multipleOf":0.00001,"type":"number","description":"Percentual de Redução da Base de ICMS"},"notaFiscalEspecial":{"type":"boolean","description":"Nota Fiscal será Especial?"},"zonaFrancaManaus":{"type":"boolean","description":"É para Zona Franca de Manaus?"},"codTransacaoEstoque":{"type":"integer","description":"Código da TRansação de Estoque para Movimentação"},"situacaoPisCofins":{"type":"integer","description":"Situação do PIS/COFINS (0 - Não Incide, 1 - PIS, 2 - COFINS, 3 - Ambos)","enum":[0,1,2,3]},"notaFiscalReferenciada":{"type":"boolean","description":"É Nota Fiscal Referenciada?"},"finalidadeNFe":{"type":"integer","description":"Código da Finalidade (0 - NF-e normal (1), 1 - NF-e complementar (2), 2 - NF-e de ajuste (3), 3 -Devolução (4))","enum":[0,1,2,3]},"descricaoNatOperacao":{"type":"string","description":"Descrição da Natureza de Operação do Tipo de Nota"},"codAjusteIcms":{"type":"string","description":"Código do Ajuste do ICMS"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"observEscrituracao":{"type":"string","description":"Observação da Escrituação"},"IcmsZonaFranca":{"type":"boolean","description":"ICMS para Zona Franca"},"codCstPisCofins":{"type":"string","description":"Código do CST/PIS/COFINS"},"codCfopPisCofins":{"type":"array","description":"Código da CFOP PIS/COFINS","items":{"type":"integer"}},"tipoContribuicaoPisCofins":{"type":"string","description":"Tipo de Contribuição de PIS/COFINS"},"codCsosn":{"type":"string","description":"CSOSN Código de Situação da Operação - SIMPLES NACIONAL"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TabelaPrecoMalharia object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TabelaPrecoMalharia":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço da Malharia"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço da Malharia"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço da Malharia (0 - Inativa / 1 - Ativa)"},"tipoTabela":{"type":"integer","description":"Tipo de Tabela de Preço (0 - Grupo/Referência, 1-Referencia/Cor)","enum":[0,1]},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço da Malharia (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaTabPrecoMalharia object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaTabPrecoMalharia":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoMalharia"}}}},"TabelaPrecoMalharia":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço da Malharia"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço da Malharia"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço da Malharia (0 - Inativa / 1 - Ativa)"},"tipoTabela":{"type":"integer","description":"Tipo de Tabela de Preço (0 - Grupo/Referência, 1-Referencia/Cor)","enum":[0,1]},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço da Malharia (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ProdutoTabPrecoMalharia object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ProdutoTabPrecoMalharia":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Preço da Malharia"},"grupoCor":{"type":"string","description":"Código do Grupo de Cor da Tabela de Preço da Malharia"},"codProduto":{"type":"string","description":"Código do Produto na Tabela de Preço da Malharia"},"preco":{"type":"number","description":"Preço do Produto na Tabela de Preço"},"qtdLimiteParaPreco":{"type":"array","description":"Quantidade Limite para Este Preço","items":{"$ref":"#/components/schemas/LimiteQtdProdTabPreco"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"LimiteQtdProdTabPreco":{"type":"object","properties":{"qtdAteLimiteDe":{"multipleOf":0.001,"type":"number","description":"Quantidade Limite para Este Preço"},"preco":{"type":"number","description":"Preço para a Quantidade Limite"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The LimiteQtdProdTabPreco object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"LimiteQtdProdTabPreco":{"type":"object","properties":{"qtdAteLimiteDe":{"multipleOf":0.001,"type":"number","description":"Quantidade Limite para Este Preço"},"preco":{"type":"number","description":"Preço para a Quantidade Limite"}}}}}} ``` ## The ListaProdTabPrecoMalharia object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaProdTabPrecoMalharia":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProdutoTabPrecoMalharia"}}}},"ProdutoTabPrecoMalharia":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Preço da Malharia"},"grupoCor":{"type":"string","description":"Código do Grupo de Cor da Tabela de Preço da Malharia"},"codProduto":{"type":"string","description":"Código do Produto na Tabela de Preço da Malharia"},"preco":{"type":"number","description":"Preço do Produto na Tabela de Preço"},"qtdLimiteParaPreco":{"type":"array","description":"Quantidade Limite para Este Preço","items":{"$ref":"#/components/schemas/LimiteQtdProdTabPreco"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"LimiteQtdProdTabPreco":{"type":"object","properties":{"qtdAteLimiteDe":{"multipleOf":0.001,"type":"number","description":"Quantidade Limite para Este Preço"},"preco":{"type":"number","description":"Preço para a Quantidade Limite"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaTabPreco object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaTabPreco":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPreco"}}}},"TabelaPreco":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço (0-Inativo 1-Ativo)"},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço (YYYY-MM-DD)","format":"date"},"codMensagem1":{"type":"string","description":"Mensagem da Tabela de Preço"},"codMensagem2":{"type":"string","description":"Complemento da Mensagem da Tabela de Preço"},"dataGeracao":{"type":"string","description":"Data da Geração da Tabela de Preço (YYYY-MM-DD)","format":"date"},"moeda":{"type":"integer","description":"Moeda da Tabela de Preço"},"situacaoICMS":{"type":"boolean","description":"Situação do ICMS (0-ICMS NAO 1-ATIVO)"},"situacaoPISCOFINS":{"type":"boolean","description":"Situação do PIS/COFINS (0-Inativo 1-Ativo)"},"produtosTabelaPreco":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutos"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"TabelaPrecoProdutos":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"multipleOf":0.01,"type":"number","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informado/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TabelaPrecoPut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TabelaPrecoPut":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço (0-Inativo 1-Ativo)"},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço (YYYY-MM-DD)","format":"date"},"codMensagem1":{"type":"string","description":"Mensagem da Tabela de Preço"},"codMensagem2":{"type":"string","description":"Complemento da Mensagem da Tabela de Preço"},"dataGeracao":{"type":"string","description":"Data da Geração da Tabela de Preço (YYYY-MM-DD)","format":"date"},"moeda":{"type":"integer","description":"Moeda da Tabela de Preço"},"situacaoICMS":{"type":"boolean","description":"Situação do ICMS (0-ICMS NAO 1-ATIVO)"},"situacaoPISCOFINS":{"type":"boolean","description":"Situação do PIS/COFINS (0-Inativo 1-Ativo)"},"produtosTabelaPreco":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutosPut"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"TabelaPrecoProdutosPut":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"type":"integer","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informad/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TabelaPreco object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TabelaPreco":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Tabela de Preço"},"descricao":{"type":"string","description":"Descrição da Tabela de Preço"},"situacao":{"type":"boolean","description":"Situação da Tabela de Preço (0-Inativo 1-Ativo)"},"dataValidade":{"type":"string","description":"Data de Validade da Tabela de Preço (YYYY-MM-DD)","format":"date"},"codMensagem1":{"type":"string","description":"Mensagem da Tabela de Preço"},"codMensagem2":{"type":"string","description":"Complemento da Mensagem da Tabela de Preço"},"dataGeracao":{"type":"string","description":"Data da Geração da Tabela de Preço (YYYY-MM-DD)","format":"date"},"moeda":{"type":"integer","description":"Moeda da Tabela de Preço"},"situacaoICMS":{"type":"boolean","description":"Situação do ICMS (0-ICMS NAO 1-ATIVO)"},"situacaoPISCOFINS":{"type":"boolean","description":"Situação do PIS/COFINS (0-Inativo 1-Ativo)"},"produtosTabelaPreco":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutos"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"TabelaPrecoProdutos":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"multipleOf":0.01,"type":"number","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informado/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TabelaPrecoProdutos object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TabelaPrecoProdutos":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"multipleOf":0.01,"type":"number","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informado/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TabelaPrecoProdutosArrayPut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TabelaPrecoProdutosArrayPut":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TabelaPrecoProdutosPut"}}}},"TabelaPrecoProdutosPut":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"type":"integer","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informad/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TabelaPrecoProdutosPut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TabelaPrecoProdutosPut":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"codFaixa":{"type":"string","description":"Código da Faixa"},"precoTabela":{"type":"integer","description":"Preço do Produto/Faixa na Tabela de Preço"},"condicaoVenda":{"type":"string","description":"Código da Condição de Venda Tabela de Preço"},"percAcrescimo":{"type":"string","description":"Percentual de Acréscimo da Tabela de Preço"},"observacao1":{"type":"string","description":"Observação"},"observacao2":{"type":"string","description":"Complemento da Observação"},"observacao3":{"type":"string","description":"Complemento da Observação"},"observacao4":{"type":"string","description":"Complemento da Observação"},"GERINF":{"type":"boolean","description":"Situação do Preço (0-Preço gerado/custos,1-Preço informad/vendas)"},"PERCMAX":{"multipleOf":0.01,"type":"number","description":"Percentual Máximo de Descontos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The GrupoCliente object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"GrupoCliente":{"required":["ListaClienteAgrupado","clienteAgrupador"],"type":"object","properties":{"clienteAgrupador":{"type":"integer","description":"Código do Cliente Agrupador"},"ListaClienteAgrupado":{"type":"array","description":"Clientes Agrupados","items":{"type":"integer"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaGrupoCliente object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaGrupoCliente":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GrupoCliente"}}}},"GrupoCliente":{"required":["ListaClienteAgrupado","clienteAgrupador"],"type":"object","properties":{"clienteAgrupador":{"type":"integer","description":"Código do Cliente Agrupador"},"ListaClienteAgrupado":{"type":"array","description":"Clientes Agrupados","items":{"type":"integer"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TipoCobranca object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TipoCobranca":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do Tipo de Cobrança"},"descricao":{"type":"string","description":"Descrição do Tipo de Cobrança"},"contabAux":{"type":"boolean","description":"Possui Contabilização Auxiliar? (0 - Não, 1 - Sim)"},"bloqContBan":{"type":"boolean","description":"Bloqueia Lançamentos no Controle Bancário? (0 - Não, 1 - Sim)"},"tipoCobrancaVendor":{"type":"boolean","description":"Tipo de Cobrança Vendor? (0 - Não, 1 - Sim)"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaTipoCobranca object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaTipoCobranca":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TipoCobranca"}}}},"TipoCobranca":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do Tipo de Cobrança"},"descricao":{"type":"string","description":"Descrição do Tipo de Cobrança"},"contabAux":{"type":"boolean","description":"Possui Contabilização Auxiliar? (0 - Não, 1 - Sim)"},"bloqContBan":{"type":"boolean","description":"Bloqueia Lançamentos no Controle Bancário? (0 - Não, 1 - Sim)"},"tipoCobrancaVendor":{"type":"boolean","description":"Tipo de Cobrança Vendor? (0 - Não, 1 - Sim)"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaRamosAtividades object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaRamosAtividades":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RamoAtividade"}}}},"RamoAtividade":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codRamoAtiv":{"type":"string","description":"Código do Ramo de Atividade"},"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The RamoAtividade object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"RamoAtividade":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codRamoAtiv":{"type":"string","description":"Código do Ramo de Atividade"},"nome":{"type":"string","description":"Descrição do Ramo de Atividade"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The TabelasPrecoCliente object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"TabelasPrecoCliente":{"type":"object","properties":{"codEmpresa":{"type":"string","description":"Código da Empresa"},"codCliente":{"type":"string","description":"Código do Cliente"},"tabelasPrecoCliente":{"type":"array","items":{"$ref":"#/components/schemas/ListaTabelasPrecoCliente"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaTabelasPrecoCliente":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaTabelasPrecoCliente object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaTabelasPrecoCliente":{"type":"object","properties":{"codTabela":{"type":"string","description":"Código da Tabela de Preço"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaOcorrenciasClientes object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaOcorrenciasClientes":{"type":"object","properties":{"codSequencia":{"type":"integer","description":"Código da Sequencia"},"descricao":{"type":"string","description":"Descrição da Ocorrência"},"situacao":{"type":"integer","description":"Situação da Ocorrência (0-Cadastrado, 1-Gerado pelo cadastro de clientes, 2-Gerada pela cobrança escritural, 3-Gerada pelo Agendamento, 4-Gerada pela API)","enum":[0,1,2,3,4]},"codArea":{"type":"integer","description":"Código da Área"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The OcorrenciaCliente object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"OcorrenciaCliente":{"type":"object","properties":{"descricao":{"type":"string","description":"Descrição da Ocorrência"},"situacao":{"type":"integer","description":"Situação da Ocorrência (0-Cadastrado, 1-Gerado pelo cadastro de clientes, 2-Gerada pela cobrança escritural, 3-Gerada pelo Agendamento, 4-Gerada pela API)","enum":[0,1,2,3,4]},"codArea":{"type":"integer","description":"Código da Área"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The OcorrenciaPut object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"OcorrenciaPut":{"required":["codArea","dataLancamento","descricao"],"type":"object","properties":{"dataLancamento":{"type":"string","description":"Data de Lançamento da Ocorrência (DD-MM-YYYY)","format":"date"},"descricao":{"type":"string","description":"Descrição da Ocorrência"},"codArea":{"maximum":9999,"type":"integer","description":"Código da Área"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaOcorrencia object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaOcorrencia":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ListaOcorrenciasClientes"}}}},"ListaOcorrenciasClientes":{"type":"object","properties":{"codSequencia":{"type":"integer","description":"Código da Sequencia"},"descricao":{"type":"string","description":"Descrição da Ocorrência"},"situacao":{"type":"integer","description":"Situação da Ocorrência (0-Cadastrado, 1-Gerado pelo cadastro de clientes, 2-Gerada pela cobrança escritural, 3-Gerada pelo Agendamento, 4-Gerada pela API)","enum":[0,1,2,3,4]},"codArea":{"type":"integer","description":"Código da Área"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaUnidadesMonetarias object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaUnidadesMonetarias":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UnidadeMonetaria"}}}},"UnidadeMonetaria":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Unidade Monetária"},"descricao":{"type":"string","description":"Descrição da Unidade Monetária"},"simbologia":{"type":"string","description":"Simbologia da Unidade Monetária"},"abreviatura":{"type":"string","description":"Abreviatura da Unidade Monetária"},"numeroDecimais":{"type":"integer","description":"Decimais da Unidade Monetária"},"variacao":{"type":"integer","description":"Variação da Unidade Monetária (1-Fixo, 2-Diário, 3-Mensal)","enum":[1,2,3]},"tipoUnidade":{"type":"integer","description":"Tipo da Unidade Monetária (1-Por Cotação, 2-Fixo)","enum":[1,2]}}}}}} ``` ## The UnidadeMonetaria object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"UnidadeMonetaria":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Unidade Monetária"},"descricao":{"type":"string","description":"Descrição da Unidade Monetária"},"simbologia":{"type":"string","description":"Simbologia da Unidade Monetária"},"abreviatura":{"type":"string","description":"Abreviatura da Unidade Monetária"},"numeroDecimais":{"type":"integer","description":"Decimais da Unidade Monetária"},"variacao":{"type":"integer","description":"Variação da Unidade Monetária (1-Fixo, 2-Diário, 3-Mensal)","enum":[1,2,3]},"tipoUnidade":{"type":"integer","description":"Tipo da Unidade Monetária (1-Por Cotação, 2-Fixo)","enum":[1,2]}}}}}} ``` ## The ListaCotacoesUnidadeMonetaria object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"ListaCotacoesUnidadeMonetaria":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Unidade Monetária"},"dataReferencia":{"type":"string","description":"Data de Referência para Cotação (YYYY-MM-DD)","format":"date"},"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaCotacoesUniMonetaria":{"type":"array","description":"Cotações da Unidade Monetária","items":{"$ref":"#/components/schemas/CotacoesUnidadeMonetaria"}}}},"CotacoesUnidadeMonetaria":{"type":"object","properties":{"dataCotacao":{"type":"string","description":"Data da Cotação (YYYY-MM-DD)","format":"date"},"valorUniMonetData":{"multipleOf":0.01,"type":"number","description":"Cotação da Unidade Monetária na Data"},"variacaoUniMonetData":{"multipleOf":0.01,"type":"number","description":"Variação da Cotação da Unidade Monetária na Data"}}}}}} ``` ## The CotacoesUnidadeMonetaria object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"CotacoesUnidadeMonetaria":{"type":"object","properties":{"dataCotacao":{"type":"string","description":"Data da Cotação (YYYY-MM-DD)","format":"date"},"valorUniMonetData":{"multipleOf":0.01,"type":"number","description":"Cotação da Unidade Monetária na Data"},"variacaoUniMonetData":{"multipleOf":0.01,"type":"number","description":"Variação da Cotação da Unidade Monetária na Data"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Comercial v1.0 # Pedido De Venda pedidoVenda ## GET /pedidoVenda > Obtem Listagem de Pedidos de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaPedidosVenda":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PedidoVenda"}}}},"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVenda":{"get":{"summary":"Obtem Listagem de Pedidos de Venda","operationId":"ObterPedidosVenda","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaPedidosVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"continuationToken","in":"query","required":false,"description":"Identificador de Paginação da Consulta","schema":{"type":"string","nullable":true}},{"name":"dataDigitacaoInicio","in":"query","required":false,"description":"Data de Digitação do Pedido Inicial (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataDigitacaoFim","in":"query","required":false,"description":"Data de Digitação do Pedido Final (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataPrevisaoFaturamentoInicio","in":"query","required":false,"description":"Data de Previsao de Faturamento Inicial (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataPrevisaoFaturamentoFim","in":"query","required":false,"description":"Data de Previsao de Faturamento Final (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"clientes","in":"query","required":false,"description":"Lista de Código de Cliente","schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"representantes","in":"query","required":false,"description":"Lista de Código de Representante","schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"tipoNota","in":"query","required":false,"description":"Lista de Código do Tipo de Nota","schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"situacao","in":"query","required":false,"description":"Lista de Situação de Pedidos (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)","schema":{"type":"array","nullable":true,"items":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9]}}},{"name":"campoFiltroDinamico","in":"query","description":"Campo para Filtrar Dinamicamente no SQL","required":false,"schema":{"type":"string","nullable":true}},{"name":"valorFiltroDinamico","in":"query","description":"Valor para Filtrar Dinamicamente no SQL","required":false,"schema":{"type":"string","nullable":true}},{"name":"paginacao","in":"query","required":false,"description":"Quantidade de Pedidos na Paginação de Retorno","schema":{"type":"integer","nullable":true}}]}}}} ``` ## PUT /pedidoVenda > Cadastra um Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"PedidoVendaPut":{"type":"object","required":["codCliente","codTipoNF","dataPrevisaoFaturamento","codTabelaPreco","itensPedido","unidadeMonetaria","codRepresentante"],"properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"percComissRep":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","multipleOf":0.01,"description":"Primeiro Desconto"},"desconto2":{"type":"number","multipleOf":0.01,"description":"Segundo Desconto"},"desconto3":{"type":"number","multipleOf":0.01,"description":"Terceiro Desconto"},"desconto4":{"type":"number","multipleOf":0.01,"description":"Quarto Desconto"},"desconto5":{"type":"number","multipleOf":0.01,"description":"Quinto Desconto"},"desconto6":{"type":"number","multipleOf":0.01,"description":"Sexto Desconto"},"acrescimo1":{"type":"number","multipleOf":0.01,"description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","multipleOf":0.01,"description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","multipleOf":0.01,"description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","multipleOf":0.01,"description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","maxLength":1000,"description":"Observação para a Seleção de Faturamento"},"nomeLocalEntrega":{"type":"string","maxLength":35,"description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","maxLength":60,"description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"bairroLocalEntrega":{"type":"string","maxLength":60,"description":"Bairro do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string","maxLength":15,"description":"Inscrição Estadual do Local de Entrega"},"inscEstLocalEntrega":{"type":"string","maxLength":17,"description":"Inscrição Estadual do Local de Entrega"},"nomeOperador":{"type":"string","maxLength":40,"description":"Nome do Operador do Sistemas"},"codOperador":{"type":"integer","description":"Código do Operador do Sistemas"},"complementoLocalEntrega":{"type":"string","maxLength":60,"description":"Complemento do Local de Entrega"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"description":"Dias de Vencimento Especial (Obrigatório para condição de venda 99)","type":"array","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"codTipoFreteCons":{"type":"integer","description":"Código do Tipo de Frete da Transportadora Consignatária"},"vlrFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"vlrSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","maximum":9,"description":"Código da Prioridade"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","multipleOf":0.01,"description":"Valor Outras Despesas"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","maxLength":20,"description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"tipoPedidoMalConf":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedidoPut"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedido":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoPut":{"type":"object","required":["codProduto","qtdPedida"],"properties":{"codProduto":{"description":"Código do Produto (Item Reduzido)","type":"string"},"qtdPedida":{"type":"number","description":"Quantidade Pedida do Produto"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","multipleOf":0.01,"description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Presentante no Produto"},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto para o Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","multipleOf":0.01,"description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acréscimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","maxLength":6,"description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","maxLength":6,"description":"Código da Finalidade"},"percIpi":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"incideDescontoCapa":{"type":"integer","description":"Incide Desconto da Capa Considerado Sobre este Item (0 - Não, 1 - Sim)"},"descricaoComplem1":{"type":"string","maxLength":35,"description":"Descrição Complementar DESCONTINUADO"},"descricaoComplem2":{"type":"string","maxLength":35,"description":"Descrição Complementar DESCONTINUADO"},"descricaoComplem3":{"type":"string","maxLength":35,"description":"Descrição Complementar DESCONTINUADO"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortimento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGradePut"}},"distTamanhosGrade":{"type":"array","description":"Distribuição de Quantidade por Tamanho","items":{"$ref":"#/components/schemas/ItemPedidoTamPut"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalhariaPut"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGradePut":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade Pedida do Produto"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoTamPut":{"type":"object","required":["codTamanho","qtdPedida"],"properties":{"codTamanho":{"type":"string","description":"Código do Tamanho a Ser Incluido no Pedido"},"qtdPedida":{"type":"number","multipleOf":0.001,"description":"Quantidade Pedida do Tamanho"}}},"ItemDadosMalhariaPut":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)","enum":[0,1]},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)","enum":[0,1]},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)","enum":[0,1]},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}}}},"paths":{"/pedidoVenda":{"put":{"summary":"Cadastra um Pedido de Venda","operationId":"CadastrarPedidoVenda","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da empresa","schema":{"type":"string"}}],"requestBody":{"description":"Dados do Pedido de Venda","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoVendaPut"}}}}}}}} ``` ## GET /pedidosVendaBloqueados > Obtem Listagem de Pedidos de Venda Bloqueados na Etapa ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaPedidosVenda":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PedidoVenda"}}}},"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidosVendaBloqueados":{"get":{"summary":"Obtem Listagem de Pedidos de Venda Bloqueados na Etapa","operationId":"ObterPedidosVendaBloqueados","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaPedidosVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"continuationToken","in":"query","required":false,"description":"Identificador de Paginação da Consulta","schema":{"type":"string","nullable":true}},{"name":"dataPrevisaoFaturamentoInicio","in":"query","required":false,"description":"Data de Previsao de Faturamento Inicial (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataPrevisaoFaturamentoFim","in":"query","required":false,"description":"Data de Previsao de Faturamento Final (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"cliente","in":"query","required":false,"description":"Código do Cliente","schema":{"type":"integer","nullable":true}},{"name":"representante","in":"query","required":false,"description":"Código do Representante","schema":{"type":"integer","nullable":true}},{"name":"tipoNota","in":"query","required":false,"description":"Código do Tipo de Nota","schema":{"type":"integer","nullable":true}}]}}}} ``` ## GET /pedidoVendaCodAutomacao/{id} > Obtem um Pedido de Venda pelo Código de Automação ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PedidoAutomacao":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVendaCodAutomacao/{id}":{"get":{"summary":"Obtem um Pedido de Venda pelo Código de Automação","operationId":"ObterPedidoAutomacao","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoAutomacao"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Automação","required":true,"schema":{"type":"string"}}]}}}} ``` ## GET /pedidoVenda/{id} > Obtem um Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVenda/{id}":{"get":{"summary":"Obtem um Pedido de Venda","operationId":"ObterPedidoVenda","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}}]}}}} ``` ## PUT /pedidoVenda/{id} > Atualiza um Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"PedidoVendaUpdate":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codTipoNF":{"type":"integer","description":"Código do TIpo de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"percComissRep":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","multipleOf":0.01,"description":"Primeiro Desconto"},"desconto2":{"type":"number","multipleOf":0.01,"description":"Segundo Desconto"},"desconto3":{"type":"number","multipleOf":0.01,"description":"Terceiro Desconto"},"desconto4":{"type":"number","multipleOf":0.01,"description":"Quarto Desconto"},"desconto5":{"type":"number","multipleOf":0.01,"description":"Quinto Desconto"},"desconto6":{"type":"number","multipleOf":0.01,"description":"Sexto Desconto"},"acrescimo1":{"type":"number","multipleOf":0.01,"description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","multipleOf":0.01,"description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","multipleOf":0.01,"description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","multipleOf":0.01,"description":"Quarto Acréscimo"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","maxLength":1000,"description":"Observação para a Seleção de Faturamento"},"nomeLocalEntrega":{"type":"string","maxLength":35,"description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","maxLength":60,"description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"bairroLocalEntrega":{"type":"string","maxLength":60,"description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","maxLength":60,"description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string","maxLength":15,"description":"Inscrição Estadual do Local de Entrega"},"inscEstLocalEntrega":{"type":"string","maxLength":17,"description":"Inscrição Estadual do Local de Entrega"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","maxLength":40,"description":"Nome do Operador do Sistemas"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"description":"Dias de Vencimento Especial (Obrigatório para condição de venda 99)","type":"array","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"codTipoFreteCons":{"type":"integer","description":"Código do Tipo de Frete da Transportadora Consignatária"},"vlrFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"vlrSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"pedidoCliente":{"type":"string","description":"Pedido do Cliente"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","maximum":9,"description":"Código da Prioridade"},"vlrOutrasDesp":{"type":"number","multipleOf":0.01,"description":"Valor Outras Despesas"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codEstComercial":{"type":"string","maxLength":20,"description":"Código da Estrutura Comercial do Cliente"},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedido":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}},"paths":{"/pedidoVenda/{id}":{"put":{"summary":"Atualiza um Pedido de Venda","operationId":"AtualizarPedidoVenda","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Pedido de Venda","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoVendaUpdate"}}}}}}}} ``` ## GET /pedidoVenda/{id}/sugestaoFaturamento > Consulta Sugestões de Faturamento de um Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaSugestaoFatPedido":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SugestaoFatPedido"}}}},"SugestaoFatPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"seqSugestao":{"type":"integer","description":"Código da Sequência da Sugestão de Faturamento"},"situacao":{"type":"integer","description":"Situação da Sugestão (0 - Gerada, 1 - Listada, 2 - Liberado para Conferência, 3 - Transferida, 4 - Exportada para Arquivo, 5 - Transferência, 6 - Em Reserva)","enum":[0,1,2,3,4,5,6]},"valorSugestao":{"type":"number","multipleOf":0.01,"description":"Valor da Sugestão de Faturamento"},"dataGeracao":{"type":"string","format":"date","description":"Data da Geração (YYYY-MM-DD)"},"dataHoraListagem":{"type":"string","format":"date-time","description":"Data e Hora da Listagem (YYYY-MM-DDTHH:mm:ss.sssZ)"},"bloqueadoFaturamento":{"type":"boolean","description":"Bloquado Faturamento? (0 - Não / 1 - Sim)"},"liberadoComQtdMenor":{"type":"boolean","description":"Liberado com Quantidade Menor? (0 - Não / 1 - Sim)"},"priorizar":{"type":"boolean","description":"Priorizar? (0 - Não / 1 - Sim)"},"dataSeparacao":{"type":"string","format":"date","description":"Data da Separação (YYYY-MM-DD)"},"horaGeracao":{"type":"string","description":"Hora da Separação"},"produto":{"type":"array","description":"Produtos da Sugestão","items":{"$ref":"#/components/schemas/ProdutoSugestaoFatPedido"}}}},"ProdutoSugestaoFatPedido":{"type":"object","properties":{"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdSugerida":{"type":"number","description":"Quantidade Sugerida para o Produto"},"qtdConferida":{"type":"number","description":"Quantidade Conferida para o Produto"},"caixa":{"type":"array","description":"Caixas da Sugestão","items":{"$ref":"#/components/schemas/CaixaSugestaoFatPedido"}}}},"CaixaSugestaoFatPedido":{"type":"object","properties":{"codCaixa":{"type":"string","description":"Código da Caixa"},"codTag":{"type":"array","description":"Tags da Caixa (Códigos de Barra)","items":{"type":"string"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVenda/{id}/sugestaoFaturamento":{"get":{"summary":"Consulta Sugestões de Faturamento de um Pedido de Venda","operationId":"ConsultarSugestoesFatPedido","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaSugestaoFatPedido"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","required":false,"schema":{"type":"string","nullable":true}}]}}}} ``` ## GET /pedidoVenda/{id}/sugestaoFaturamento/{seqSugestao} > Obtém Sugestão de Faturamento de um Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"SugestaoFatPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"seqSugestao":{"type":"integer","description":"Código da Sequência da Sugestão de Faturamento"},"situacao":{"type":"integer","description":"Situação da Sugestão (0 - Gerada, 1 - Listada, 2 - Liberado para Conferência, 3 - Transferida, 4 - Exportada para Arquivo, 5 - Transferência, 6 - Em Reserva)","enum":[0,1,2,3,4,5,6]},"valorSugestao":{"type":"number","multipleOf":0.01,"description":"Valor da Sugestão de Faturamento"},"dataGeracao":{"type":"string","format":"date","description":"Data da Geração (YYYY-MM-DD)"},"dataHoraListagem":{"type":"string","format":"date-time","description":"Data e Hora da Listagem (YYYY-MM-DDTHH:mm:ss.sssZ)"},"bloqueadoFaturamento":{"type":"boolean","description":"Bloquado Faturamento? (0 - Não / 1 - Sim)"},"liberadoComQtdMenor":{"type":"boolean","description":"Liberado com Quantidade Menor? (0 - Não / 1 - Sim)"},"priorizar":{"type":"boolean","description":"Priorizar? (0 - Não / 1 - Sim)"},"dataSeparacao":{"type":"string","format":"date","description":"Data da Separação (YYYY-MM-DD)"},"horaGeracao":{"type":"string","description":"Hora da Separação"},"produto":{"type":"array","description":"Produtos da Sugestão","items":{"$ref":"#/components/schemas/ProdutoSugestaoFatPedido"}}}},"ProdutoSugestaoFatPedido":{"type":"object","properties":{"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdSugerida":{"type":"number","description":"Quantidade Sugerida para o Produto"},"qtdConferida":{"type":"number","description":"Quantidade Conferida para o Produto"},"caixa":{"type":"array","description":"Caixas da Sugestão","items":{"$ref":"#/components/schemas/CaixaSugestaoFatPedido"}}}},"CaixaSugestaoFatPedido":{"type":"object","properties":{"codCaixa":{"type":"string","description":"Código da Caixa"},"codTag":{"type":"array","description":"Tags da Caixa (Códigos de Barra)","items":{"type":"string"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVenda/{id}/sugestaoFaturamento/{seqSugestao}":{"get":{"summary":"Obtém Sugestão de Faturamento de um Pedido de Venda","operationId":"ObterSugestaoFatPedido","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SugestaoFatPedido"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}},{"name":"seqSugestao","in":"path","description":"Sequência de Sugestão de Faturamento","required":true,"schema":{"type":"integer"}}]}}}} ``` ## POST /pedidoVenda/{id}/cancelar > Cancela um Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"DadosCancelamentoPedido":{"type":"object","required":["codMotivo"],"properties":{"codMotivo":{"type":"integer","description":"Código do Motivo do Cancelamento"},"nomeUsuarioCancelamento":{"type":"string","description":"Nome do Usuário do Cancelamento"}}}}},"paths":{"/pedidoVenda/{id}/cancelar":{"post":{"summary":"Cancela um Pedido de Venda","operationId":"CancelarPedidoVenda","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para cancelamento do Pedido de Venda","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DadosCancelamentoPedido"}}}}}}}} ``` ## POST /pedidoVenda/{id}/cancelamentoItens > Cancelamento de Itens de Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"DadosItensPedidoCancelamento":{"type":"object","required":["codMotivo"],"properties":{"codMotivo":{"type":"integer","description":"Código do Motivo do Cancelamento"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedidoCancelamento"}}}},"ItemPedidoCancelamento":{"type":"object","required":["seqItem","qtdCancelamento"],"properties":{"seqItem":{"description":"Sequência do Item","type":"string"},"qtdCancelamento":{"type":"number","description":"Quantidade Cancelamento Produto do Pedido"},"observacao":{"maxLength":1000,"description":"Observação"}}}}},"paths":{"/pedidoVenda/{id}/cancelamentoItens":{"post":{"summary":"Cancelamento de Itens de Pedido de Venda","operationId":"CancelarItensPedidoVenda","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para cancelamento de Itens de Pedido de Venda","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DadosItensPedidoCancelamento"}}}}}}}} ``` ## POST /pedidoVenda/{id}/liberarBloqueio/{nomeUsuario} > Liberar Bloqueio de um Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVenda/{id}/liberarBloqueio/{nomeUsuario}":{"post":{"summary":"Liberar Bloqueio de um Pedido de Venda","operationId":"LiberarPedidoVendaEtapaBloqueio","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}},{"name":"nomeUsuario","in":"path","description":"Nome do Usuário ou Aplicação que Está Liberando o Pedido","required":true,"schema":{"type":"string"}}]}}}} ``` ## POST /pedidoVenda/{id}/gerarSugestaoFaturamento > Gera Sugestão de Faturamento de um Pedido de Venda da Confecção ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVenda/{id}/gerarSugestaoFaturamento":{"post":{"summary":"Gera Sugestão de Faturamento de um Pedido de Venda da Confecção","operationId":"GerarSugestaoFatPedidoConfec","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoVenda"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}}]}}}} ``` ## POST /pedidoVenda/liberarConferenciaSugestaoFaturamento/{id},{seqSugestao} > Liberar Sugestão de Faturamento de um Pedido de Venda da Confecção para Conferência ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVenda/liberarConferenciaSugestaoFaturamento/{id},{seqSugestao}":{"post":{"summary":"Liberar Sugestão de Faturamento de um Pedido de Venda da Confecção para Conferência","operationId":"LiberarConferenciaSugestaoFatPedidoConfec","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}},{"name":"seqSugestao","in":"path","description":"Sequência de Sugestão de Faturamento","required":true,"schema":{"type":"integer"}}]}}}} ``` ## DELETE /pedidoVenda/{id}/excluirSugestaoFaturamento/{seqSugestao} > Exclui Sugestão de Faturamento de um Pedido de Venda da Confecção ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVenda/{id}/excluirSugestaoFaturamento/{seqSugestao}":{"delete":{"summary":"Exclui Sugestão de Faturamento de um Pedido de Venda da Confecção","operationId":"ExcluirSugestaoFatPedidoConfec","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}},{"name":"seqSugestao","in":"path","description":"Sequência de Sugestão de Faturamento","required":true,"schema":{"type":"integer"}}]}}}} ``` ## GET /somaPedidoAberto > Obtém a Quantidade e Valor de Saldo dos Pedidos que Estão em Aberto. ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"SomaPedidoAberto":{"type":"object","properties":{"qtdTotal":{"type":"number","multipleOf":0.01,"description":"Quantidade Total DESCONTINUADO"},"qtdTotalPedidos":{"type":"number","multipleOf":0.001,"description":"Quantidade Total Pedidos em Aberto"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/somaPedidoAberto":{"get":{"summary":"Obtém a Quantidade e Valor de Saldo dos Pedidos que Estão em Aberto.","operationId":"SomaPedidoAberto","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SomaPedidoAberto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"cliente","in":"query","required":true,"description":"Código do CPF/CNPJ do Cliente","schema":{"type":"string"}}]}}}} ``` ## GET /pedidoVendaAnaliseFiscal/{id} > Obtem um Analise Fiscal de um Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Pedido de Venda","description":"pedidoVenda"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PedVendaAnaliseFiscal":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido"},"itensPedido":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItPedAnaliseFiscal"}}}},"ItPedAnaliseFiscal":{"type":"object","required":["codItem"],"properties":{"itemPedido":{"type":"number","multipleOf":0.01,"description":"Código Sequencial"},"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"cfop":{"type":"string","description":"CFOP"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total"},"desconto":{"type":"number","multipleOf":0.01,"description":"Valor Desconto"},"acrescimo":{"type":"number","multipleOf":0.01,"description":"Valor Acrescimo"},"reducaoICMS":{"type":"number","multipleOf":0.01,"description":"Perc. Redução do ICMS"},"baseICMS":{"type":"number","multipleOf":0.01,"description":"Valor Base do ICMS"},"aliquotaICMS":{"type":"number","multipleOf":0.01,"description":"Valor da Aliquota do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"valorICMSisentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"despesasAcessorias":{"type":"number","multipleOf":0.01,"description":"Valor Despesas Acessórias"},"baseIPI":{"type":"number","multipleOf":0.01,"description":"Valor da Base IPI"},"aliquotaIPI":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota IPI"},"aliquotaIPI2":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota IPI"},"valoIPIdespAces":{"type":"number","multipleOf":0.01,"description":"Valor do IPI sobre Despesas Acessórias"},"baseICMSst":{"type":"number","multipleOf":0.01,"description":"Valor Base ICMS - ST"},"aliquotaICMSst":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota ICMS - ST"},"valorICMSst":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS - ST"},"mvaICMSst":{"type":"number","multipleOf":0.01,"description":"Valor MVA ICMS - ST"},"reducaoICMSst":{"type":"number","multipleOf":0.01,"description":"Valor da Redução ICMS - ST"},"desICMSzonaFran":{"type":"number","multipleOf":0.01,"description":"Valor Desconto ICMS Zona Franca"},"desPISzonaFran":{"type":"number","multipleOf":0.01,"description":"Valor Desconto PIS Zona Franca"},"desCOFINSzonaFran":{"type":"number","multipleOf":0.01,"description":"Valor Desconto COFINS Zona Franca"},"icmsCobradoOpAnt":{"type":"boolean","description":"Valor ICMS Cobrado em Operação Anterior (1 - Sim, Nulo - Não)"},"baseicmsUFdest":{"type":"number","multipleOf":0.01,"description":"ICMS Base UF Destino"},"icmsAliquoFCP":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Aliquota FCP"},"icmsAliqIntDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Aliquota Interna UF Destino"},"icmsAliqInterestadual":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Aliquota Interestadual"},"icmsInteres":{"type":"number","multipleOf":0.01,"description":"Valor Perc. Prov. Part. ICMS Interestadual"},"icmsFCP":{"type":"number","multipleOf":0.01,"description":"ICMS Valor FCP"},"icmsUFdest":{"type":"number","multipleOf":0.01,"description":"ICMS Valor UF Destino"},"icmsUFreme":{"type":"number","multipleOf":0.01,"description":"ICMS Valor UF Remetente"},"percReducao":{"type":"number","multipleOf":0.01,"description":"Redução BC!ICMS DIFAL"},"codNCM":{"type":"string","description":"Código NCM"},"codCEST":{"type":"string","description":"Código CEST"},"percFECOEP":{"type":"number","multipleOf":0.01,"description":"Percentual FECOEP"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base PIS"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota PIS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor PIS"},"baseCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor Base COFINS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor Alíquota COFINS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor COFINS"},"valorFCPfecoepST":{"type":"number","multipleOf":0.01,"description":"Valor FCP FECOEP ST"},"valorPercFCP43":{"type":"number","multipleOf":0.01,"description":"Valor/Percentual FCP ICMS Normal"},"valorPercFCP44":{"type":"number","multipleOf":0.01,"description":"Valor/Percentual FCP ICMS Normal"},"materiaPrima":{"type":"number","multipleOf":0.01,"description":"Materia Prima"},"valorSTNaoDestacado":{"type":"number","multipleOf":0.01,"description":"Valor ST Não Destacado"},"valorFCPSTNaoDestacado":{"type":"number","multipleOf":0.01,"description":"Valor FCPST Não Destacado"},"cstICMS":{"type":"string","description":"CST ICMS"},"cstPIS":{"type":"string","description":"CST PIS"},"cstCOFINS":{"type":"string","description":"CST COFINS"},"uniMed":{"type":"string","description":"Unidade de Medida"},"quantItem":{"type":"number","multipleOf":0.01,"description":"Quantidade de Item"},"valLiqOP":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Operação"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoVendaAnaliseFiscal/{id}":{"get":{"summary":"Obtem um Analise Fiscal de um Pedido de Venda","operationId":"ObterPedVenAnaliseFisc","tags":["Pedido de Venda"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedVendaAnaliseFiscal"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Venda","required":true,"schema":{"type":"string"}}]}}}} ``` # Nota Fiscal Saída notaFiscalSaida ## GET /notaFiscalSaida > Obter Listagem de Notas Fiscais de Saída ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaNotasFiscaisSaida":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/NotaFiscalSaida"}}}},"NotaFiscalSaida":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","description":"Código Numérico da Nota"},"serie":{"type":"integer","description":"Série da Nota Fiscal"},"codTipoDeNota":{"type":"integer","description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"marca":{"type":"string","description":"Marca"},"numeroVolume":{"type":"string","description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","description":"Identificador de controle do envio do lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalSaida":{"type":"object","required":["codItem"],"properties":{"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"qtdFaturada":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Produto"},"precoUnitario":{"type":"number","multipleOf":0.01,"description":"Preço Unitário do Produto"},"valorItem":{"type":"number","multipleOf":0.01,"description":"Valor do Item"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorDesconto":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto"},"codItemPedido":{"type":"integer","maximum":99,"description":"Código do Item do Pedido de Venda"},"codClassifFiscal":{"type":"string","maxLength":10,"description":"Código da Classificação Fiscal do Produto"},"codGrupo":{"type":"string","maxLength":2,"description":"Código do Grupo"},"percICMS":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"percICMSSubst":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS Substituto"},"valorICMSSubstituto":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"margemLucro":{"type":"number","multipleOf":0.01,"description":"Margem de Lucro para o Produto"},"percReducICMS":{"type":"number","multipleOf":0.01,"description":"Percentual da Redução do ICMS"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido do Produto"},"codSitTributICMS":{"type":"string","minLength":3,"maxLength":3,"description":"Código da Situação Tributária do ICMS"},"percIPI":{"type":"number","multipleOf":0.01,"description":"Percentual do IPI"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação do Produto"},"vlrDescICMSZonaFranca":{"type":"number","multipleOf":0.01,"description":"Desconto ICMS Zona Franca de Manaus"},"baseCalcICMS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS"},"baseCalcICMSIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Isenta"},"baseCalcICMSOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Outra"},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"baseCalcIPIIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Isenta"},"baseCalcIPIOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Outra"},"codSitTributIPI":{"type":"string","minLength":2,"maxLength":2,"description":"Código da Situação Tributária do IPI"},"valorDescNaoIncideICMS":{"type":"number","multipleOf":0.01,"description":"Valor de Desconto Não Incide do ICMS"},"baseCalcSTPIS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST PIS"},"valorSTPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST PIS"},"baseCalcSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST COFINS"},"valorSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST COFINS"},"valorFreteProp":{"type":"number","multipleOf":0.01,"description":"Valor de Frete Proporcional"},"valorSeguroProp":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro Proporcional"},"valorDespAcesProp":{"type":"number","multipleOf":0.01,"description":"Valor Despesa Acessória Proporcional"},"valorPISProp":{"type":"number","multipleOf":0.01,"description":"Valor PIS Proporcional"},"valorCOFINSProp":{"type":"number","multipleOf":0.01,"description":"Valor COFINS Proporcional"},"percPIS":{"type":"number","multipleOf":0.01,"description":"Percentual do PIS"},"percCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual do COFINS"},"baseCalcICMSSubst":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo ICMS Substituto"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorIPIDescAcess":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Sobre as Despesas Acessórias"},"situaICMS":{"type":"integer","description":"Situação do ICMS (0 - Isento, 1 - Tributado, 2 - Outros)","enum":[0,1,2]},"codCSTPis":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST PIS"},"codCSTCofins":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST COFINS"},"valorBaseSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor da Base de ICMS-ST Retido em Operação Anterior"},"valorSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS-ST Retido em Operação Anterior"},"perCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito do ICMS"},"valorCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito do ICMS"},"perReducaoPis":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do PIS"},"perReducaoCofins":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do COFINS"},"valorDiferencaPis":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do PIS"},"valorDiferencaCofins":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do COFINS"},"reducaoBaseIcmsST":{"type":"number","multipleOf":0.01,"description":"Valor Redução da Base do ICMS ST"},"codCSTCSOSN":{"type":"string","maxLength":3,"description":"Código CSOSN Regime Tributário Simples Nacional"},"numeroPedidoCompra":{"type":"string","maxLength":15,"description":"Código do Pedido de Compra"},"itemPedidoCompra":{"type":"integer","maximum":999999,"description":"Item do Pedido de Compra"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Alíquota PIS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Alíquota COFINS"},"valorDespesasBaseIcms":{"type":"number","multipleOf":0.01,"description":"Valor de Despesas da Base do ICMS"},"codEnquadramentoIPI":{"type":"integer","maximum":999,"description":"Código do Enquadramento do IPI"},"baseICMSUFDestino":{"type":"number","multipleOf":0.01,"description":"Valor da BC do ICMS na UF de Destino"},"percFCP":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"aliqUFDest":{"type":"number","multipleOf":0.01,"description":"Alíquota Interna da UF de Destino"},"aliICMSInt":{"type":"number","multipleOf":0.01,"description":"Alíquota Interestadual das UF Envolvidas"},"valorICMSInterestUFDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Interestadual no UF Destino"},"valorFCP":{"type":"number","multipleOf":0.01,"description":"Valor relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"valorDescPropTroca":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Proporcional da Troca"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorAcrescimo":{"type":"number","multipleOf":0.01,"description":"Valor do Acréscimo"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"percComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"cBenef":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal da Operação"},"cCredPresumido":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal do Crédito Presumido (TTD)"},"pCredPresumido":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito Presumido (TTD)"},"vCredPresumido":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito Presumido (TTD)"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"itemPedidoAgrupado":{"type":"array","items":{"$ref":"#/components/schemas/PedidoAgrupadoItemNf"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notaFiscalSaida":{"get":{"summary":"Obter Listagem de Notas Fiscais de Saída","operationId":"ObterNotasFiscaisSaida","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaNotasFiscaisSaida"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","required":false,"schema":{"type":"string","nullable":true}},{"name":"situacao","in":"query","description":"Identificador da Situação da Nota Fiscal (1 - Gerada, 2 - Emitida, 3 - Cancelada)","required":true,"schema":{"type":"array","items":{"type":"integer","enum":[1,2,3]}}},{"name":"tipoNota","in":"query","required":false,"description":"Lista de código do Tipo de Nota","schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"dataEmissaoInicio","in":"query","required":false,"description":"Data de Emissão Inicial da Nota Fiscal (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataEmissaoFim","in":"query","required":false,"description":"Data de Emissão Final da Nota Fiscal (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"clientes","in":"query","required":false,"description":"Lista de Código de Cliente","schema":{"type":"array","nullable":true,"items":{"type":"string"}}},{"name":"statusNFe","in":"query","required":false,"description":"Lista de Status da Nota Fiscal Eletrônica","schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"mascaras","in":"query","description":"Código da Máscara do Produto","required":false,"schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"tipoFiltroMascara","in":"query","description":"Tipo do Filtro da Máscara do Produto: 1 - Desconsiderar Nota Fiscal, 2 - Considerar Nota Fiscal","required":false,"schema":{"type":"integer","nullable":true}},{"name":"pedidos","in":"query","required":false,"description":"Lista de Código de Pedido","schema":{"type":"array","nullable":true,"items":{"type":"string"}}},{"name":"paginacao","in":"query","required":false,"description":"Quantidade de Notas Fiscais na Paginação de Retorno","schema":{"type":"integer","nullable":true}}]}}}} ``` ## PUT /notaFiscalSaida > Cadastrar uma Nota Fiscal de Saída ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"NotaFiscalSaida":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","description":"Código Numérico da Nota"},"serie":{"type":"integer","description":"Série da Nota Fiscal"},"codTipoDeNota":{"type":"integer","description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"marca":{"type":"string","description":"Marca"},"numeroVolume":{"type":"string","description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","description":"Identificador de controle do envio do lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalSaida":{"type":"object","required":["codItem"],"properties":{"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"qtdFaturada":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Produto"},"precoUnitario":{"type":"number","multipleOf":0.01,"description":"Preço Unitário do Produto"},"valorItem":{"type":"number","multipleOf":0.01,"description":"Valor do Item"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorDesconto":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto"},"codItemPedido":{"type":"integer","maximum":99,"description":"Código do Item do Pedido de Venda"},"codClassifFiscal":{"type":"string","maxLength":10,"description":"Código da Classificação Fiscal do Produto"},"codGrupo":{"type":"string","maxLength":2,"description":"Código do Grupo"},"percICMS":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"percICMSSubst":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS Substituto"},"valorICMSSubstituto":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"margemLucro":{"type":"number","multipleOf":0.01,"description":"Margem de Lucro para o Produto"},"percReducICMS":{"type":"number","multipleOf":0.01,"description":"Percentual da Redução do ICMS"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido do Produto"},"codSitTributICMS":{"type":"string","minLength":3,"maxLength":3,"description":"Código da Situação Tributária do ICMS"},"percIPI":{"type":"number","multipleOf":0.01,"description":"Percentual do IPI"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação do Produto"},"vlrDescICMSZonaFranca":{"type":"number","multipleOf":0.01,"description":"Desconto ICMS Zona Franca de Manaus"},"baseCalcICMS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS"},"baseCalcICMSIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Isenta"},"baseCalcICMSOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Outra"},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"baseCalcIPIIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Isenta"},"baseCalcIPIOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Outra"},"codSitTributIPI":{"type":"string","minLength":2,"maxLength":2,"description":"Código da Situação Tributária do IPI"},"valorDescNaoIncideICMS":{"type":"number","multipleOf":0.01,"description":"Valor de Desconto Não Incide do ICMS"},"baseCalcSTPIS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST PIS"},"valorSTPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST PIS"},"baseCalcSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST COFINS"},"valorSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST COFINS"},"valorFreteProp":{"type":"number","multipleOf":0.01,"description":"Valor de Frete Proporcional"},"valorSeguroProp":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro Proporcional"},"valorDespAcesProp":{"type":"number","multipleOf":0.01,"description":"Valor Despesa Acessória Proporcional"},"valorPISProp":{"type":"number","multipleOf":0.01,"description":"Valor PIS Proporcional"},"valorCOFINSProp":{"type":"number","multipleOf":0.01,"description":"Valor COFINS Proporcional"},"percPIS":{"type":"number","multipleOf":0.01,"description":"Percentual do PIS"},"percCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual do COFINS"},"baseCalcICMSSubst":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo ICMS Substituto"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorIPIDescAcess":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Sobre as Despesas Acessórias"},"situaICMS":{"type":"integer","description":"Situação do ICMS (0 - Isento, 1 - Tributado, 2 - Outros)","enum":[0,1,2]},"codCSTPis":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST PIS"},"codCSTCofins":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST COFINS"},"valorBaseSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor da Base de ICMS-ST Retido em Operação Anterior"},"valorSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS-ST Retido em Operação Anterior"},"perCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito do ICMS"},"valorCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito do ICMS"},"perReducaoPis":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do PIS"},"perReducaoCofins":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do COFINS"},"valorDiferencaPis":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do PIS"},"valorDiferencaCofins":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do COFINS"},"reducaoBaseIcmsST":{"type":"number","multipleOf":0.01,"description":"Valor Redução da Base do ICMS ST"},"codCSTCSOSN":{"type":"string","maxLength":3,"description":"Código CSOSN Regime Tributário Simples Nacional"},"numeroPedidoCompra":{"type":"string","maxLength":15,"description":"Código do Pedido de Compra"},"itemPedidoCompra":{"type":"integer","maximum":999999,"description":"Item do Pedido de Compra"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Alíquota PIS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Alíquota COFINS"},"valorDespesasBaseIcms":{"type":"number","multipleOf":0.01,"description":"Valor de Despesas da Base do ICMS"},"codEnquadramentoIPI":{"type":"integer","maximum":999,"description":"Código do Enquadramento do IPI"},"baseICMSUFDestino":{"type":"number","multipleOf":0.01,"description":"Valor da BC do ICMS na UF de Destino"},"percFCP":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"aliqUFDest":{"type":"number","multipleOf":0.01,"description":"Alíquota Interna da UF de Destino"},"aliICMSInt":{"type":"number","multipleOf":0.01,"description":"Alíquota Interestadual das UF Envolvidas"},"valorICMSInterestUFDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Interestadual no UF Destino"},"valorFCP":{"type":"number","multipleOf":0.01,"description":"Valor relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"valorDescPropTroca":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Proporcional da Troca"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorAcrescimo":{"type":"number","multipleOf":0.01,"description":"Valor do Acréscimo"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"percComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"cBenef":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal da Operação"},"cCredPresumido":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal do Crédito Presumido (TTD)"},"pCredPresumido":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito Presumido (TTD)"},"vCredPresumido":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito Presumido (TTD)"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"itemPedidoAgrupado":{"type":"array","items":{"$ref":"#/components/schemas/PedidoAgrupadoItemNf"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"NotaFiscalSaidaPut":{"type":"object","required":["dataEmissao","codNumNota"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","maximum":9999999,"description":"Código Numérico da Nota"},"codTipoDeNota":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitida, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","maxLength":7,"description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","maximum":9999,"description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","maximum":9999999,"description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","maxLength":10,"description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","maximum":99999,"description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","maxLength":10,"description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","maxLength":10,"description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"marca":{"type":"string","maxLength":13,"description":"Marca"},"numeroVolume":{"type":"string","maxLength":10,"description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","maxLength":35,"description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","maxLength":35,"description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","maxLength":35,"description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","minLength":44,"maxLength":44,"description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","maxLength":15,"description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","maxLength":3,"description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","maxLength":7,"description":"Identificador de Controle do Envio do Lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","maxLength":15,"description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","maxLength":3,"description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","maxLength":50,"description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"CEPEntrega":{"type":"string","maxLength":8,"description":"CEP da Entrega"},"codCondicaoVenda":{"type":"integer","description":"Código da Condição de Venda"},"msgNotaFiscal":{"type":"string","maxLength":1000,"description":"Mensagem para a Nota Fiscal"},"valorBaseCalcIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor de Base de Cálculo IPI Isentas"},"valorBaseCalcIPIOutras":{"type":"number","multipleOf":0.01,"description":"Valor de Base de Cálculo IPI Outras"},"valorICMSOutras":{"type":"number","multipleOf":0.01,"description":"Valor de Base de Cálculo ICMS Outras"},"baseCalcComisRep":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"percComissao":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissao":{"type":"number","multipleOf":0.01,"description":"Valor da Comissão do Representante"},"valorDescontoEspecialCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial da Capa"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"duplicatas":{"type":"array","description":"Duplicatas da Nota Fiscal","items":{"$ref":"#/components/schemas/duplicataNF"}},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"duplicataNF":{"type":"object","required":["tipoPagamento","dataEmissao","qtdParcela","parcelaDuplicataNF"],"properties":{"tipoPagamento":{"type":"string","description":"Tipo de Pagamento (Boleto / Cartão))","enum":["boleto","cartao"]},"dataEmissao":{"type":"string","format":"date","description":"Data da Emissão da Duplicata (YYYY-MM-DD)"},"qtdParcela":{"type":"integer","minimum":1,"description":"Quantidade de Parcelas"},"codPortador":{"type":"integer","description":"Código do Portador"},"tipoCobranca":{"type":"integer","description":"Tipo de Cobrança"},"condicaoVenda":{"type":"integer","description":"Condição de Venda"},"parcela":{"type":"array","description":"Dados das Parcelas","items":{"$ref":"#/components/schemas/parcelaDuplicataNF"}}}},"parcelaDuplicataNF":{"type":"object","required":["valor","dataVencimento"],"properties":{"valor":{"type":"number","multipleOf":0.01,"description":"Valor da Parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento da Parcela (YYYY-MM-DD)"},"dataPagamento":{"type":"string","format":"date","description":"Data do Pagamento da Parcela (YYYY-MM-DD)"},"numeroBancario":{"type":"string","description":"Número do Banco"},"codAutorizacao":{"type":"string","description":"Código de Autorização"},"codNSU":{"type":"string","description":"Código do Número Sequencial Único"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"}}}}},"paths":{"/notaFiscalSaida":{"put":{"summary":"Cadastrar uma Nota Fiscal de Saída","operationId":"CadastrarNotaFiscalSaida","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalSaida"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}}],"requestBody":{"description":"Dados da Nota Fiscal de Saída","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalSaidaPut"}}}}}}}} ``` ## GET /notaFiscalSaidaPedido/{codPedido} > Obter as Notas Fiscais de Saída a partir do Pedido de Venda ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"NotaFiscalSaida":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","description":"Código Numérico da Nota"},"serie":{"type":"integer","description":"Série da Nota Fiscal"},"codTipoDeNota":{"type":"integer","description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"marca":{"type":"string","description":"Marca"},"numeroVolume":{"type":"string","description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","description":"Identificador de controle do envio do lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalSaida":{"type":"object","required":["codItem"],"properties":{"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"qtdFaturada":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Produto"},"precoUnitario":{"type":"number","multipleOf":0.01,"description":"Preço Unitário do Produto"},"valorItem":{"type":"number","multipleOf":0.01,"description":"Valor do Item"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorDesconto":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto"},"codItemPedido":{"type":"integer","maximum":99,"description":"Código do Item do Pedido de Venda"},"codClassifFiscal":{"type":"string","maxLength":10,"description":"Código da Classificação Fiscal do Produto"},"codGrupo":{"type":"string","maxLength":2,"description":"Código do Grupo"},"percICMS":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"percICMSSubst":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS Substituto"},"valorICMSSubstituto":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"margemLucro":{"type":"number","multipleOf":0.01,"description":"Margem de Lucro para o Produto"},"percReducICMS":{"type":"number","multipleOf":0.01,"description":"Percentual da Redução do ICMS"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido do Produto"},"codSitTributICMS":{"type":"string","minLength":3,"maxLength":3,"description":"Código da Situação Tributária do ICMS"},"percIPI":{"type":"number","multipleOf":0.01,"description":"Percentual do IPI"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação do Produto"},"vlrDescICMSZonaFranca":{"type":"number","multipleOf":0.01,"description":"Desconto ICMS Zona Franca de Manaus"},"baseCalcICMS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS"},"baseCalcICMSIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Isenta"},"baseCalcICMSOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Outra"},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"baseCalcIPIIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Isenta"},"baseCalcIPIOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Outra"},"codSitTributIPI":{"type":"string","minLength":2,"maxLength":2,"description":"Código da Situação Tributária do IPI"},"valorDescNaoIncideICMS":{"type":"number","multipleOf":0.01,"description":"Valor de Desconto Não Incide do ICMS"},"baseCalcSTPIS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST PIS"},"valorSTPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST PIS"},"baseCalcSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST COFINS"},"valorSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST COFINS"},"valorFreteProp":{"type":"number","multipleOf":0.01,"description":"Valor de Frete Proporcional"},"valorSeguroProp":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro Proporcional"},"valorDespAcesProp":{"type":"number","multipleOf":0.01,"description":"Valor Despesa Acessória Proporcional"},"valorPISProp":{"type":"number","multipleOf":0.01,"description":"Valor PIS Proporcional"},"valorCOFINSProp":{"type":"number","multipleOf":0.01,"description":"Valor COFINS Proporcional"},"percPIS":{"type":"number","multipleOf":0.01,"description":"Percentual do PIS"},"percCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual do COFINS"},"baseCalcICMSSubst":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo ICMS Substituto"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorIPIDescAcess":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Sobre as Despesas Acessórias"},"situaICMS":{"type":"integer","description":"Situação do ICMS (0 - Isento, 1 - Tributado, 2 - Outros)","enum":[0,1,2]},"codCSTPis":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST PIS"},"codCSTCofins":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST COFINS"},"valorBaseSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor da Base de ICMS-ST Retido em Operação Anterior"},"valorSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS-ST Retido em Operação Anterior"},"perCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito do ICMS"},"valorCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito do ICMS"},"perReducaoPis":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do PIS"},"perReducaoCofins":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do COFINS"},"valorDiferencaPis":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do PIS"},"valorDiferencaCofins":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do COFINS"},"reducaoBaseIcmsST":{"type":"number","multipleOf":0.01,"description":"Valor Redução da Base do ICMS ST"},"codCSTCSOSN":{"type":"string","maxLength":3,"description":"Código CSOSN Regime Tributário Simples Nacional"},"numeroPedidoCompra":{"type":"string","maxLength":15,"description":"Código do Pedido de Compra"},"itemPedidoCompra":{"type":"integer","maximum":999999,"description":"Item do Pedido de Compra"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Alíquota PIS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Alíquota COFINS"},"valorDespesasBaseIcms":{"type":"number","multipleOf":0.01,"description":"Valor de Despesas da Base do ICMS"},"codEnquadramentoIPI":{"type":"integer","maximum":999,"description":"Código do Enquadramento do IPI"},"baseICMSUFDestino":{"type":"number","multipleOf":0.01,"description":"Valor da BC do ICMS na UF de Destino"},"percFCP":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"aliqUFDest":{"type":"number","multipleOf":0.01,"description":"Alíquota Interna da UF de Destino"},"aliICMSInt":{"type":"number","multipleOf":0.01,"description":"Alíquota Interestadual das UF Envolvidas"},"valorICMSInterestUFDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Interestadual no UF Destino"},"valorFCP":{"type":"number","multipleOf":0.01,"description":"Valor relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"valorDescPropTroca":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Proporcional da Troca"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorAcrescimo":{"type":"number","multipleOf":0.01,"description":"Valor do Acréscimo"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"percComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"cBenef":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal da Operação"},"cCredPresumido":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal do Crédito Presumido (TTD)"},"pCredPresumido":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito Presumido (TTD)"},"vCredPresumido":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito Presumido (TTD)"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"itemPedidoAgrupado":{"type":"array","items":{"$ref":"#/components/schemas/PedidoAgrupadoItemNf"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notaFiscalSaidaPedido/{codPedido}":{"get":{"summary":"Obter as Notas Fiscais de Saída a partir do Pedido de Venda","operationId":"ObterNotaFiscalSaidaPedido","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotaFiscalSaida"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codPedido","in":"path","description":"Código do Pedido","required":true,"schema":{"type":"string"}}]}}}} ``` ## GET /notaFiscalSaida/{id} > Obter uma Nota Fiscal de Saída ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"NotaFiscalSaida":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","description":"Código Numérico da Nota"},"serie":{"type":"integer","description":"Série da Nota Fiscal"},"codTipoDeNota":{"type":"integer","description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"marca":{"type":"string","description":"Marca"},"numeroVolume":{"type":"string","description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","description":"Identificador de controle do envio do lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalSaida":{"type":"object","required":["codItem"],"properties":{"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"qtdFaturada":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Produto"},"precoUnitario":{"type":"number","multipleOf":0.01,"description":"Preço Unitário do Produto"},"valorItem":{"type":"number","multipleOf":0.01,"description":"Valor do Item"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorDesconto":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto"},"codItemPedido":{"type":"integer","maximum":99,"description":"Código do Item do Pedido de Venda"},"codClassifFiscal":{"type":"string","maxLength":10,"description":"Código da Classificação Fiscal do Produto"},"codGrupo":{"type":"string","maxLength":2,"description":"Código do Grupo"},"percICMS":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"percICMSSubst":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS Substituto"},"valorICMSSubstituto":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"margemLucro":{"type":"number","multipleOf":0.01,"description":"Margem de Lucro para o Produto"},"percReducICMS":{"type":"number","multipleOf":0.01,"description":"Percentual da Redução do ICMS"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido do Produto"},"codSitTributICMS":{"type":"string","minLength":3,"maxLength":3,"description":"Código da Situação Tributária do ICMS"},"percIPI":{"type":"number","multipleOf":0.01,"description":"Percentual do IPI"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação do Produto"},"vlrDescICMSZonaFranca":{"type":"number","multipleOf":0.01,"description":"Desconto ICMS Zona Franca de Manaus"},"baseCalcICMS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS"},"baseCalcICMSIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Isenta"},"baseCalcICMSOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Outra"},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"baseCalcIPIIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Isenta"},"baseCalcIPIOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Outra"},"codSitTributIPI":{"type":"string","minLength":2,"maxLength":2,"description":"Código da Situação Tributária do IPI"},"valorDescNaoIncideICMS":{"type":"number","multipleOf":0.01,"description":"Valor de Desconto Não Incide do ICMS"},"baseCalcSTPIS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST PIS"},"valorSTPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST PIS"},"baseCalcSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST COFINS"},"valorSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST COFINS"},"valorFreteProp":{"type":"number","multipleOf":0.01,"description":"Valor de Frete Proporcional"},"valorSeguroProp":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro Proporcional"},"valorDespAcesProp":{"type":"number","multipleOf":0.01,"description":"Valor Despesa Acessória Proporcional"},"valorPISProp":{"type":"number","multipleOf":0.01,"description":"Valor PIS Proporcional"},"valorCOFINSProp":{"type":"number","multipleOf":0.01,"description":"Valor COFINS Proporcional"},"percPIS":{"type":"number","multipleOf":0.01,"description":"Percentual do PIS"},"percCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual do COFINS"},"baseCalcICMSSubst":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo ICMS Substituto"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorIPIDescAcess":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Sobre as Despesas Acessórias"},"situaICMS":{"type":"integer","description":"Situação do ICMS (0 - Isento, 1 - Tributado, 2 - Outros)","enum":[0,1,2]},"codCSTPis":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST PIS"},"codCSTCofins":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST COFINS"},"valorBaseSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor da Base de ICMS-ST Retido em Operação Anterior"},"valorSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS-ST Retido em Operação Anterior"},"perCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito do ICMS"},"valorCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito do ICMS"},"perReducaoPis":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do PIS"},"perReducaoCofins":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do COFINS"},"valorDiferencaPis":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do PIS"},"valorDiferencaCofins":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do COFINS"},"reducaoBaseIcmsST":{"type":"number","multipleOf":0.01,"description":"Valor Redução da Base do ICMS ST"},"codCSTCSOSN":{"type":"string","maxLength":3,"description":"Código CSOSN Regime Tributário Simples Nacional"},"numeroPedidoCompra":{"type":"string","maxLength":15,"description":"Código do Pedido de Compra"},"itemPedidoCompra":{"type":"integer","maximum":999999,"description":"Item do Pedido de Compra"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Alíquota PIS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Alíquota COFINS"},"valorDespesasBaseIcms":{"type":"number","multipleOf":0.01,"description":"Valor de Despesas da Base do ICMS"},"codEnquadramentoIPI":{"type":"integer","maximum":999,"description":"Código do Enquadramento do IPI"},"baseICMSUFDestino":{"type":"number","multipleOf":0.01,"description":"Valor da BC do ICMS na UF de Destino"},"percFCP":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"aliqUFDest":{"type":"number","multipleOf":0.01,"description":"Alíquota Interna da UF de Destino"},"aliICMSInt":{"type":"number","multipleOf":0.01,"description":"Alíquota Interestadual das UF Envolvidas"},"valorICMSInterestUFDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Interestadual no UF Destino"},"valorFCP":{"type":"number","multipleOf":0.01,"description":"Valor relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"valorDescPropTroca":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Proporcional da Troca"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorAcrescimo":{"type":"number","multipleOf":0.01,"description":"Valor do Acréscimo"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"percComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"cBenef":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal da Operação"},"cCredPresumido":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal do Crédito Presumido (TTD)"},"pCredPresumido":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito Presumido (TTD)"},"vCredPresumido":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito Presumido (TTD)"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"itemPedidoAgrupado":{"type":"array","items":{"$ref":"#/components/schemas/PedidoAgrupadoItemNf"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notaFiscalSaida/{id}":{"get":{"summary":"Obter uma Nota Fiscal de Saída","operationId":"ObterNotaFiscalSaida","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotaFiscalSaida"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Chave da Nota Fiscal de Saída","required":true,"schema":{"type":"string"}}]}}}} ``` ## DELETE /notaFiscalSaida/{id} > Excluir uma Nota Fiscal de Saída ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notaFiscalSaida/{id}":{"delete":{"summary":"Excluir uma Nota Fiscal de Saída","operationId":"ExcluirNotaFiscalSaida","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Chave da Nota Fiscal de Saída","required":true,"schema":{"type":"string"}}]}}}} ``` ## GET /notaFiscalSaida/{id}/caixaTag > Obter Caixa com Tags(Confecção) de uma Nota Fiscal de Saída ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaCaixaTagNotaFiscal":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CaixaTagNotaFiscal"}}}},"CaixaTagNotaFiscal":{"type":"object","properties":{"codCaixa":{"type":"string","description":"Código da Caixa"},"situacao":{"type":"integer","description":"Situação da Caixa (0 - Gerada/Listada, 1 - Encerrada, 2 - Faturada, 3 - Cancelada, 4 - Faturada em Quilo)","enum":[0,1,2,3,4]},"dataEmissaoNF":{"type":"string","format":"date","description":"Data da Emissão da Nota Fiscal (YYYY-MM-DD)"},"notaFiscal":{"type":"integer","description":"Código da Nota Fiscal"},"transportadora":{"type":"integer","description":"Código da Transportadora"},"codCliente":{"type":"integer","description":"Código do Cliente"},"tabelaPrecoKg":{"type":"integer","description":"Código da Tabela de Preço"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"codEmbalagem":{"type":"string","description":"Código da Embalagem"},"pedido":{"type":"array","description":"Pedidos de Venda","items":{"type":"string"}},"tag":{"type":"array","description":"Tags das peças da Caixa (Código de Barras)","items":{"$ref":"#/components/schemas/tagNF"}}}},"tagNF":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto da Tag"},"codTag":{"type":"string","description":"Código de Barras da Tag"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notaFiscalSaida/{id}/caixaTag":{"get":{"summary":"Obter Caixa com Tags(Confecção) de uma Nota Fiscal de Saída","operationId":"ObterCaixasTagNotaFiscalSaida","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListaCaixaTagNotaFiscal"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","description":"Chave da Nota Fiscal de Saída","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","required":false,"schema":{"type":"string","nullable":true}}]}}}} ``` ## PUT /notaFiscalSaida/replicar > Replicar uma Nota Fiscal de Saída ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"NotaFiscalSaida":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","description":"Código Numérico da Nota"},"serie":{"type":"integer","description":"Série da Nota Fiscal"},"codTipoDeNota":{"type":"integer","description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"marca":{"type":"string","description":"Marca"},"numeroVolume":{"type":"string","description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","description":"Identificador de controle do envio do lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalSaida":{"type":"object","required":["codItem"],"properties":{"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"qtdFaturada":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Produto"},"precoUnitario":{"type":"number","multipleOf":0.01,"description":"Preço Unitário do Produto"},"valorItem":{"type":"number","multipleOf":0.01,"description":"Valor do Item"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorDesconto":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto"},"codItemPedido":{"type":"integer","maximum":99,"description":"Código do Item do Pedido de Venda"},"codClassifFiscal":{"type":"string","maxLength":10,"description":"Código da Classificação Fiscal do Produto"},"codGrupo":{"type":"string","maxLength":2,"description":"Código do Grupo"},"percICMS":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"percICMSSubst":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS Substituto"},"valorICMSSubstituto":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"margemLucro":{"type":"number","multipleOf":0.01,"description":"Margem de Lucro para o Produto"},"percReducICMS":{"type":"number","multipleOf":0.01,"description":"Percentual da Redução do ICMS"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido do Produto"},"codSitTributICMS":{"type":"string","minLength":3,"maxLength":3,"description":"Código da Situação Tributária do ICMS"},"percIPI":{"type":"number","multipleOf":0.01,"description":"Percentual do IPI"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação do Produto"},"vlrDescICMSZonaFranca":{"type":"number","multipleOf":0.01,"description":"Desconto ICMS Zona Franca de Manaus"},"baseCalcICMS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS"},"baseCalcICMSIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Isenta"},"baseCalcICMSOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Outra"},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"baseCalcIPIIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Isenta"},"baseCalcIPIOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Outra"},"codSitTributIPI":{"type":"string","minLength":2,"maxLength":2,"description":"Código da Situação Tributária do IPI"},"valorDescNaoIncideICMS":{"type":"number","multipleOf":0.01,"description":"Valor de Desconto Não Incide do ICMS"},"baseCalcSTPIS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST PIS"},"valorSTPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST PIS"},"baseCalcSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST COFINS"},"valorSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST COFINS"},"valorFreteProp":{"type":"number","multipleOf":0.01,"description":"Valor de Frete Proporcional"},"valorSeguroProp":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro Proporcional"},"valorDespAcesProp":{"type":"number","multipleOf":0.01,"description":"Valor Despesa Acessória Proporcional"},"valorPISProp":{"type":"number","multipleOf":0.01,"description":"Valor PIS Proporcional"},"valorCOFINSProp":{"type":"number","multipleOf":0.01,"description":"Valor COFINS Proporcional"},"percPIS":{"type":"number","multipleOf":0.01,"description":"Percentual do PIS"},"percCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual do COFINS"},"baseCalcICMSSubst":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo ICMS Substituto"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorIPIDescAcess":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Sobre as Despesas Acessórias"},"situaICMS":{"type":"integer","description":"Situação do ICMS (0 - Isento, 1 - Tributado, 2 - Outros)","enum":[0,1,2]},"codCSTPis":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST PIS"},"codCSTCofins":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST COFINS"},"valorBaseSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor da Base de ICMS-ST Retido em Operação Anterior"},"valorSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS-ST Retido em Operação Anterior"},"perCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito do ICMS"},"valorCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito do ICMS"},"perReducaoPis":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do PIS"},"perReducaoCofins":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do COFINS"},"valorDiferencaPis":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do PIS"},"valorDiferencaCofins":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do COFINS"},"reducaoBaseIcmsST":{"type":"number","multipleOf":0.01,"description":"Valor Redução da Base do ICMS ST"},"codCSTCSOSN":{"type":"string","maxLength":3,"description":"Código CSOSN Regime Tributário Simples Nacional"},"numeroPedidoCompra":{"type":"string","maxLength":15,"description":"Código do Pedido de Compra"},"itemPedidoCompra":{"type":"integer","maximum":999999,"description":"Item do Pedido de Compra"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Alíquota PIS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Alíquota COFINS"},"valorDespesasBaseIcms":{"type":"number","multipleOf":0.01,"description":"Valor de Despesas da Base do ICMS"},"codEnquadramentoIPI":{"type":"integer","maximum":999,"description":"Código do Enquadramento do IPI"},"baseICMSUFDestino":{"type":"number","multipleOf":0.01,"description":"Valor da BC do ICMS na UF de Destino"},"percFCP":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"aliqUFDest":{"type":"number","multipleOf":0.01,"description":"Alíquota Interna da UF de Destino"},"aliICMSInt":{"type":"number","multipleOf":0.01,"description":"Alíquota Interestadual das UF Envolvidas"},"valorICMSInterestUFDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Interestadual no UF Destino"},"valorFCP":{"type":"number","multipleOf":0.01,"description":"Valor relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"valorDescPropTroca":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Proporcional da Troca"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorAcrescimo":{"type":"number","multipleOf":0.01,"description":"Valor do Acréscimo"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"percComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"cBenef":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal da Operação"},"cCredPresumido":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal do Crédito Presumido (TTD)"},"pCredPresumido":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito Presumido (TTD)"},"vCredPresumido":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito Presumido (TTD)"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"itemPedidoAgrupado":{"type":"array","items":{"$ref":"#/components/schemas/PedidoAgrupadoItemNf"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"NotaFiscalSaidaPut":{"type":"object","required":["dataEmissao","codNumNota"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","maximum":9999999,"description":"Código Numérico da Nota"},"codTipoDeNota":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitida, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","maxLength":7,"description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","maximum":9999,"description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","maximum":9999999,"description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","maxLength":10,"description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","maximum":99999,"description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","maxLength":10,"description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","maxLength":10,"description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"marca":{"type":"string","maxLength":13,"description":"Marca"},"numeroVolume":{"type":"string","maxLength":10,"description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","maxLength":35,"description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","maxLength":35,"description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","maxLength":35,"description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","minLength":44,"maxLength":44,"description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","maxLength":15,"description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","maxLength":3,"description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","maxLength":7,"description":"Identificador de Controle do Envio do Lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","maxLength":15,"description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","maxLength":3,"description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","maxLength":50,"description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"CEPEntrega":{"type":"string","maxLength":8,"description":"CEP da Entrega"},"codCondicaoVenda":{"type":"integer","description":"Código da Condição de Venda"},"msgNotaFiscal":{"type":"string","maxLength":1000,"description":"Mensagem para a Nota Fiscal"},"valorBaseCalcIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor de Base de Cálculo IPI Isentas"},"valorBaseCalcIPIOutras":{"type":"number","multipleOf":0.01,"description":"Valor de Base de Cálculo IPI Outras"},"valorICMSOutras":{"type":"number","multipleOf":0.01,"description":"Valor de Base de Cálculo ICMS Outras"},"baseCalcComisRep":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"percComissao":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissao":{"type":"number","multipleOf":0.01,"description":"Valor da Comissão do Representante"},"valorDescontoEspecialCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial da Capa"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"duplicatas":{"type":"array","description":"Duplicatas da Nota Fiscal","items":{"$ref":"#/components/schemas/duplicataNF"}},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"duplicataNF":{"type":"object","required":["tipoPagamento","dataEmissao","qtdParcela","parcelaDuplicataNF"],"properties":{"tipoPagamento":{"type":"string","description":"Tipo de Pagamento (Boleto / Cartão))","enum":["boleto","cartao"]},"dataEmissao":{"type":"string","format":"date","description":"Data da Emissão da Duplicata (YYYY-MM-DD)"},"qtdParcela":{"type":"integer","minimum":1,"description":"Quantidade de Parcelas"},"codPortador":{"type":"integer","description":"Código do Portador"},"tipoCobranca":{"type":"integer","description":"Tipo de Cobrança"},"condicaoVenda":{"type":"integer","description":"Condição de Venda"},"parcela":{"type":"array","description":"Dados das Parcelas","items":{"$ref":"#/components/schemas/parcelaDuplicataNF"}}}},"parcelaDuplicataNF":{"type":"object","required":["valor","dataVencimento"],"properties":{"valor":{"type":"number","multipleOf":0.01,"description":"Valor da Parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento da Parcela (YYYY-MM-DD)"},"dataPagamento":{"type":"string","format":"date","description":"Data do Pagamento da Parcela (YYYY-MM-DD)"},"numeroBancario":{"type":"string","description":"Número do Banco"},"codAutorizacao":{"type":"string","description":"Código de Autorização"},"codNSU":{"type":"string","description":"Código do Número Sequencial Único"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"}}}}},"paths":{"/notaFiscalSaida/replicar":{"put":{"summary":"Replicar uma Nota Fiscal de Saída","operationId":"ReplicarNotaFiscalSaida","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalSaida"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}}],"requestBody":{"description":"Dados da Nota Fiscal de Saída","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalSaidaPut"}}}}}}}} ``` ## GET /notaFiscalSaida/{id}/etiquetaTinto > Obter Etiquetas Tinto de uma Nota Fiscal de Saída ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaEtiquetaMalhaTintoNotaFiscal":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EtiquetaMalhaTintoNotaFiscal"}}}},"EtiquetaMalhaTintoNotaFiscal":{"type":"object","properties":{"dataEmissaoNF":{"type":"string","format":"date","description":"Data da Emissão da Nota Fiscal (YYYY-MM-DD)"},"notaFiscal":{"type":"integer","description":"Código da Nota Fiscal"},"itemNota":{"type":"integer","description":"Código do Item da Nota da Etiqueta"},"etiquetas":{"type":"array","description":"Etiquetas (Código de Barras)","items":{"$ref":"#/components/schemas/EtiquetasMalhaTintoNF"}}}},"EtiquetasMalhaTintoNF":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto da Etiqueta"},"codEtiqueta":{"type":"string","description":"Código de Barras da Etiqueta"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notaFiscalSaida/{id}/etiquetaTinto":{"get":{"tags":["Nota Fiscal Saída"],"summary":"Obter Etiquetas Tinto de uma Nota Fiscal de Saída","operationId":"ObterEtiquetasMalhaTintoNotaFiscalSaida","parameters":[{"name":"empresa","in":"header","schema":{"type":"string"},"required":true,"description":"Código da Empresa"},{"name":"id","in":"path","description":"Chave da Nota Fiscal de Saída","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","required":false,"schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListaEtiquetaMalhaTintoNotaFiscal"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /notaFiscalDanfe > Obter a Segunda via de Notas Fiscais de Saída Emitidas em Determinado Período ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"NotaFiscalDanfe":{"type":"object","properties":{"arquivo":{"type":"string","format":"byte","description":"Arquivo com a DANFE da Nota Fiscal"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notaFiscalDanfe":{"get":{"summary":"Obter a Segunda via de Notas Fiscais de Saída Emitidas em Determinado Período","operationId":"ObterNotaFiscalDanfe","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalDanfe"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"cliente","in":"query","required":true,"description":"CPF/CNPJ do Cliente","schema":{"type":"string"}},{"name":"dataInicio","in":"query","description":"Data de Início de um Intervalo de Tempo (YYYY-MM-DD)","required":true,"schema":{"type":"string"}},{"name":"dataFim","in":"query","description":"Data de Término de um Intervalo de Tempo (YYYY-MM-DD)","required":true,"schema":{"type":"string"}},{"name":"mascaras","in":"query","description":"Código da Máscara do Produto","required":false,"schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"tipoFiltroMascara","in":"query","description":"Tipo do Filtro da Máscara do Produto: 1 - Desconsiderar Nota Fiscal, 2 - Considerar Nota Fiscal","required":false,"schema":{"type":"integer","nullable":true}}]}}}} ``` ## GET /danfeNotaFiscal > Obter a Segunda via de uma Nota Fiscal ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"NotaFiscalDanfe":{"type":"object","properties":{"arquivo":{"type":"string","format":"byte","description":"Arquivo com a DANFE da Nota Fiscal"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/danfeNotaFiscal":{"get":{"summary":"Obter a Segunda via de uma Nota Fiscal","operationId":"ObterDanfeNotaFiscal","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalDanfe"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"dataEmissao","in":"query","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)","required":true,"schema":{"type":"string"}},{"name":"codNota","in":"query","required":true,"description":"Código da Nota Fiscal","schema":{"type":"string"}}]}}}} ``` ## GET /notaFiscalXML > Obter XML de Nota Fiscal ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"NotaFiscalXML":{"type":"object","properties":{"arquivo":{"type":"string","format":"byte","description":"Arquivo com o XML da Nota Fiscal"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notaFiscalXML":{"get":{"summary":"Obter XML de Nota Fiscal","operationId":"ObterNotaFiscalXML","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalXML"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"dataEmissao","in":"query","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)","required":true,"schema":{"type":"string"}},{"name":"codNota","in":"query","required":true,"description":"Código da Nota Fiscal","schema":{"type":"string"}}]}}}} ``` ## GET /notaFiscalEvento > Obter a Segunda via de Notas Fiscais de Saída pelo ID do Evento ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Nota Fiscal Saída","description":"notaFiscalSaida"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"NotaFiscalEvento":{"type":"object","properties":{"arquivo":{"type":"string","format":"byte","description":"Obtem uma Nota Fiscal pelo ID do Evento"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notaFiscalEvento":{"get":{"summary":"Obter a Segunda via de Notas Fiscais de Saída pelo ID do Evento","operationId":"ObterNotaFiscalEvento","tags":["Nota Fiscal Saída"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalEvento"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"idEvento","in":"query","required":true,"description":"id da nota obtido na api de eventos","schema":{"type":"string"}}]}}}} ``` # Devolução Nota Fiscal devolucaoNota ## GET /devolucaoNota > Obter Listagem de Devolução de Nota Fiscal ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Devolução Nota Fiscal","description":"devolucaoNota"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaNotasDevolucao":{"type":"object","properties":{"continuationToken":{"type":"string"},"notasDevolucao":{"type":"array","description":"Notas de Devolução","items":{"$ref":"#/components/schemas/NotaDevolucao"}}}},"NotaDevolucao":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do Documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave de Acesso NF-e/NFC-e","minLength":44},"serieFiscal":{"type":"integer","maximum":999,"description":"Código da Série Fiscal"},"parametroDevolucao":{"type":"integer","maximum":999,"description":"Código do Parâmetro da Devolução"},"motivoDevolucao":{"type":"integer","minimum":1,"maximum":99,"description":"Código do Motivo da Devolução"},"notasDevolvidas":{"type":"array","description":"Notas Fiscais Devolvidas","items":{"$ref":"#/components/schemas/NotasDevolvidasDev"}},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucaoGet"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NotasDevolvidasDev":{"type":"object","properties":{"dataNotaDev":{"type":"string","description":"Data da Nota Fiscal Devolvida"},"codNotaDev":{"type":"integer","description":"Código da Nota Fical Devolvida"}}},"ItensDevolucaoGet":{"type":"object","properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do Item da Devolução"},"codProduto":{"type":"string","description":"Código do Produto (Reduzido do item)"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade a ser Devolvida"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço Unitário Liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Total Líquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do Desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Isenta"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Outras"},"cstICMS":{"type":"string","maxLength":3,"description":"Código da Situação Tributária - ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de Frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base ICMS Substituição Tributária"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor ICMS Substituição Tributária"},"outrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Outras Despesas"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/devolucaoNota":{"get":{"summary":"Obter Listagem de Devolução de Nota Fiscal","operationId":"ObterListaDevolucaoNotaFiscal","tags":["Devolução Nota Fiscal"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaNotasDevolucao"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Empresa para Importação da Devolução","required":true,"schema":{"type":"integer"}},{"name":"dataInicio","in":"query","description":"Data de Emissão da Devolução Início (YYYY-MM-DD)","required":false,"schema":{"type":"string","nullable":true}},{"name":"dataFim","in":"query","description":"Data de Emissão da Devolução Término (YYYY-MM-DD)","required":false,"schema":{"type":"string","nullable":true}},{"name":"clientes","in":"query","required":false,"description":"Lista de Códigos de Clientes","schema":{"type":"array","nullable":true,"items":{"type":"string"}}},{"name":"motivosDevolucao","in":"query","required":false,"description":"Lista de Códigos de Motivos de Devolução","schema":{"type":"array","nullable":true,"items":{"type":"string"}}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","required":false,"schema":{"type":"string","nullable":true}}]}}}} ``` ## PUT /devolucaoNota > Devolução Nota Fiscal ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Devolução Nota Fiscal","description":"devolucaoNota"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"NotaDevolucaoPut":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do Documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave de Acesso NF-e/NFC-e","minLength":44},"serieFiscal":{"type":"integer","maximum":999,"description":"Código da Série Fiscal"},"parametroDevolucao":{"type":"integer","maximum":999,"description":"Código do Parâmetro da Devolução"},"motivoDevolucao":{"type":"integer","minimum":1,"maximum":99,"description":"Código do Motivo da Devolução"},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProduto","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do Item da Devolução"},"codProduto":{"type":"string","description":"Código do Produto (Reduzido do item)"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade a ser Devolvida"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço Unitário Liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Total Líquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do Desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Isenta"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Outras"},"cstICMS":{"type":"string","maxLength":3,"description":"Código da Situação Tributária - ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de Frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base ICMS Substituição Tributária"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor ICMS Substituição Tributária"},"outrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Outras Despesas"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de Emissão da Nota Devolvida (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"string","maxLength":20,"description":"Número da Nota Devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}},"paths":{"/devolucaoNota":{"put":{"summary":"Devolução Nota Fiscal","operationId":"DevolucaoNotaFiscal","deprecated":true,"tags":["Devolução Nota Fiscal"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Empresa para Importação da Devolução","required":true,"schema":{"type":"integer","minimum":1,"maximum":99999}}],"requestBody":{"description":"Nota Fiscal","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaDevolucaoPut"}}}}}}}} ``` # Romaneio Têxtil romaneioTextil ## GET /romaneioTextil > Obtem Listagem de Romaneios Têxtil ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Romaneio Têxtil","description":"romaneioTextil"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaRomaneio":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Romaneio"}}}},"Romaneio":{"type":"object","properties":{"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codPedido":{"type":"string","description":"Código do Pedido"},"loteProducao":{"type":"string","description":"Lote de Produção"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"percComissao":{"type":"number","maximum":999.99,"multipleOf":0.01,"description":"Percentual de Comissão"},"codVencimento1":{"type":"string","description":"Vencimento dias"},"codVencimento2":{"type":"string","description":"Vencimento dias"},"codVencimento3":{"type":"string","description":"Vencimento dias"},"codVencimento4":{"type":"string","description":"Vencimento dias"},"codVencimento5":{"type":"string","description":"Vencimento dias"},"codVencimento6":{"type":"string","description":"Vencimento dias"},"codVencimento7":{"type":"string","description":"Vencimento dias"},"codVencimento8":{"type":"string","description":"Vencimento dias"},"codVencimento9":{"type":"string","description":"Vencimento dias"},"codVencimento10":{"type":"string","description":"Vencimento dias"},"codVencimento11":{"type":"string","description":"Vencimento dias"},"codVencimento12":{"type":"string","description":"Vencimento dias"},"codVencimento13":{"type":"string","description":"Vencimento dias"},"codVencimento14":{"type":"string","description":"Vencimento dias"},"codVencimento15":{"type":"string","description":"Vencimento dias"},"codVencimento16":{"type":"string","description":"Vencimento dias"},"codVencimento17":{"type":"string","description":"Vencimento dias"},"codVencimento18":{"type":"string","description":"Vencimento dias"},"desconto1":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto2":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto3":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto4":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"dataPrevisaoFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codRedespacho":{"type":"integer","description":"Código Redespacho"},"tipoFreteTransportadora":{"type":"integer","description":"Tipo de Frete da Transportadora"},"situacao":{"type":"integer","description":"Situação do Romaneio (1 - Digitado, 2 - Listado, 3 - Encerrado, 4 - Baixado)","enum":[1,2,3,4]},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor total do Romaneio"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso líquido do Romaneio"},"dataEncerramento":{"type":"string","format":"date","description":"Data Encerramento"},"condicaoVenda":{"type":"integer","description":"Código da Condição de Venda"},"tipoFreteRedespacho":{"type":"integer","description":"Tipo de Frete Redespacho"},"cancelarSaldo":{"type":"boolean","description":"Cancelar Saldo do Romaneio"},"observacao":{"type":"string","description":"Observação Romaneio"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimo1":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo2":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo3":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo4":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"qtdVolumes":{"type":"number"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Romaneio"},"tipoNota":{"type":"integer","description":"Tipo de Nota Fiscal (Quando Romaneio sem Pedido)"},"consumidorProprio":{"type":"boolean","description":"Consumidor Próprio (Quando Romaneio sem Pedido)"},"codPortador":{"type":"integer","description":"Código do Portador (Quando Romaneio sem Pedido)"},"tipoCobranca":{"type":"integer","description":"Tipo de Cobrança (Quando Romaneio sem Pedido)"},"localExpedicao":{"type":"string","description":"Localização na Expedição"},"nomeOperador":{"type":"string","description":"Operador da Liberação para Partidas"},"bloqComercial":{"type":"string","description":"Bloqueado pelo Comercial clientes vips"},"tabelaPreco":{"type":"string","description":"Código da Tabela de Preço"},"itens":{"type":"array","description":"Itens do Romaneio","items":{"$ref":"#/components/schemas/ItemRomaneio"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemRomaneio":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do produto (item filho)"},"codCor":{"type":"string","description":"Código da Cor do Produto"},"precoUnitario":{"type":"number","description":"Preço Unitário"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso Bruto"},"numeroEtiqueta":{"type":"integer","description":"Número da Etiqueta Sequência"},"alteracaoManual":{"type":"boolean","description":"Alteração Manual"},"ordemProducao":{"type":"string","description":"Código da Ordem de Produção"},"qtdVolumesPesado":{"type":"number","description":"Quantidade de Volumes Pesado"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréscimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","multipleOf":0.01,"description":"Acréscimo do Item"},"descontoCapa":{"type":"number","multipleOf":0.01,"description":"Desconto Proporcional da Capa"},"etiquetaAcabado":{"type":"integer","description":"Código da Etiqueta do Produto Acabado"},"precoUnitarioMT":{"type":"number","multipleOf":0.01,"description":"Preço Unitário Multi Tabela"},"cancelaSaldoPedido":{"type":"boolean","description":"Cancelar Saldo do Pedido"},"codQualidade":{"type":"integer","description":"Código da Qualidade"},"itemPedido":{"type":"integer","description":"Código do Item do Pedido"},"statusEtiqueta":{"type":"integer","description":"Status Original da Etiqueta"},"nomeOperador":{"type":"string","description":"Nome do Operador na Montagem do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/romaneioTextil":{"get":{"summary":"Obtem Listagem de Romaneios Têxtil","operationId":"ObterListaRomaneio","tags":["Romaneio Têxtil"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaRomaneio"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"continuationToken","in":"query","required":false,"description":"Identificador de Paginação da Consulta","schema":{"type":"string","nullable":true}},{"name":"dataEmissaoInicio","in":"query","required":false,"description":"Data de Emissão Inicial (YYYY-MM-DD)","schema":{"type":"string","format":"date","nullable":true}},{"name":"dataEmissaoFim","in":"query","required":false,"description":"Data de Emissão Fim (YYYY-MM-DD)","schema":{"type":"string","format":"date","nullable":true}},{"name":"situacao","in":"query","required":false,"description":"Lista de Situação de Romaneios (0 - Digitado, 1 - Listado, 2 - Encerrado, 3 - Faturado, 4 - Baixado)","schema":{"type":"array","nullable":true,"items":{"type":"integer","enum":[0,1,2,3,4]}}},{"name":"pedido","in":"query","required":false,"description":"Lista de Pedidos","schema":{"type":"array","nullable":true,"items":{"type":"string"}}}]}}}} ``` ## GET /romaneioTextil/{codRomaneio} > Obtem Romaneio Têxtil ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Romaneio Têxtil","description":"romaneioTextil"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Romaneio":{"type":"object","properties":{"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codPedido":{"type":"string","description":"Código do Pedido"},"loteProducao":{"type":"string","description":"Lote de Produção"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"percComissao":{"type":"number","maximum":999.99,"multipleOf":0.01,"description":"Percentual de Comissão"},"codVencimento1":{"type":"string","description":"Vencimento dias"},"codVencimento2":{"type":"string","description":"Vencimento dias"},"codVencimento3":{"type":"string","description":"Vencimento dias"},"codVencimento4":{"type":"string","description":"Vencimento dias"},"codVencimento5":{"type":"string","description":"Vencimento dias"},"codVencimento6":{"type":"string","description":"Vencimento dias"},"codVencimento7":{"type":"string","description":"Vencimento dias"},"codVencimento8":{"type":"string","description":"Vencimento dias"},"codVencimento9":{"type":"string","description":"Vencimento dias"},"codVencimento10":{"type":"string","description":"Vencimento dias"},"codVencimento11":{"type":"string","description":"Vencimento dias"},"codVencimento12":{"type":"string","description":"Vencimento dias"},"codVencimento13":{"type":"string","description":"Vencimento dias"},"codVencimento14":{"type":"string","description":"Vencimento dias"},"codVencimento15":{"type":"string","description":"Vencimento dias"},"codVencimento16":{"type":"string","description":"Vencimento dias"},"codVencimento17":{"type":"string","description":"Vencimento dias"},"codVencimento18":{"type":"string","description":"Vencimento dias"},"desconto1":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto2":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto3":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto4":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"dataPrevisaoFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codRedespacho":{"type":"integer","description":"Código Redespacho"},"tipoFreteTransportadora":{"type":"integer","description":"Tipo de Frete da Transportadora"},"situacao":{"type":"integer","description":"Situação do Romaneio (1 - Digitado, 2 - Listado, 3 - Encerrado, 4 - Baixado)","enum":[1,2,3,4]},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor total do Romaneio"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso líquido do Romaneio"},"dataEncerramento":{"type":"string","format":"date","description":"Data Encerramento"},"condicaoVenda":{"type":"integer","description":"Código da Condição de Venda"},"tipoFreteRedespacho":{"type":"integer","description":"Tipo de Frete Redespacho"},"cancelarSaldo":{"type":"boolean","description":"Cancelar Saldo do Romaneio"},"observacao":{"type":"string","description":"Observação Romaneio"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimo1":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo2":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo3":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo4":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"qtdVolumes":{"type":"number"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Romaneio"},"tipoNota":{"type":"integer","description":"Tipo de Nota Fiscal (Quando Romaneio sem Pedido)"},"consumidorProprio":{"type":"boolean","description":"Consumidor Próprio (Quando Romaneio sem Pedido)"},"codPortador":{"type":"integer","description":"Código do Portador (Quando Romaneio sem Pedido)"},"tipoCobranca":{"type":"integer","description":"Tipo de Cobrança (Quando Romaneio sem Pedido)"},"localExpedicao":{"type":"string","description":"Localização na Expedição"},"nomeOperador":{"type":"string","description":"Operador da Liberação para Partidas"},"bloqComercial":{"type":"string","description":"Bloqueado pelo Comercial clientes vips"},"tabelaPreco":{"type":"string","description":"Código da Tabela de Preço"},"itens":{"type":"array","description":"Itens do Romaneio","items":{"$ref":"#/components/schemas/ItemRomaneio"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemRomaneio":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do produto (item filho)"},"codCor":{"type":"string","description":"Código da Cor do Produto"},"precoUnitario":{"type":"number","description":"Preço Unitário"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso Bruto"},"numeroEtiqueta":{"type":"integer","description":"Número da Etiqueta Sequência"},"alteracaoManual":{"type":"boolean","description":"Alteração Manual"},"ordemProducao":{"type":"string","description":"Código da Ordem de Produção"},"qtdVolumesPesado":{"type":"number","description":"Quantidade de Volumes Pesado"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréscimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","multipleOf":0.01,"description":"Acréscimo do Item"},"descontoCapa":{"type":"number","multipleOf":0.01,"description":"Desconto Proporcional da Capa"},"etiquetaAcabado":{"type":"integer","description":"Código da Etiqueta do Produto Acabado"},"precoUnitarioMT":{"type":"number","multipleOf":0.01,"description":"Preço Unitário Multi Tabela"},"cancelaSaldoPedido":{"type":"boolean","description":"Cancelar Saldo do Pedido"},"codQualidade":{"type":"integer","description":"Código da Qualidade"},"itemPedido":{"type":"integer","description":"Código do Item do Pedido"},"statusEtiqueta":{"type":"integer","description":"Status Original da Etiqueta"},"nomeOperador":{"type":"string","description":"Nome do Operador na Montagem do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/romaneioTextil/{codRomaneio}":{"get":{"summary":"Obtem Romaneio Têxtil","operationId":"ObterRomaneio","tags":["Romaneio Têxtil"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Romaneio"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"codRomaneio","in":"path","required":true,"description":"Código do Romaneio","schema":{"type":"string"}}]}}}} ``` # Lista De Transporte listaTransporte ## GET /listaTransporte/{id} > Obtem Lista de Transporte ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Lista de Transporte","description":"listaTransporte"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaTransporte":{"type":"object","properties":{"codListaTransporte":{"type":"integer","description":"Código da Lista de Transporte"},"situacao":{"type":"integer","description":"Código da Situação de Lista de Transporte"},"descSituacao":{"type":"string","description":"Descrição da Situação da Lista de Transporte"},"codTransportadora":{"type":"integer","description":"Código da Transportadora da Lista de Transporte"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora da Lista de Transporte"},"notasFiscaisListaTransp":{"type":"array","items":{"$ref":"#/components/schemas/notaFiscalListaTransporte"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"notaFiscalListaTransporte":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal"},"notaFiscal":{"type":"string","description":"Código da Nota Fiscal"},"qtdTotalVolume":{"type":"integer","description":"Quantidade Total de Volumes da Nota Fiscal"},"qtdVolumeSaldo":{"type":"integer","description":"Quantidade de Volumes Pendentes para Conferência"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/listaTransporte/{id}":{"get":{"summary":"Obtem Lista de Transporte","operationId":"ObterListaTransporte","tags":["Lista de Transporte"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTransporte"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Código da Lista de Transporte","schema":{"type":"string"}}]}}}} ``` ## POST /listaTransporte/{id}/conferencia > Conferência da Lista de Transporte ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Lista de Transporte","description":"listaTransporte"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ConferenciaEtqListaTransporte":{"type":"object","properties":{"qtdVolumePendenteEtqRom":{"type":"integer","description":"Quantidade de volumes pendentes de conferência da etiqueta de romaneio"},"ListaTransporte":{"$ref":"#/components/schemas/ListaTransporte"}}},"ListaTransporte":{"type":"object","properties":{"codListaTransporte":{"type":"integer","description":"Código da Lista de Transporte"},"situacao":{"type":"integer","description":"Código da Situação de Lista de Transporte"},"descSituacao":{"type":"string","description":"Descrição da Situação da Lista de Transporte"},"codTransportadora":{"type":"integer","description":"Código da Transportadora da Lista de Transporte"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora da Lista de Transporte"},"notasFiscaisListaTransp":{"type":"array","items":{"$ref":"#/components/schemas/notaFiscalListaTransporte"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"notaFiscalListaTransporte":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal"},"notaFiscal":{"type":"string","description":"Código da Nota Fiscal"},"qtdTotalVolume":{"type":"integer","description":"Quantidade Total de Volumes da Nota Fiscal"},"qtdVolumeSaldo":{"type":"integer","description":"Quantidade de Volumes Pendentes para Conferência"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"EtiquetasConfListaTransporte":{"type":"object","required":["etiquetaVolume","etiquetaRomaneio"],"properties":{"etiquetaVolume":{"type":"string","description":"Código da Etiqueta de Volume da Nota Fiscal da Lista de Transporte"},"etiquetaRomaneio":{"type":"string","description":"Código da Etiqueta do Romaneio da Nota Fiscal da Lista de Transporte"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}},"paths":{"/listaTransporte/{id}/conferencia":{"post":{"summary":"Conferência da Lista de Transporte","operationId":"ConferirEtiquetasListaTransporte","tags":["Lista de Transporte"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConferenciaEtqListaTransporte"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Código da Lista de Transporte","schema":{"type":"string"}}],"requestBody":{"description":"Código da Lista de Transporte","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EtiquetasConfListaTransporte"}}}}}}}} ``` ## POST /listaTransporte/{id}/encerrar > Encerra Conferência da Lista de Transporte ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Lista de Transporte","description":"listaTransporte"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaTransporte":{"type":"object","properties":{"codListaTransporte":{"type":"integer","description":"Código da Lista de Transporte"},"situacao":{"type":"integer","description":"Código da Situação de Lista de Transporte"},"descSituacao":{"type":"string","description":"Descrição da Situação da Lista de Transporte"},"codTransportadora":{"type":"integer","description":"Código da Transportadora da Lista de Transporte"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora da Lista de Transporte"},"notasFiscaisListaTransp":{"type":"array","items":{"$ref":"#/components/schemas/notaFiscalListaTransporte"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"notaFiscalListaTransporte":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal"},"notaFiscal":{"type":"string","description":"Código da Nota Fiscal"},"qtdTotalVolume":{"type":"integer","description":"Quantidade Total de Volumes da Nota Fiscal"},"qtdVolumeSaldo":{"type":"integer","description":"Quantidade de Volumes Pendentes para Conferência"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/listaTransporte/{id}/encerrar":{"post":{"summary":"Encerra Conferência da Lista de Transporte","operationId":"EncerrarConferenciaListaTransporte","tags":["Lista de Transporte"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTransporte"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Código da Lista de Transporte","schema":{"type":"string"}}]}}}} ``` # Models ## The NotaDevolucao object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"NotaDevolucao":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do Documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave de Acesso NF-e/NFC-e","minLength":44},"serieFiscal":{"type":"integer","maximum":999,"description":"Código da Série Fiscal"},"parametroDevolucao":{"type":"integer","maximum":999,"description":"Código do Parâmetro da Devolução"},"motivoDevolucao":{"type":"integer","minimum":1,"maximum":99,"description":"Código do Motivo da Devolução"},"notasDevolvidas":{"type":"array","description":"Notas Fiscais Devolvidas","items":{"$ref":"#/components/schemas/NotasDevolvidasDev"}},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucaoGet"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NotasDevolvidasDev":{"type":"object","properties":{"dataNotaDev":{"type":"string","description":"Data da Nota Fiscal Devolvida"},"codNotaDev":{"type":"integer","description":"Código da Nota Fical Devolvida"}}},"ItensDevolucaoGet":{"type":"object","properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do Item da Devolução"},"codProduto":{"type":"string","description":"Código do Produto (Reduzido do item)"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade a ser Devolvida"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço Unitário Liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Total Líquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do Desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Isenta"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Outras"},"cstICMS":{"type":"string","maxLength":3,"description":"Código da Situação Tributária - ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de Frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base ICMS Substituição Tributária"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor ICMS Substituição Tributária"},"outrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Outras Despesas"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaDevolucaoPut object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"NotaDevolucaoPut":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do Documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave de Acesso NF-e/NFC-e","minLength":44},"serieFiscal":{"type":"integer","maximum":999,"description":"Código da Série Fiscal"},"parametroDevolucao":{"type":"integer","maximum":999,"description":"Código do Parâmetro da Devolução"},"motivoDevolucao":{"type":"integer","minimum":1,"maximum":99,"description":"Código do Motivo da Devolução"},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProduto","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do Item da Devolução"},"codProduto":{"type":"string","description":"Código do Produto (Reduzido do item)"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade a ser Devolvida"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço Unitário Liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Total Líquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do Desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Isenta"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Outras"},"cstICMS":{"type":"string","maxLength":3,"description":"Código da Situação Tributária - ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de Frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base ICMS Substituição Tributária"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor ICMS Substituição Tributária"},"outrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Outras Despesas"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de Emissão da Nota Devolvida (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"string","maxLength":20,"description":"Número da Nota Devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItensDevolucao object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProduto","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do Item da Devolução"},"codProduto":{"type":"string","description":"Código do Produto (Reduzido do item)"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade a ser Devolvida"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço Unitário Liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Total Líquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do Desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Isenta"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Outras"},"cstICMS":{"type":"string","maxLength":3,"description":"Código da Situação Tributária - ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de Frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base ICMS Substituição Tributária"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor ICMS Substituição Tributária"},"outrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Outras Despesas"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de Emissão da Nota Devolvida (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"string","maxLength":20,"description":"Número da Nota Devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItensDevolucaoGet object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItensDevolucaoGet":{"type":"object","properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do Item da Devolução"},"codProduto":{"type":"string","description":"Código do Produto (Reduzido do item)"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade a ser Devolvida"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço Unitário Liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Total Líquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do Desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Isenta"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Outras"},"cstICMS":{"type":"string","maxLength":3,"description":"Código da Situação Tributária - ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de Frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base ICMS Substituição Tributária"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor ICMS Substituição Tributária"},"outrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Outras Despesas"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaNotasDevolucao object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ListaNotasDevolucao":{"type":"object","properties":{"continuationToken":{"type":"string"},"notasDevolucao":{"type":"array","description":"Notas de Devolução","items":{"$ref":"#/components/schemas/NotaDevolucao"}}}},"NotaDevolucao":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do Documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave de Acesso NF-e/NFC-e","minLength":44},"serieFiscal":{"type":"integer","maximum":999,"description":"Código da Série Fiscal"},"parametroDevolucao":{"type":"integer","maximum":999,"description":"Código do Parâmetro da Devolução"},"motivoDevolucao":{"type":"integer","minimum":1,"maximum":99,"description":"Código do Motivo da Devolução"},"notasDevolvidas":{"type":"array","description":"Notas Fiscais Devolvidas","items":{"$ref":"#/components/schemas/NotasDevolvidasDev"}},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucaoGet"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NotasDevolvidasDev":{"type":"object","properties":{"dataNotaDev":{"type":"string","description":"Data da Nota Fiscal Devolvida"},"codNotaDev":{"type":"integer","description":"Código da Nota Fical Devolvida"}}},"ItensDevolucaoGet":{"type":"object","properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do Item da Devolução"},"codProduto":{"type":"string","description":"Código do Produto (Reduzido do item)"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade a ser Devolvida"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço Unitário Liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Total Líquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do Desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Isenta"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Outras"},"cstICMS":{"type":"string","maxLength":3,"description":"Código da Situação Tributária - ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de Frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base ICMS Substituição Tributária"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor ICMS Substituição Tributária"},"outrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Outras Despesas"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotasDevolvidasDev object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"NotasDevolvidasDev":{"type":"object","properties":{"dataNotaDev":{"type":"string","description":"Data da Nota Fiscal Devolvida"},"codNotaDev":{"type":"integer","description":"Código da Nota Fical Devolvida"}}}}}} ``` ## The PedidoAutomacao object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"PedidoAutomacao":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The PedidoVenda object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}}}}} ``` ## The ItemPedido object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}}}}} ``` ## The ItemPedidoGrade object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItemDadosMalharia object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}}}}} ``` ## The ListaPedidosVenda object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ListaPedidosVenda":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PedidoVenda"}}}},"PedidoVenda":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente do Pedido de Venda"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota do Pedido de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante do Pedido de Venda"},"percComissRep":{"type":"number","description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","description":"Primeiro Desconto"},"desconto2":{"type":"number","description":"Segundo Desconto"},"desconto3":{"type":"number","description":"Terceiro Desconto"},"desconto4":{"type":"number","description":"Quarto Desconto"},"desconto5":{"type":"number","description":"Quinto Desconto"},"desconto6":{"type":"number","description":"Sexto Desconto"},"acrescimo1":{"type":"number","description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","description":"Observação para a Seleção de Faturamento"},"situacao":{"type":"string","description":"Situação do Pedido (0 - Digitado, 1 - Listado, 2 - Liberado, 3 - Selecionado Parcial, 4 - Selecionado Total, 5 - Faturado Parcial, 6 - Faturado Total, 7 - Transmitido, 8 - Bloqueado, 9 - Cancelado)"},"nomeLocalEntrega":{"type":"string","description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"ibgeCidadeLocalEntrega":{"type":"integer","description":"IBGE da Cidade do Local de Entrega"},"bairroLocalEntrega":{"type":"string","description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string"},"inscEstLocalEntrega":{"type":"string"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"type":"array","description":"Dias de Vencimento Especial","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"vlrFrete":{"type":"number","description":"Valor do Frete"},"vlrSeguro":{"type":"number","description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"dataUltConvME":{"type":"string","format":"date","description":"Última data de conversão/atualização de pedido em moeda estrangeira (YYYY-MM-DD)"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","description":"Código da Prioridade"},"codEtapa":{"type":"integer","description":"Código da Etapa do Pedido"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","description":"Valor Outras Despesas"},"libFin":{"type":"boolean","description":"Liberado Financeiro"},"flgBloqCredito":{"type":"boolean","description":"Pedido Bloqueado por Crédito"},"flgBloqComercial":{"type":"boolean","description":"Pedido Bloqueado pelo Comercial"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","description":"Nome do Operador do Sistema"},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedido"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedTint":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido de Venda"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number","description":"Quantidade do Produto Cancelada"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","description":"Percentual de Comissão do Representante para o Produto"},"descontoItem":{"type":"number","description":"Desconto do Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto do Produto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acrésimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","description":"Código da Finalidade"},"percIpi":{"type":"number","description":"Percentual IPI do Produto"},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"descricaoComplem1":{"type":"string","description":"Descrição Complementar"},"descricaoComplem2":{"type":"string","description":"Descrição Complementar"},"descricaoComplem3":{"type":"string","description":"Descrição Complementar"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortmento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"possuiPunho":{"type":"string","description":"Situação Punho (S - Tem Punho, N - Não tem Punho)"},"punhoItem":{"type":"integer","description":"Número do Item Pai Quando tem Punho"},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGrade"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalharia"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGrade":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código do Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade do Produto no Pedido"},"qtdFaturada":{"type":"number","description":"Quantidade do Produto já Faturada"},"qtdCancelada":{"type":"number"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemDadosMalharia":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)"},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)"},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)"},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}}}}} ``` ## The PedidoVendaPut object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"PedidoVendaPut":{"type":"object","required":["codCliente","codTipoNF","dataPrevisaoFaturamento","codTabelaPreco","itensPedido","unidadeMonetaria","codRepresentante"],"properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codTipoNF":{"type":"integer","description":"Código do Tipo de Nota"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"percComissRep":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","multipleOf":0.01,"description":"Primeiro Desconto"},"desconto2":{"type":"number","multipleOf":0.01,"description":"Segundo Desconto"},"desconto3":{"type":"number","multipleOf":0.01,"description":"Terceiro Desconto"},"desconto4":{"type":"number","multipleOf":0.01,"description":"Quarto Desconto"},"desconto5":{"type":"number","multipleOf":0.01,"description":"Quinto Desconto"},"desconto6":{"type":"number","multipleOf":0.01,"description":"Sexto Desconto"},"acrescimo1":{"type":"number","multipleOf":0.01,"description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","multipleOf":0.01,"description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","multipleOf":0.01,"description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","multipleOf":0.01,"description":"Quarto Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Venda (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","maxLength":1000,"description":"Observação para a Seleção de Faturamento"},"nomeLocalEntrega":{"type":"string","maxLength":35,"description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","maxLength":60,"description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"bairroLocalEntrega":{"type":"string","maxLength":60,"description":"Bairro do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string","maxLength":15,"description":"Inscrição Estadual do Local de Entrega"},"inscEstLocalEntrega":{"type":"string","maxLength":17,"description":"Inscrição Estadual do Local de Entrega"},"nomeOperador":{"type":"string","maxLength":40,"description":"Nome do Operador do Sistemas"},"codOperador":{"type":"integer","description":"Código do Operador do Sistemas"},"complementoLocalEntrega":{"type":"string","maxLength":60,"description":"Complemento do Local de Entrega"},"codTabelaPreco":{"type":"integer","description":"Código da Tabela de Preço"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"description":"Dias de Vencimento Especial (Obrigatório para condição de venda 99)","type":"array","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"codTipoFreteCons":{"type":"integer","description":"Código do Tipo de Frete da Transportadora Consignatária"},"vlrFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"vlrSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"codUnidMonetaria":{"type":"integer","description":"Código da Unidade Monetária"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","maximum":9,"description":"Código da Prioridade"},"codPedidoCliente":{"type":"string","description":"Código do Pedido do Cliente"},"codPedidoRep":{"type":"string","description":"Código do Pedido do Representante"},"vlrOutrasDesp":{"type":"number","multipleOf":0.01,"description":"Valor Outras Despesas"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso bruto da Quantidade Saldo do pedido"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido da Quantidade Saldo do pedido"},"codEstComercial":{"type":"string","maxLength":20,"description":"Código da Estrutura Comercial do Cliente"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"tipoPedidoMalConf":{"type":"integer","description":"Tipo do Pedido (1 - Malharia, 2 - Confecção)"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedidoPut"}},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedido":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoPut":{"type":"object","required":["codProduto","qtdPedida"],"properties":{"codProduto":{"description":"Código do Produto (Item Reduzido)","type":"string"},"qtdPedida":{"type":"number","description":"Quantidade Pedida do Produto"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","multipleOf":0.01,"description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Presentante no Produto"},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto para o Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","multipleOf":0.01,"description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acréscimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","maxLength":6,"description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","maxLength":6,"description":"Código da Finalidade"},"percIpi":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"incideDescontoCapa":{"type":"integer","description":"Incide Desconto da Capa Considerado Sobre este Item (0 - Não, 1 - Sim)"},"descricaoComplem1":{"type":"string","maxLength":35,"description":"Descrição Complementar DESCONTINUADO"},"descricaoComplem2":{"type":"string","maxLength":35,"description":"Descrição Complementar DESCONTINUADO"},"descricaoComplem3":{"type":"string","maxLength":35,"description":"Descrição Complementar DESCONTINUADO"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortimento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGradePut"}},"distTamanhosGrade":{"type":"array","description":"Distribuição de Quantidade por Tamanho","items":{"$ref":"#/components/schemas/ItemPedidoTamPut"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalhariaPut"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGradePut":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade Pedida do Produto"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemPedidoTamPut":{"type":"object","required":["codTamanho","qtdPedida"],"properties":{"codTamanho":{"type":"string","description":"Código do Tamanho a Ser Incluido no Pedido"},"qtdPedida":{"type":"number","multipleOf":0.001,"description":"Quantidade Pedida do Tamanho"}}},"ItemDadosMalhariaPut":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)","enum":[0,1]},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)","enum":[0,1]},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)","enum":[0,1]},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}}}}} ``` ## The ItemPedidoPut object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemPedidoPut":{"type":"object","required":["codProduto","qtdPedida"],"properties":{"codProduto":{"description":"Código do Produto (Item Reduzido)","type":"string"},"qtdPedida":{"type":"number","description":"Quantidade Pedida do Produto"},"precoUnit":{"type":"number","description":"Preço Unitário do Produto"},"precoUniSemICMS":{"type":"number","multipleOf":0.01,"description":"Preco Unitário sem ICMS, somente quando na Tabela Preço ICMS não incluso"},"percComissRepProd":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Presentante no Produto"},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto para o Produto"},"tipoDescontoItem":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","multipleOf":0.01,"description":"Acréscimo para o Produto"},"tipoAcrescimoItem":{"type":"integer","description":"Tipo de Acréscimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"codGrade":{"type":"integer","description":"Código da Grade do Produto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"itemPedidoCliente":{"type":"string","maxLength":6,"description":"Código do Item do Pedido do Cliente"},"itemPrevFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento do Item do Pedido (YYYY-MM-DD)"},"transEstoqueEst":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque do Item do Pedido"},"codFinalidade":{"type":"string","maxLength":6,"description":"Código da Finalidade"},"percIpi":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"incideDescontoCapa":{"type":"integer","description":"Incide Desconto da Capa Considerado Sobre este Item (0 - Não, 1 - Sim)"},"descricaoComplem1":{"type":"string","maxLength":35,"description":"Descrição Complementar DESCONTINUADO"},"descricaoComplem2":{"type":"string","maxLength":35,"description":"Descrição Complementar DESCONTINUADO"},"descricaoComplem3":{"type":"string","maxLength":35,"description":"Descrição Complementar DESCONTINUADO"},"descricaoComp1":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp2":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"descricaoComp3":{"type":"string","maxLength":35,"description":"Descrição Complementar"},"tipoSortimento":{"type":"integer","description":"Tipo do Sortimento do Produto (1 - Nenhuma, 2 - Por Cor, 3 - Por Cor/Tamanho, 4 - Por Seleção)","enum":[1,2,3,4]},"grade":{"type":"array","description":"Grades do Produto","items":{"$ref":"#/components/schemas/ItemPedidoGradePut"}},"distTamanhosGrade":{"type":"array","description":"Distribuição de Quantidade por Tamanho","items":{"$ref":"#/components/schemas/ItemPedidoTamPut"}},"dadosMalharia":{"$ref":"#/components/schemas/ItemDadosMalhariaPut"},"itemBrinde":{"type":"boolean","description":"Item do Pedido é Brinde"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemPedidoGradePut":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade Pedida do Produto"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ItemPedidoTamPut":{"type":"object","required":["codTamanho","qtdPedida"],"properties":{"codTamanho":{"type":"string","description":"Código do Tamanho a Ser Incluido no Pedido"},"qtdPedida":{"type":"number","multipleOf":0.001,"description":"Quantidade Pedida do Tamanho"}}},"ItemDadosMalhariaPut":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)","enum":[0,1]},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)","enum":[0,1]},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)","enum":[0,1]},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}}}}} ``` ## The ItemDadosMalhariaPut object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemDadosMalhariaPut":{"type":"object","properties":{"possuiGola":{"type":"integer","description":"Item Possui Gola? (0 - Não, 1 - Sim)","enum":[0,1]},"itemGola":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"percRibana":{"type":"number","multipleOf":0.01,"description":"Percentual de Ribana"},"possuiRibana":{"type":"integer","description":"Item Possui Ribana? (0 - Não, 1 - Sim)","enum":[0,1]},"itemRibana":{"type":"string","description":"Código do Item do Pedido para o Acessório"},"codRib":{"type":"string","description":"Código da Ribana"},"possuiPunho":{"type":"integer","description":"Item Possui Punho? (0 - Não, 1 - Sim)","enum":[0,1]},"itemPunho":{"type":"string","description":"Código do Item do Pedido para o Acessório"}}}}}} ``` ## The ItemPedidoGradePut object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemPedidoGradePut":{"type":"object","required":["codProdutoSKU","qtdPedida"],"properties":{"codProdutoSKU":{"type":"string","description":"Código Produto (SKU)"},"qtdPedida":{"type":"number","description":"Quantidade Pedida do Produto"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItemPedidoTamPut object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemPedidoTamPut":{"type":"object","required":["codTamanho","qtdPedida"],"properties":{"codTamanho":{"type":"string","description":"Código do Tamanho a Ser Incluido no Pedido"},"qtdPedida":{"type":"number","multipleOf":0.001,"description":"Quantidade Pedida do Tamanho"}}}}}} ``` ## The PedidoVendaUpdate object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"PedidoVendaUpdate":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codTipoNF":{"type":"integer","description":"Código do TIpo de Venda"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"percComissRep":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto1":{"type":"number","multipleOf":0.01,"description":"Primeiro Desconto"},"desconto2":{"type":"number","multipleOf":0.01,"description":"Segundo Desconto"},"desconto3":{"type":"number","multipleOf":0.01,"description":"Terceiro Desconto"},"desconto4":{"type":"number","multipleOf":0.01,"description":"Quarto Desconto"},"desconto5":{"type":"number","multipleOf":0.01,"description":"Quinto Desconto"},"desconto6":{"type":"number","multipleOf":0.01,"description":"Sexto Desconto"},"acrescimo1":{"type":"number","multipleOf":0.01,"description":"Primeiro Acréscimo"},"acrescimo2":{"type":"number","multipleOf":0.01,"description":"Segundo Acréscimo"},"acrescimo3":{"type":"number","multipleOf":0.01,"description":"Terceiro Acréscimo"},"acrescimo4":{"type":"number","multipleOf":0.01,"description":"Quarto Acréscimo"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Venda"},"observacaoSelecao":{"type":"string","maxLength":1000,"description":"Observação para a Seleção de Faturamento"},"nomeLocalEntrega":{"type":"string","maxLength":35,"description":"Nome do Local de Entrega"},"enderecoLocalEntrega":{"type":"string","maxLength":60,"description":"Endereço do Local de Entrega"},"numeroLocalEntrega":{"type":"string","description":"Número do Local de Entrega"},"cepLocalEntrega":{"type":"string","maxLength":8,"description":"CEP do Local de Entrega"},"bairroLocalEntrega":{"type":"string","maxLength":60,"description":"Bairro do Local de Entrega"},"complementoLocalEntrega":{"type":"string","maxLength":60,"description":"Complemento do Local de Entrega"},"cpfCnpjLocalEntrega":{"type":"string","maxLength":15,"description":"Inscrição Estadual do Local de Entrega"},"inscEstLocalEntrega":{"type":"string","maxLength":17,"description":"Inscrição Estadual do Local de Entrega"},"fatParcial":{"type":"string","maxLength":1,"description":"Permite Faturamento Parcial? (0 - Não, 1 - Sim)"},"bloqGeracaoRomParcial":{"type":"string","maxLength":1,"description":"Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)"},"nomeOperador":{"type":"string","maxLength":40,"description":"Nome do Operador do Sistemas"},"codCondVenda":{"type":"integer","description":"Condição de Venda"},"vencimentoEsp":{"description":"Dias de Vencimento Especial (Obrigatório para condição de venda 99)","type":"array","items":{"type":"string","format":"date"},"maxItems":18},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codConsignatario":{"type":"integer","description":"Código da Transportadora Consignatária"},"codTipoFreteTransp":{"type":"integer","description":"Código do Tipo de Frete da Transportadora"},"codTipoFreteCons":{"type":"integer","description":"Código do Tipo de Frete da Transportadora Consignatária"},"vlrFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"vlrSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"consumidorFinal":{"type":"boolean","description":"Consumidor Final"},"pedidoCliente":{"type":"string","description":"Pedido do Cliente"},"pedidoAutomacao":{"type":"string","description":"Pedido Automação"},"codAtendente":{"type":"string","description":"Código do Atendente"},"percComissAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Antendente"},"prioridade":{"type":"integer","maximum":9,"description":"Código da Prioridade"},"vlrOutrasDesp":{"type":"number","multipleOf":0.01,"description":"Valor Outras Despesas"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codEstComercial":{"type":"string","maxLength":20,"description":"Código da Estrutura Comercial do Cliente"},"codTipoAtend":{"type":"string","description":"Tipo de atendimento"},"tipoPedido":{"type":"integer","description":"Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)","enum":[1,2,3]},"codLoteVenda":{"type":"integer","description":"Código do Lote"},"dataEntregaProducao":{"type":"string","format":"date","description":"Data de Entrega para Produção (YYYY-MM-DD)"},"dataEntregaPedido":{"type":"string","format":"date","description":"Data de Entrega do Pedido para o Cliente (YYYY-MM-DD)"},"bloqFaturamentoParcial":{"type":"boolean","description":"Bloqueia Faturamento Parcial do Pedido"},"bloqFaturamentoAntecipado":{"type":"boolean","description":"Bloqueia Faturamento Antecipado do Pedido. Com Base na Data de Previsão de Faturamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCancelamentoPedido object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"DadosCancelamentoPedido":{"type":"object","required":["codMotivo"],"properties":{"codMotivo":{"type":"integer","description":"Código do Motivo do Cancelamento"},"nomeUsuarioCancelamento":{"type":"string","description":"Nome do Usuário do Cancelamento"}}}}}} ``` ## The DadosItensPedidoCancelamento object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"DadosItensPedidoCancelamento":{"type":"object","required":["codMotivo"],"properties":{"codMotivo":{"type":"integer","description":"Código do Motivo do Cancelamento"},"itensPedido":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItemPedidoCancelamento"}}}},"ItemPedidoCancelamento":{"type":"object","required":["seqItem","qtdCancelamento"],"properties":{"seqItem":{"description":"Sequência do Item","type":"string"},"qtdCancelamento":{"type":"number","description":"Quantidade Cancelamento Produto do Pedido"},"observacao":{"maxLength":1000,"description":"Observação"}}}}}} ``` ## The ItemPedidoCancelamento object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemPedidoCancelamento":{"type":"object","required":["seqItem","qtdCancelamento"],"properties":{"seqItem":{"description":"Sequência do Item","type":"string"},"qtdCancelamento":{"type":"number","description":"Quantidade Cancelamento Produto do Pedido"},"observacao":{"maxLength":1000,"description":"Observação"}}}}}} ``` ## The SomaPedidoAberto object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"SomaPedidoAberto":{"type":"object","properties":{"qtdTotal":{"type":"number","multipleOf":0.01,"description":"Quantidade Total DESCONTINUADO"},"qtdTotalPedidos":{"type":"number","multipleOf":0.001,"description":"Quantidade Total Pedidos em Aberto"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total"}}}}}} ``` ## The PedVendaAnaliseFiscal object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"PedVendaAnaliseFiscal":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido"},"itensPedido":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItPedAnaliseFiscal"}}}},"ItPedAnaliseFiscal":{"type":"object","required":["codItem"],"properties":{"itemPedido":{"type":"number","multipleOf":0.01,"description":"Código Sequencial"},"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"cfop":{"type":"string","description":"CFOP"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total"},"desconto":{"type":"number","multipleOf":0.01,"description":"Valor Desconto"},"acrescimo":{"type":"number","multipleOf":0.01,"description":"Valor Acrescimo"},"reducaoICMS":{"type":"number","multipleOf":0.01,"description":"Perc. Redução do ICMS"},"baseICMS":{"type":"number","multipleOf":0.01,"description":"Valor Base do ICMS"},"aliquotaICMS":{"type":"number","multipleOf":0.01,"description":"Valor da Aliquota do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"valorICMSisentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"despesasAcessorias":{"type":"number","multipleOf":0.01,"description":"Valor Despesas Acessórias"},"baseIPI":{"type":"number","multipleOf":0.01,"description":"Valor da Base IPI"},"aliquotaIPI":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota IPI"},"aliquotaIPI2":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota IPI"},"valoIPIdespAces":{"type":"number","multipleOf":0.01,"description":"Valor do IPI sobre Despesas Acessórias"},"baseICMSst":{"type":"number","multipleOf":0.01,"description":"Valor Base ICMS - ST"},"aliquotaICMSst":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota ICMS - ST"},"valorICMSst":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS - ST"},"mvaICMSst":{"type":"number","multipleOf":0.01,"description":"Valor MVA ICMS - ST"},"reducaoICMSst":{"type":"number","multipleOf":0.01,"description":"Valor da Redução ICMS - ST"},"desICMSzonaFran":{"type":"number","multipleOf":0.01,"description":"Valor Desconto ICMS Zona Franca"},"desPISzonaFran":{"type":"number","multipleOf":0.01,"description":"Valor Desconto PIS Zona Franca"},"desCOFINSzonaFran":{"type":"number","multipleOf":0.01,"description":"Valor Desconto COFINS Zona Franca"},"icmsCobradoOpAnt":{"type":"boolean","description":"Valor ICMS Cobrado em Operação Anterior (1 - Sim, Nulo - Não)"},"baseicmsUFdest":{"type":"number","multipleOf":0.01,"description":"ICMS Base UF Destino"},"icmsAliquoFCP":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Aliquota FCP"},"icmsAliqIntDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Aliquota Interna UF Destino"},"icmsAliqInterestadual":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Aliquota Interestadual"},"icmsInteres":{"type":"number","multipleOf":0.01,"description":"Valor Perc. Prov. Part. ICMS Interestadual"},"icmsFCP":{"type":"number","multipleOf":0.01,"description":"ICMS Valor FCP"},"icmsUFdest":{"type":"number","multipleOf":0.01,"description":"ICMS Valor UF Destino"},"icmsUFreme":{"type":"number","multipleOf":0.01,"description":"ICMS Valor UF Remetente"},"percReducao":{"type":"number","multipleOf":0.01,"description":"Redução BC!ICMS DIFAL"},"codNCM":{"type":"string","description":"Código NCM"},"codCEST":{"type":"string","description":"Código CEST"},"percFECOEP":{"type":"number","multipleOf":0.01,"description":"Percentual FECOEP"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base PIS"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota PIS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor PIS"},"baseCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor Base COFINS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor Alíquota COFINS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor COFINS"},"valorFCPfecoepST":{"type":"number","multipleOf":0.01,"description":"Valor FCP FECOEP ST"},"valorPercFCP43":{"type":"number","multipleOf":0.01,"description":"Valor/Percentual FCP ICMS Normal"},"valorPercFCP44":{"type":"number","multipleOf":0.01,"description":"Valor/Percentual FCP ICMS Normal"},"materiaPrima":{"type":"number","multipleOf":0.01,"description":"Materia Prima"},"valorSTNaoDestacado":{"type":"number","multipleOf":0.01,"description":"Valor ST Não Destacado"},"valorFCPSTNaoDestacado":{"type":"number","multipleOf":0.01,"description":"Valor FCPST Não Destacado"},"cstICMS":{"type":"string","description":"CST ICMS"},"cstPIS":{"type":"string","description":"CST PIS"},"cstCOFINS":{"type":"string","description":"CST COFINS"},"uniMed":{"type":"string","description":"Unidade de Medida"},"quantItem":{"type":"number","multipleOf":0.01,"description":"Quantidade de Item"},"valLiqOP":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Operação"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItPedAnaliseFiscal object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItPedAnaliseFiscal":{"type":"object","required":["codItem"],"properties":{"itemPedido":{"type":"number","multipleOf":0.01,"description":"Código Sequencial"},"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"cfop":{"type":"string","description":"CFOP"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total"},"desconto":{"type":"number","multipleOf":0.01,"description":"Valor Desconto"},"acrescimo":{"type":"number","multipleOf":0.01,"description":"Valor Acrescimo"},"reducaoICMS":{"type":"number","multipleOf":0.01,"description":"Perc. Redução do ICMS"},"baseICMS":{"type":"number","multipleOf":0.01,"description":"Valor Base do ICMS"},"aliquotaICMS":{"type":"number","multipleOf":0.01,"description":"Valor da Aliquota do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"valorICMSisentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"despesasAcessorias":{"type":"number","multipleOf":0.01,"description":"Valor Despesas Acessórias"},"baseIPI":{"type":"number","multipleOf":0.01,"description":"Valor da Base IPI"},"aliquotaIPI":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota IPI"},"aliquotaIPI2":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota IPI"},"valoIPIdespAces":{"type":"number","multipleOf":0.01,"description":"Valor do IPI sobre Despesas Acessórias"},"baseICMSst":{"type":"number","multipleOf":0.01,"description":"Valor Base ICMS - ST"},"aliquotaICMSst":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota ICMS - ST"},"valorICMSst":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS - ST"},"mvaICMSst":{"type":"number","multipleOf":0.01,"description":"Valor MVA ICMS - ST"},"reducaoICMSst":{"type":"number","multipleOf":0.01,"description":"Valor da Redução ICMS - ST"},"desICMSzonaFran":{"type":"number","multipleOf":0.01,"description":"Valor Desconto ICMS Zona Franca"},"desPISzonaFran":{"type":"number","multipleOf":0.01,"description":"Valor Desconto PIS Zona Franca"},"desCOFINSzonaFran":{"type":"number","multipleOf":0.01,"description":"Valor Desconto COFINS Zona Franca"},"icmsCobradoOpAnt":{"type":"boolean","description":"Valor ICMS Cobrado em Operação Anterior (1 - Sim, Nulo - Não)"},"baseicmsUFdest":{"type":"number","multipleOf":0.01,"description":"ICMS Base UF Destino"},"icmsAliquoFCP":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Aliquota FCP"},"icmsAliqIntDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Aliquota Interna UF Destino"},"icmsAliqInterestadual":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Aliquota Interestadual"},"icmsInteres":{"type":"number","multipleOf":0.01,"description":"Valor Perc. Prov. Part. ICMS Interestadual"},"icmsFCP":{"type":"number","multipleOf":0.01,"description":"ICMS Valor FCP"},"icmsUFdest":{"type":"number","multipleOf":0.01,"description":"ICMS Valor UF Destino"},"icmsUFreme":{"type":"number","multipleOf":0.01,"description":"ICMS Valor UF Remetente"},"percReducao":{"type":"number","multipleOf":0.01,"description":"Redução BC!ICMS DIFAL"},"codNCM":{"type":"string","description":"Código NCM"},"codCEST":{"type":"string","description":"Código CEST"},"percFECOEP":{"type":"number","multipleOf":0.01,"description":"Percentual FECOEP"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base PIS"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Valor Aliquota PIS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor PIS"},"baseCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor Base COFINS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor Alíquota COFINS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor COFINS"},"valorFCPfecoepST":{"type":"number","multipleOf":0.01,"description":"Valor FCP FECOEP ST"},"valorPercFCP43":{"type":"number","multipleOf":0.01,"description":"Valor/Percentual FCP ICMS Normal"},"valorPercFCP44":{"type":"number","multipleOf":0.01,"description":"Valor/Percentual FCP ICMS Normal"},"materiaPrima":{"type":"number","multipleOf":0.01,"description":"Materia Prima"},"valorSTNaoDestacado":{"type":"number","multipleOf":0.01,"description":"Valor ST Não Destacado"},"valorFCPSTNaoDestacado":{"type":"number","multipleOf":0.01,"description":"Valor FCPST Não Destacado"},"cstICMS":{"type":"string","description":"CST ICMS"},"cstPIS":{"type":"string","description":"CST PIS"},"cstCOFINS":{"type":"string","description":"CST COFINS"},"uniMed":{"type":"string","description":"Unidade de Medida"},"quantItem":{"type":"number","multipleOf":0.01,"description":"Quantidade de Item"},"valLiqOP":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Operação"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaFiscalSaida object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"NotaFiscalSaida":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","description":"Código Numérico da Nota"},"serie":{"type":"integer","description":"Série da Nota Fiscal"},"codTipoDeNota":{"type":"integer","description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"marca":{"type":"string","description":"Marca"},"numeroVolume":{"type":"string","description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","description":"Identificador de controle do envio do lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalSaida":{"type":"object","required":["codItem"],"properties":{"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"qtdFaturada":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Produto"},"precoUnitario":{"type":"number","multipleOf":0.01,"description":"Preço Unitário do Produto"},"valorItem":{"type":"number","multipleOf":0.01,"description":"Valor do Item"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorDesconto":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto"},"codItemPedido":{"type":"integer","maximum":99,"description":"Código do Item do Pedido de Venda"},"codClassifFiscal":{"type":"string","maxLength":10,"description":"Código da Classificação Fiscal do Produto"},"codGrupo":{"type":"string","maxLength":2,"description":"Código do Grupo"},"percICMS":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"percICMSSubst":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS Substituto"},"valorICMSSubstituto":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"margemLucro":{"type":"number","multipleOf":0.01,"description":"Margem de Lucro para o Produto"},"percReducICMS":{"type":"number","multipleOf":0.01,"description":"Percentual da Redução do ICMS"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido do Produto"},"codSitTributICMS":{"type":"string","minLength":3,"maxLength":3,"description":"Código da Situação Tributária do ICMS"},"percIPI":{"type":"number","multipleOf":0.01,"description":"Percentual do IPI"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação do Produto"},"vlrDescICMSZonaFranca":{"type":"number","multipleOf":0.01,"description":"Desconto ICMS Zona Franca de Manaus"},"baseCalcICMS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS"},"baseCalcICMSIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Isenta"},"baseCalcICMSOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Outra"},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"baseCalcIPIIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Isenta"},"baseCalcIPIOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Outra"},"codSitTributIPI":{"type":"string","minLength":2,"maxLength":2,"description":"Código da Situação Tributária do IPI"},"valorDescNaoIncideICMS":{"type":"number","multipleOf":0.01,"description":"Valor de Desconto Não Incide do ICMS"},"baseCalcSTPIS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST PIS"},"valorSTPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST PIS"},"baseCalcSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST COFINS"},"valorSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST COFINS"},"valorFreteProp":{"type":"number","multipleOf":0.01,"description":"Valor de Frete Proporcional"},"valorSeguroProp":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro Proporcional"},"valorDespAcesProp":{"type":"number","multipleOf":0.01,"description":"Valor Despesa Acessória Proporcional"},"valorPISProp":{"type":"number","multipleOf":0.01,"description":"Valor PIS Proporcional"},"valorCOFINSProp":{"type":"number","multipleOf":0.01,"description":"Valor COFINS Proporcional"},"percPIS":{"type":"number","multipleOf":0.01,"description":"Percentual do PIS"},"percCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual do COFINS"},"baseCalcICMSSubst":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo ICMS Substituto"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorIPIDescAcess":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Sobre as Despesas Acessórias"},"situaICMS":{"type":"integer","description":"Situação do ICMS (0 - Isento, 1 - Tributado, 2 - Outros)","enum":[0,1,2]},"codCSTPis":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST PIS"},"codCSTCofins":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST COFINS"},"valorBaseSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor da Base de ICMS-ST Retido em Operação Anterior"},"valorSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS-ST Retido em Operação Anterior"},"perCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito do ICMS"},"valorCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito do ICMS"},"perReducaoPis":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do PIS"},"perReducaoCofins":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do COFINS"},"valorDiferencaPis":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do PIS"},"valorDiferencaCofins":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do COFINS"},"reducaoBaseIcmsST":{"type":"number","multipleOf":0.01,"description":"Valor Redução da Base do ICMS ST"},"codCSTCSOSN":{"type":"string","maxLength":3,"description":"Código CSOSN Regime Tributário Simples Nacional"},"numeroPedidoCompra":{"type":"string","maxLength":15,"description":"Código do Pedido de Compra"},"itemPedidoCompra":{"type":"integer","maximum":999999,"description":"Item do Pedido de Compra"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Alíquota PIS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Alíquota COFINS"},"valorDespesasBaseIcms":{"type":"number","multipleOf":0.01,"description":"Valor de Despesas da Base do ICMS"},"codEnquadramentoIPI":{"type":"integer","maximum":999,"description":"Código do Enquadramento do IPI"},"baseICMSUFDestino":{"type":"number","multipleOf":0.01,"description":"Valor da BC do ICMS na UF de Destino"},"percFCP":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"aliqUFDest":{"type":"number","multipleOf":0.01,"description":"Alíquota Interna da UF de Destino"},"aliICMSInt":{"type":"number","multipleOf":0.01,"description":"Alíquota Interestadual das UF Envolvidas"},"valorICMSInterestUFDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Interestadual no UF Destino"},"valorFCP":{"type":"number","multipleOf":0.01,"description":"Valor relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"valorDescPropTroca":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Proporcional da Troca"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorAcrescimo":{"type":"number","multipleOf":0.01,"description":"Valor do Acréscimo"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"percComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"cBenef":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal da Operação"},"cCredPresumido":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal do Crédito Presumido (TTD)"},"pCredPresumido":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito Presumido (TTD)"},"vCredPresumido":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito Presumido (TTD)"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"itemPedidoAgrupado":{"type":"array","items":{"$ref":"#/components/schemas/PedidoAgrupadoItemNf"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaFiscalSaidaPut object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"NotaFiscalSaidaPut":{"type":"object","required":["dataEmissao","codNumNota"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","maximum":9999999,"description":"Código Numérico da Nota"},"codTipoDeNota":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitida, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","maxLength":7,"description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","maximum":9999,"description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","maximum":9999999,"description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","maxLength":10,"description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","maximum":99999,"description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","maxLength":10,"description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","maxLength":10,"description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"marca":{"type":"string","maxLength":13,"description":"Marca"},"numeroVolume":{"type":"string","maxLength":10,"description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","maxLength":35,"description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","maxLength":35,"description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","maxLength":35,"description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","minLength":44,"maxLength":44,"description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","maxLength":15,"description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","maxLength":3,"description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","maxLength":7,"description":"Identificador de Controle do Envio do Lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","maxLength":15,"description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","maxLength":3,"description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","maxLength":50,"description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"CEPEntrega":{"type":"string","maxLength":8,"description":"CEP da Entrega"},"codCondicaoVenda":{"type":"integer","description":"Código da Condição de Venda"},"msgNotaFiscal":{"type":"string","maxLength":1000,"description":"Mensagem para a Nota Fiscal"},"valorBaseCalcIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor de Base de Cálculo IPI Isentas"},"valorBaseCalcIPIOutras":{"type":"number","multipleOf":0.01,"description":"Valor de Base de Cálculo IPI Outras"},"valorICMSOutras":{"type":"number","multipleOf":0.01,"description":"Valor de Base de Cálculo ICMS Outras"},"baseCalcComisRep":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"percComissao":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissao":{"type":"number","multipleOf":0.01,"description":"Valor da Comissão do Representante"},"valorDescontoEspecialCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial da Capa"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"duplicatas":{"type":"array","description":"Duplicatas da Nota Fiscal","items":{"$ref":"#/components/schemas/duplicataNF"}},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"duplicataNF":{"type":"object","required":["tipoPagamento","dataEmissao","qtdParcela","parcelaDuplicataNF"],"properties":{"tipoPagamento":{"type":"string","description":"Tipo de Pagamento (Boleto / Cartão))","enum":["boleto","cartao"]},"dataEmissao":{"type":"string","format":"date","description":"Data da Emissão da Duplicata (YYYY-MM-DD)"},"qtdParcela":{"type":"integer","minimum":1,"description":"Quantidade de Parcelas"},"codPortador":{"type":"integer","description":"Código do Portador"},"tipoCobranca":{"type":"integer","description":"Tipo de Cobrança"},"condicaoVenda":{"type":"integer","description":"Condição de Venda"},"parcela":{"type":"array","description":"Dados das Parcelas","items":{"$ref":"#/components/schemas/parcelaDuplicataNF"}}}},"parcelaDuplicataNF":{"type":"object","required":["valor","dataVencimento"],"properties":{"valor":{"type":"number","multipleOf":0.01,"description":"Valor da Parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento da Parcela (YYYY-MM-DD)"},"dataPagamento":{"type":"string","format":"date","description":"Data do Pagamento da Parcela (YYYY-MM-DD)"},"numeroBancario":{"type":"string","description":"Número do Banco"},"codAutorizacao":{"type":"string","description":"Código de Autorização"},"codNSU":{"type":"string","description":"Código do Número Sequencial Único"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"}}},"ItemNotaFiscalSaida":{"type":"object","required":["codItem"],"properties":{"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"qtdFaturada":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Produto"},"precoUnitario":{"type":"number","multipleOf":0.01,"description":"Preço Unitário do Produto"},"valorItem":{"type":"number","multipleOf":0.01,"description":"Valor do Item"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorDesconto":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto"},"codItemPedido":{"type":"integer","maximum":99,"description":"Código do Item do Pedido de Venda"},"codClassifFiscal":{"type":"string","maxLength":10,"description":"Código da Classificação Fiscal do Produto"},"codGrupo":{"type":"string","maxLength":2,"description":"Código do Grupo"},"percICMS":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"percICMSSubst":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS Substituto"},"valorICMSSubstituto":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"margemLucro":{"type":"number","multipleOf":0.01,"description":"Margem de Lucro para o Produto"},"percReducICMS":{"type":"number","multipleOf":0.01,"description":"Percentual da Redução do ICMS"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido do Produto"},"codSitTributICMS":{"type":"string","minLength":3,"maxLength":3,"description":"Código da Situação Tributária do ICMS"},"percIPI":{"type":"number","multipleOf":0.01,"description":"Percentual do IPI"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação do Produto"},"vlrDescICMSZonaFranca":{"type":"number","multipleOf":0.01,"description":"Desconto ICMS Zona Franca de Manaus"},"baseCalcICMS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS"},"baseCalcICMSIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Isenta"},"baseCalcICMSOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Outra"},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"baseCalcIPIIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Isenta"},"baseCalcIPIOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Outra"},"codSitTributIPI":{"type":"string","minLength":2,"maxLength":2,"description":"Código da Situação Tributária do IPI"},"valorDescNaoIncideICMS":{"type":"number","multipleOf":0.01,"description":"Valor de Desconto Não Incide do ICMS"},"baseCalcSTPIS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST PIS"},"valorSTPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST PIS"},"baseCalcSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST COFINS"},"valorSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST COFINS"},"valorFreteProp":{"type":"number","multipleOf":0.01,"description":"Valor de Frete Proporcional"},"valorSeguroProp":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro Proporcional"},"valorDespAcesProp":{"type":"number","multipleOf":0.01,"description":"Valor Despesa Acessória Proporcional"},"valorPISProp":{"type":"number","multipleOf":0.01,"description":"Valor PIS Proporcional"},"valorCOFINSProp":{"type":"number","multipleOf":0.01,"description":"Valor COFINS Proporcional"},"percPIS":{"type":"number","multipleOf":0.01,"description":"Percentual do PIS"},"percCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual do COFINS"},"baseCalcICMSSubst":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo ICMS Substituto"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorIPIDescAcess":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Sobre as Despesas Acessórias"},"situaICMS":{"type":"integer","description":"Situação do ICMS (0 - Isento, 1 - Tributado, 2 - Outros)","enum":[0,1,2]},"codCSTPis":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST PIS"},"codCSTCofins":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST COFINS"},"valorBaseSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor da Base de ICMS-ST Retido em Operação Anterior"},"valorSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS-ST Retido em Operação Anterior"},"perCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito do ICMS"},"valorCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito do ICMS"},"perReducaoPis":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do PIS"},"perReducaoCofins":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do COFINS"},"valorDiferencaPis":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do PIS"},"valorDiferencaCofins":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do COFINS"},"reducaoBaseIcmsST":{"type":"number","multipleOf":0.01,"description":"Valor Redução da Base do ICMS ST"},"codCSTCSOSN":{"type":"string","maxLength":3,"description":"Código CSOSN Regime Tributário Simples Nacional"},"numeroPedidoCompra":{"type":"string","maxLength":15,"description":"Código do Pedido de Compra"},"itemPedidoCompra":{"type":"integer","maximum":999999,"description":"Item do Pedido de Compra"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Alíquota PIS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Alíquota COFINS"},"valorDespesasBaseIcms":{"type":"number","multipleOf":0.01,"description":"Valor de Despesas da Base do ICMS"},"codEnquadramentoIPI":{"type":"integer","maximum":999,"description":"Código do Enquadramento do IPI"},"baseICMSUFDestino":{"type":"number","multipleOf":0.01,"description":"Valor da BC do ICMS na UF de Destino"},"percFCP":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"aliqUFDest":{"type":"number","multipleOf":0.01,"description":"Alíquota Interna da UF de Destino"},"aliICMSInt":{"type":"number","multipleOf":0.01,"description":"Alíquota Interestadual das UF Envolvidas"},"valorICMSInterestUFDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Interestadual no UF Destino"},"valorFCP":{"type":"number","multipleOf":0.01,"description":"Valor relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"valorDescPropTroca":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Proporcional da Troca"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorAcrescimo":{"type":"number","multipleOf":0.01,"description":"Valor do Acréscimo"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"percComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"cBenef":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal da Operação"},"cCredPresumido":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal do Crédito Presumido (TTD)"},"pCredPresumido":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito Presumido (TTD)"},"vCredPresumido":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito Presumido (TTD)"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"itemPedidoAgrupado":{"type":"array","items":{"$ref":"#/components/schemas/PedidoAgrupadoItemNf"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The duplicataNF object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"duplicataNF":{"type":"object","required":["tipoPagamento","dataEmissao","qtdParcela","parcelaDuplicataNF"],"properties":{"tipoPagamento":{"type":"string","description":"Tipo de Pagamento (Boleto / Cartão))","enum":["boleto","cartao"]},"dataEmissao":{"type":"string","format":"date","description":"Data da Emissão da Duplicata (YYYY-MM-DD)"},"qtdParcela":{"type":"integer","minimum":1,"description":"Quantidade de Parcelas"},"codPortador":{"type":"integer","description":"Código do Portador"},"tipoCobranca":{"type":"integer","description":"Tipo de Cobrança"},"condicaoVenda":{"type":"integer","description":"Condição de Venda"},"parcela":{"type":"array","description":"Dados das Parcelas","items":{"$ref":"#/components/schemas/parcelaDuplicataNF"}}}},"parcelaDuplicataNF":{"type":"object","required":["valor","dataVencimento"],"properties":{"valor":{"type":"number","multipleOf":0.01,"description":"Valor da Parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento da Parcela (YYYY-MM-DD)"},"dataPagamento":{"type":"string","format":"date","description":"Data do Pagamento da Parcela (YYYY-MM-DD)"},"numeroBancario":{"type":"string","description":"Número do Banco"},"codAutorizacao":{"type":"string","description":"Código de Autorização"},"codNSU":{"type":"string","description":"Código do Número Sequencial Único"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"}}}}}} ``` ## The parcelaDuplicataNF object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"parcelaDuplicataNF":{"type":"object","required":["valor","dataVencimento"],"properties":{"valor":{"type":"number","multipleOf":0.01,"description":"Valor da Parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento da Parcela (YYYY-MM-DD)"},"dataPagamento":{"type":"string","format":"date","description":"Data do Pagamento da Parcela (YYYY-MM-DD)"},"numeroBancario":{"type":"string","description":"Número do Banco"},"codAutorizacao":{"type":"string","description":"Código de Autorização"},"codNSU":{"type":"string","description":"Código do Número Sequencial Único"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"}}}}}} ``` ## The ListaNotasFiscaisSaida object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ListaNotasFiscaisSaida":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/NotaFiscalSaida"}}}},"NotaFiscalSaida":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal (YYYY-MM-DD)"},"codNumNota":{"type":"integer","description":"Código Numérico da Nota"},"serie":{"type":"integer","description":"Série da Nota Fiscal"},"codTipoDeNota":{"type":"integer","description":"Código do Tipo de Nota"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"percDesconto":{"type":"number","multipleOf":0.01,"description":"Percentual de Desconto"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Valor do Frete"},"valorSeguro":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro"},"valorLiquido":{"type":"number","multipleOf":0.01,"description":"Valor Liquido da Nota Fiscal"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor Total da Nota Fiscal"},"valorDescNormal":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Normal"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação"},"situacao":{"type":"integer","description":"Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)","enum":[1,2,3]},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"valorICMSnaoPagoReduc":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS não Pago Redução"},"valorICMSSubstit":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"valorICMSIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Isentas"},"valorIPIIsentas":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Isentas"},"valorOutrasDespesas":{"type":"number","multipleOf":0.01,"description":"Valor de Outras Despesas"},"baseICMSSubs":{"type":"number","multipleOf":0.01,"description":"Base do ICMS Substituto"},"deducICMSNFManaus":{"type":"number","multipleOf":0.01,"description":"Dedução do ICMS para Manaus"},"percISS":{"type":"number","multipleOf":0.01,"description":"Percentual do ISS"},"valorISS":{"type":"number","multipleOf":0.01,"description":"Valor do ISS"},"valorPIS":{"type":"number","multipleOf":0.01,"description":"Valor do PIS"},"valorCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor do COFINS"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"baseRetPIS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do PIS"},"valorRetPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do PIS"},"baseRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do COFINS"},"valorRetCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorDifAliq":{"type":"number","multipleOf":0.01,"description":"Valor diferença da Aliquota"},"baseRetCSSL":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do CSSL"},"valorRetCSSL":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do CSSL"},"baseRetIR":{"type":"number","multipleOf":0.01,"description":"Base de Retenção do IR"},"valorRetIR":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do IR"},"baseRet":{"type":"number","multipleOf":0.01,"description":"Base de Retenção"},"valorFECP":{"type":"number","multipleOf":0.01,"description":"Valor de Retenção do FECP"},"percRetencaoPIS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do PIS"},"percRetencaoCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do COFINS"},"percRetencaoCSSL":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do CSSL"},"percRetencaoIR":{"type":"number","multipleOf":0.01,"description":"Percentual de Retenção do IR"},"baseISS":{"type":"number","multipleOf":0.01,"description":"Base do ISS"},"valorReducaoISS":{"type":"number","multipleOf":0.01,"description":"Valor Redução do ISS"},"codCnae":{"type":"string","description":"Código do Cnae"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)","enum":[0,1,2,3,5,9]},"valFCP":{"type":"number","multipleOf":0.01,"description":"Valor do FCP"},"valICMSDest":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Interestadual para a UF de Destino"},"valICMSRem":{"type":"number","multipleOf":0.01,"description":"Valor total do ICMS Interestadual para a UF do Remetente"},"IPIDevol":{"type":"number","multipleOf":0.01,"description":"Valor total do IPI Devolvido"},"valorFCPST":{"type":"number","multipleOf":0.01,"description":"Valor do FCP/FECOEP do ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"description":"Valor FCP ICMS"},"tipoFrete":{"type":"integer","description":"Tipo de Frete"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"qtdVolumes":{"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"type":"string","description":"Espécie dos Volumes"},"dataHoraSaida":{"type":"string","format":"date-time","description":"Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)"},"codTabela":{"type":"integer","description":"Código da Tabela de Preço"},"placaVeiculo":{"type":"string","description":"Placa do Veículo"},"codEstPlacaVeic":{"type":"string","description":"Código do Estado da Placa do Veículo"},"consumidorFinal":{"type":"integer","description":"É para Consumidor Final? (0 - Não, 1 - Sim)","enum":[0,1]},"codPortador":{"type":"integer","description":"Código do Portador"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"marca":{"type":"string","description":"Marca"},"numeroVolume":{"type":"string","description":"Número do Volume"},"dataHoraGeracaoNF":{"type":"string","format":"date-time","description":"Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"obsCancNF1":{"type":"string","description":"Observação do Cancelamento da Nota Fiscal"},"obsCancNF2":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"obsCancNF3":{"type":"string","description":"Complemento da Observação do Cancelamento da Nota Fiscal"},"dataGeracao1":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)"},"chaveAcesso":{"type":"string","description":"Chave de acesso da NF-e"},"dataHoraNfe":{"type":"string","format":"date-time","description":"Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protNfe":{"type":"string","description":"Número do Protocolo da NF-e e NFS-e"},"statusNfe":{"type":"string","description":"Código do status da resposta para a NF-e e NFS-e"},"codLote":{"type":"string","description":"Identificador de controle do envio do lote da NFe"},"dataHoraDanfe":{"type":"string","format":"date-time","description":"Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)"},"dataHoraCancelaNfe":{"type":"string","format":"date-time","description":"Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)"},"protCancelaNfe":{"type":"string","description":"Número do Protocolo de Cancelamento da NF-e e NFS-e"},"statusCancelaNfe":{"type":"string","description":"Código do status do Cancelamento NF-e e NFS-e"},"tipoEmissaoNfe":{"type":"integer","description":"Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)","enum":[1,2,3,4,5,6,7]},"emailNfe":{"type":"string","description":"E-mail Destinatario que foi enviado arquivo distribuição NF-e"},"flagReplicado":{"type":"boolean","description":"Flag se foi Replicado"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Comissão do Representante"},"itensNotaFiscalSaida":{"type":"array","description":"Itens da Nota Fiscal","items":{"$ref":"#/components/schemas/ItemNotaFiscalSaida"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalSaida":{"type":"object","required":["codItem"],"properties":{"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"qtdFaturada":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Produto"},"precoUnitario":{"type":"number","multipleOf":0.01,"description":"Preço Unitário do Produto"},"valorItem":{"type":"number","multipleOf":0.01,"description":"Valor do Item"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorDesconto":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto"},"codItemPedido":{"type":"integer","maximum":99,"description":"Código do Item do Pedido de Venda"},"codClassifFiscal":{"type":"string","maxLength":10,"description":"Código da Classificação Fiscal do Produto"},"codGrupo":{"type":"string","maxLength":2,"description":"Código do Grupo"},"percICMS":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"percICMSSubst":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS Substituto"},"valorICMSSubstituto":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"margemLucro":{"type":"number","multipleOf":0.01,"description":"Margem de Lucro para o Produto"},"percReducICMS":{"type":"number","multipleOf":0.01,"description":"Percentual da Redução do ICMS"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido do Produto"},"codSitTributICMS":{"type":"string","minLength":3,"maxLength":3,"description":"Código da Situação Tributária do ICMS"},"percIPI":{"type":"number","multipleOf":0.01,"description":"Percentual do IPI"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação do Produto"},"vlrDescICMSZonaFranca":{"type":"number","multipleOf":0.01,"description":"Desconto ICMS Zona Franca de Manaus"},"baseCalcICMS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS"},"baseCalcICMSIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Isenta"},"baseCalcICMSOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Outra"},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"baseCalcIPIIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Isenta"},"baseCalcIPIOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Outra"},"codSitTributIPI":{"type":"string","minLength":2,"maxLength":2,"description":"Código da Situação Tributária do IPI"},"valorDescNaoIncideICMS":{"type":"number","multipleOf":0.01,"description":"Valor de Desconto Não Incide do ICMS"},"baseCalcSTPIS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST PIS"},"valorSTPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST PIS"},"baseCalcSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST COFINS"},"valorSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST COFINS"},"valorFreteProp":{"type":"number","multipleOf":0.01,"description":"Valor de Frete Proporcional"},"valorSeguroProp":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro Proporcional"},"valorDespAcesProp":{"type":"number","multipleOf":0.01,"description":"Valor Despesa Acessória Proporcional"},"valorPISProp":{"type":"number","multipleOf":0.01,"description":"Valor PIS Proporcional"},"valorCOFINSProp":{"type":"number","multipleOf":0.01,"description":"Valor COFINS Proporcional"},"percPIS":{"type":"number","multipleOf":0.01,"description":"Percentual do PIS"},"percCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual do COFINS"},"baseCalcICMSSubst":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo ICMS Substituto"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorIPIDescAcess":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Sobre as Despesas Acessórias"},"situaICMS":{"type":"integer","description":"Situação do ICMS (0 - Isento, 1 - Tributado, 2 - Outros)","enum":[0,1,2]},"codCSTPis":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST PIS"},"codCSTCofins":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST COFINS"},"valorBaseSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor da Base de ICMS-ST Retido em Operação Anterior"},"valorSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS-ST Retido em Operação Anterior"},"perCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito do ICMS"},"valorCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito do ICMS"},"perReducaoPis":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do PIS"},"perReducaoCofins":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do COFINS"},"valorDiferencaPis":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do PIS"},"valorDiferencaCofins":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do COFINS"},"reducaoBaseIcmsST":{"type":"number","multipleOf":0.01,"description":"Valor Redução da Base do ICMS ST"},"codCSTCSOSN":{"type":"string","maxLength":3,"description":"Código CSOSN Regime Tributário Simples Nacional"},"numeroPedidoCompra":{"type":"string","maxLength":15,"description":"Código do Pedido de Compra"},"itemPedidoCompra":{"type":"integer","maximum":999999,"description":"Item do Pedido de Compra"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Alíquota PIS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Alíquota COFINS"},"valorDespesasBaseIcms":{"type":"number","multipleOf":0.01,"description":"Valor de Despesas da Base do ICMS"},"codEnquadramentoIPI":{"type":"integer","maximum":999,"description":"Código do Enquadramento do IPI"},"baseICMSUFDestino":{"type":"number","multipleOf":0.01,"description":"Valor da BC do ICMS na UF de Destino"},"percFCP":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"aliqUFDest":{"type":"number","multipleOf":0.01,"description":"Alíquota Interna da UF de Destino"},"aliICMSInt":{"type":"number","multipleOf":0.01,"description":"Alíquota Interestadual das UF Envolvidas"},"valorICMSInterestUFDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Interestadual no UF Destino"},"valorFCP":{"type":"number","multipleOf":0.01,"description":"Valor relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"valorDescPropTroca":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Proporcional da Troca"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorAcrescimo":{"type":"number","multipleOf":0.01,"description":"Valor do Acréscimo"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"percComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"cBenef":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal da Operação"},"cCredPresumido":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal do Crédito Presumido (TTD)"},"pCredPresumido":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito Presumido (TTD)"},"vCredPresumido":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito Presumido (TTD)"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"itemPedidoAgrupado":{"type":"array","items":{"$ref":"#/components/schemas/PedidoAgrupadoItemNf"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItemNotaFiscalSaida object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemNotaFiscalSaida":{"type":"object","required":["codItem"],"properties":{"codItem":{"type":"integer","maximum":999999,"description":"Código do Item"},"codProduto":{"type":"string","maxLength":20,"description":"Código do Produto"},"qtdFaturada":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Produto"},"precoUnitario":{"type":"number","multipleOf":0.01,"description":"Preço Unitário do Produto"},"valorItem":{"type":"number","multipleOf":0.01,"description":"Valor do Item"},"valorIPI":{"type":"number","multipleOf":0.01,"description":"Valor do IPI"},"valorDesconto":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto"},"codItemPedido":{"type":"integer","maximum":99,"description":"Código do Item do Pedido de Venda"},"codClassifFiscal":{"type":"string","maxLength":10,"description":"Código da Classificação Fiscal do Produto"},"codGrupo":{"type":"string","maxLength":2,"description":"Código do Grupo"},"percICMS":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS"},"valorICMS":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS"},"percICMSSubst":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS Substituto"},"valorICMSSubstituto":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS Substituto"},"margemLucro":{"type":"number","multipleOf":0.01,"description":"Margem de Lucro para o Produto"},"percReducICMS":{"type":"number","multipleOf":0.01,"description":"Percentual da Redução do ICMS"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido do Produto"},"codSitTributICMS":{"type":"string","minLength":3,"maxLength":3,"description":"Código da Situação Tributária do ICMS"},"percIPI":{"type":"number","multipleOf":0.01,"description":"Percentual do IPI"},"codNatOperacao":{"type":"integer","maximum":99999,"description":"Código da Natureza de Operação do Produto"},"vlrDescICMSZonaFranca":{"type":"number","multipleOf":0.01,"description":"Desconto ICMS Zona Franca de Manaus"},"baseCalcICMS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS"},"baseCalcICMSIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Isenta"},"baseCalcICMSOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ICMS Outra"},"baseCalcIPI":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI"},"baseCalcIPIIsenta":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Isenta"},"baseCalcIPIOutra":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do IPI Outra"},"codSitTributIPI":{"type":"string","minLength":2,"maxLength":2,"description":"Código da Situação Tributária do IPI"},"valorDescNaoIncideICMS":{"type":"number","multipleOf":0.01,"description":"Valor de Desconto Não Incide do ICMS"},"baseCalcSTPIS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST PIS"},"valorSTPIS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST PIS"},"baseCalcSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo do ST COFINS"},"valorSTCOFINS":{"type":"number","multipleOf":0.01,"description":"Valor de Cálculo do ST COFINS"},"valorFreteProp":{"type":"number","multipleOf":0.01,"description":"Valor de Frete Proporcional"},"valorSeguroProp":{"type":"number","multipleOf":0.01,"description":"Valor do Seguro Proporcional"},"valorDespAcesProp":{"type":"number","multipleOf":0.01,"description":"Valor Despesa Acessória Proporcional"},"valorPISProp":{"type":"number","multipleOf":0.01,"description":"Valor PIS Proporcional"},"valorCOFINSProp":{"type":"number","multipleOf":0.01,"description":"Valor COFINS Proporcional"},"percPIS":{"type":"number","multipleOf":0.01,"description":"Percentual do PIS"},"percCOFINS":{"type":"number","multipleOf":0.01,"description":"Percentual do COFINS"},"baseCalcICMSSubst":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo ICMS Substituto"},"basePIS":{"type":"number","multipleOf":0.01,"description":"Base do PIS"},"baseCofins":{"type":"number","multipleOf":0.01,"description":"Base do COFINS"},"valorPISZF":{"type":"number","multipleOf":0.01,"description":"Valor do PISZF"},"valorCOFINSZF":{"type":"number","multipleOf":0.01,"description":"Valor do COFINSZF"},"valorIPIDescAcess":{"type":"number","multipleOf":0.01,"description":"Valor do IPI Sobre as Despesas Acessórias"},"situaICMS":{"type":"integer","description":"Situação do ICMS (0 - Isento, 1 - Tributado, 2 - Outros)","enum":[0,1,2]},"codCSTPis":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST PIS"},"codCSTCofins":{"type":"string","minLength":2,"maxLength":2,"description":"Código do CST COFINS"},"valorBaseSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor da Base de ICMS-ST Retido em Operação Anterior"},"valorSTRetAnt":{"type":"number","multipleOf":0.01,"description":"Valor do ICMS-ST Retido em Operação Anterior"},"perCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito do ICMS"},"valorCreditoIcms":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito do ICMS"},"perReducaoPis":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do PIS"},"perReducaoCofins":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do COFINS"},"valorDiferencaPis":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do PIS"},"valorDiferencaCofins":{"type":"number","multipleOf":0.01,"description":"Valor da Diferença do COFINS"},"reducaoBaseIcmsST":{"type":"number","multipleOf":0.01,"description":"Valor Redução da Base do ICMS ST"},"codCSTCSOSN":{"type":"string","maxLength":3,"description":"Código CSOSN Regime Tributário Simples Nacional"},"numeroPedidoCompra":{"type":"string","maxLength":15,"description":"Código do Pedido de Compra"},"itemPedidoCompra":{"type":"integer","maximum":999999,"description":"Item do Pedido de Compra"},"aliquotaPIS":{"type":"number","multipleOf":0.01,"description":"Alíquota PIS"},"aliquotaCOFINS":{"type":"number","multipleOf":0.01,"description":"Alíquota COFINS"},"valorDespesasBaseIcms":{"type":"number","multipleOf":0.01,"description":"Valor de Despesas da Base do ICMS"},"codEnquadramentoIPI":{"type":"integer","maximum":999,"description":"Código do Enquadramento do IPI"},"baseICMSUFDestino":{"type":"number","multipleOf":0.01,"description":"Valor da BC do ICMS na UF de Destino"},"percFCP":{"type":"number","multipleOf":0.01,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"aliqUFDest":{"type":"number","multipleOf":0.01,"description":"Alíquota Interna da UF de Destino"},"aliICMSInt":{"type":"number","multipleOf":0.01,"description":"Alíquota Interestadual das UF Envolvidas"},"valorICMSInterestUFDest":{"type":"number","multipleOf":0.01,"description":"Valor ICMS Interestadual no UF Destino"},"valorFCP":{"type":"number","multipleOf":0.01,"description":"Valor relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino"},"valorDescPropTroca":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Proporcional da Troca"},"valorDescEspecPropCapa":{"type":"number","multipleOf":0.01,"description":"Valor do Desconto Especial Proporcional Capa"},"valorAcrescimo":{"type":"number","multipleOf":0.01,"description":"Valor do Acréscimo"},"baseComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Atendente"},"percComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"valorComissaoAtendente":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Atendente"},"baseComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Base de Cálculo de Comissão do Representante"},"percComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"valorComissaoRepresentante":{"type":"number","multipleOf":0.01,"description":"Valor de Comissão do Representante"},"cBenef":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal da Operação"},"cCredPresumido":{"type":"string","minLength":8,"maxLength":10,"description":"Código Benefício Fiscal do Crédito Presumido (TTD)"},"pCredPresumido":{"type":"number","multipleOf":0.01,"description":"Percentual do Crédito Presumido (TTD)"},"vCredPresumido":{"type":"number","multipleOf":0.01,"description":"Valor do Crédito Presumido (TTD)"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"itemPedidoAgrupado":{"type":"array","items":{"$ref":"#/components/schemas/PedidoAgrupadoItemNf"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The PedidoAgrupadoItemNf object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"PedidoAgrupadoItemNf":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do pedido agrupado na nota fiscal"},"itemPedido":{"type":"integer","description":"Código do item do pedido agrupado na nota fiscal"},"qtdFaturadaItemPedido":{"type":"number","multipleOf":0.001,"description":"Quantidade Faturada do Item do Pedido"}}}}}} ``` ## The NotaFiscalDanfe object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"NotaFiscalDanfe":{"type":"object","properties":{"arquivo":{"type":"string","format":"byte","description":"Arquivo com a DANFE da Nota Fiscal"}}}}}} ``` ## The NotaFiscalXML object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"NotaFiscalXML":{"type":"object","properties":{"arquivo":{"type":"string","format":"byte","description":"Arquivo com o XML da Nota Fiscal"}}}}}} ``` ## The NotaFiscalEvento object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"NotaFiscalEvento":{"type":"object","properties":{"arquivo":{"type":"string","format":"byte","description":"Obtem uma Nota Fiscal pelo ID do Evento"}}}}}} ``` ## The CaixaTagNotaFiscal object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"CaixaTagNotaFiscal":{"type":"object","properties":{"codCaixa":{"type":"string","description":"Código da Caixa"},"situacao":{"type":"integer","description":"Situação da Caixa (0 - Gerada/Listada, 1 - Encerrada, 2 - Faturada, 3 - Cancelada, 4 - Faturada em Quilo)","enum":[0,1,2,3,4]},"dataEmissaoNF":{"type":"string","format":"date","description":"Data da Emissão da Nota Fiscal (YYYY-MM-DD)"},"notaFiscal":{"type":"integer","description":"Código da Nota Fiscal"},"transportadora":{"type":"integer","description":"Código da Transportadora"},"codCliente":{"type":"integer","description":"Código do Cliente"},"tabelaPrecoKg":{"type":"integer","description":"Código da Tabela de Preço"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"codEmbalagem":{"type":"string","description":"Código da Embalagem"},"pedido":{"type":"array","description":"Pedidos de Venda","items":{"type":"string"}},"tag":{"type":"array","description":"Tags das peças da Caixa (Código de Barras)","items":{"$ref":"#/components/schemas/tagNF"}}}},"tagNF":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto da Tag"},"codTag":{"type":"string","description":"Código de Barras da Tag"}}}}}} ``` ## The EtiquetaMalhaTintoNotaFiscal object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"EtiquetaMalhaTintoNotaFiscal":{"type":"object","properties":{"dataEmissaoNF":{"type":"string","format":"date","description":"Data da Emissão da Nota Fiscal (YYYY-MM-DD)"},"notaFiscal":{"type":"integer","description":"Código da Nota Fiscal"},"itemNota":{"type":"integer","description":"Código do Item da Nota da Etiqueta"},"etiquetas":{"type":"array","description":"Etiquetas (Código de Barras)","items":{"$ref":"#/components/schemas/EtiquetasMalhaTintoNF"}}}},"EtiquetasMalhaTintoNF":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto da Etiqueta"},"codEtiqueta":{"type":"string","description":"Código de Barras da Etiqueta"}}}}}} ``` ## The EtiquetasMalhaTintoNF object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"EtiquetasMalhaTintoNF":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto da Etiqueta"},"codEtiqueta":{"type":"string","description":"Código de Barras da Etiqueta"}}}}}} ``` ## The tagNF object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"tagNF":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto da Tag"},"codTag":{"type":"string","description":"Código de Barras da Tag"}}}}}} ``` ## The ListaCaixaTagNotaFiscal object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ListaCaixaTagNotaFiscal":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CaixaTagNotaFiscal"}}}},"CaixaTagNotaFiscal":{"type":"object","properties":{"codCaixa":{"type":"string","description":"Código da Caixa"},"situacao":{"type":"integer","description":"Situação da Caixa (0 - Gerada/Listada, 1 - Encerrada, 2 - Faturada, 3 - Cancelada, 4 - Faturada em Quilo)","enum":[0,1,2,3,4]},"dataEmissaoNF":{"type":"string","format":"date","description":"Data da Emissão da Nota Fiscal (YYYY-MM-DD)"},"notaFiscal":{"type":"integer","description":"Código da Nota Fiscal"},"transportadora":{"type":"integer","description":"Código da Transportadora"},"codCliente":{"type":"integer","description":"Código do Cliente"},"tabelaPrecoKg":{"type":"integer","description":"Código da Tabela de Preço"},"pesoLiquido":{"type":"number","multipleOf":0.01,"description":"Peso Liquido"},"pesoBruto":{"type":"number","multipleOf":0.01,"description":"Peso Bruto"},"codEmbalagem":{"type":"string","description":"Código da Embalagem"},"pedido":{"type":"array","description":"Pedidos de Venda","items":{"type":"string"}},"tag":{"type":"array","description":"Tags das peças da Caixa (Código de Barras)","items":{"$ref":"#/components/schemas/tagNF"}}}},"tagNF":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto da Tag"},"codTag":{"type":"string","description":"Código de Barras da Tag"}}}}}} ``` ## The ListaEtiquetaMalhaTintoNotaFiscal object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ListaEtiquetaMalhaTintoNotaFiscal":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EtiquetaMalhaTintoNotaFiscal"}}}},"EtiquetaMalhaTintoNotaFiscal":{"type":"object","properties":{"dataEmissaoNF":{"type":"string","format":"date","description":"Data da Emissão da Nota Fiscal (YYYY-MM-DD)"},"notaFiscal":{"type":"integer","description":"Código da Nota Fiscal"},"itemNota":{"type":"integer","description":"Código do Item da Nota da Etiqueta"},"etiquetas":{"type":"array","description":"Etiquetas (Código de Barras)","items":{"$ref":"#/components/schemas/EtiquetasMalhaTintoNF"}}}},"EtiquetasMalhaTintoNF":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto da Etiqueta"},"codEtiqueta":{"type":"string","description":"Código de Barras da Etiqueta"}}}}}} ``` ## The SugestaoFatPedido object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"SugestaoFatPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"seqSugestao":{"type":"integer","description":"Código da Sequência da Sugestão de Faturamento"},"situacao":{"type":"integer","description":"Situação da Sugestão (0 - Gerada, 1 - Listada, 2 - Liberado para Conferência, 3 - Transferida, 4 - Exportada para Arquivo, 5 - Transferência, 6 - Em Reserva)","enum":[0,1,2,3,4,5,6]},"valorSugestao":{"type":"number","multipleOf":0.01,"description":"Valor da Sugestão de Faturamento"},"dataGeracao":{"type":"string","format":"date","description":"Data da Geração (YYYY-MM-DD)"},"dataHoraListagem":{"type":"string","format":"date-time","description":"Data e Hora da Listagem (YYYY-MM-DDTHH:mm:ss.sssZ)"},"bloqueadoFaturamento":{"type":"boolean","description":"Bloquado Faturamento? (0 - Não / 1 - Sim)"},"liberadoComQtdMenor":{"type":"boolean","description":"Liberado com Quantidade Menor? (0 - Não / 1 - Sim)"},"priorizar":{"type":"boolean","description":"Priorizar? (0 - Não / 1 - Sim)"},"dataSeparacao":{"type":"string","format":"date","description":"Data da Separação (YYYY-MM-DD)"},"horaGeracao":{"type":"string","description":"Hora da Separação"},"produto":{"type":"array","description":"Produtos da Sugestão","items":{"$ref":"#/components/schemas/ProdutoSugestaoFatPedido"}}}},"ProdutoSugestaoFatPedido":{"type":"object","properties":{"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdSugerida":{"type":"number","description":"Quantidade Sugerida para o Produto"},"qtdConferida":{"type":"number","description":"Quantidade Conferida para o Produto"},"caixa":{"type":"array","description":"Caixas da Sugestão","items":{"$ref":"#/components/schemas/CaixaSugestaoFatPedido"}}}},"CaixaSugestaoFatPedido":{"type":"object","properties":{"codCaixa":{"type":"string","description":"Código da Caixa"},"codTag":{"type":"array","description":"Tags da Caixa (Códigos de Barra)","items":{"type":"string"}}}}}}} ``` ## The ProdutoSugestaoFatPedido object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ProdutoSugestaoFatPedido":{"type":"object","properties":{"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdSugerida":{"type":"number","description":"Quantidade Sugerida para o Produto"},"qtdConferida":{"type":"number","description":"Quantidade Conferida para o Produto"},"caixa":{"type":"array","description":"Caixas da Sugestão","items":{"$ref":"#/components/schemas/CaixaSugestaoFatPedido"}}}},"CaixaSugestaoFatPedido":{"type":"object","properties":{"codCaixa":{"type":"string","description":"Código da Caixa"},"codTag":{"type":"array","description":"Tags da Caixa (Códigos de Barra)","items":{"type":"string"}}}}}}} ``` ## The CaixaSugestaoFatPedido object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"CaixaSugestaoFatPedido":{"type":"object","properties":{"codCaixa":{"type":"string","description":"Código da Caixa"},"codTag":{"type":"array","description":"Tags da Caixa (Códigos de Barra)","items":{"type":"string"}}}}}}} ``` ## The ListaSugestaoFatPedido object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ListaSugestaoFatPedido":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SugestaoFatPedido"}}}},"SugestaoFatPedido":{"type":"object","properties":{"codPedido":{"type":"string","description":"Código do Pedido de Venda"},"seqSugestao":{"type":"integer","description":"Código da Sequência da Sugestão de Faturamento"},"situacao":{"type":"integer","description":"Situação da Sugestão (0 - Gerada, 1 - Listada, 2 - Liberado para Conferência, 3 - Transferida, 4 - Exportada para Arquivo, 5 - Transferência, 6 - Em Reserva)","enum":[0,1,2,3,4,5,6]},"valorSugestao":{"type":"number","multipleOf":0.01,"description":"Valor da Sugestão de Faturamento"},"dataGeracao":{"type":"string","format":"date","description":"Data da Geração (YYYY-MM-DD)"},"dataHoraListagem":{"type":"string","format":"date-time","description":"Data e Hora da Listagem (YYYY-MM-DDTHH:mm:ss.sssZ)"},"bloqueadoFaturamento":{"type":"boolean","description":"Bloquado Faturamento? (0 - Não / 1 - Sim)"},"liberadoComQtdMenor":{"type":"boolean","description":"Liberado com Quantidade Menor? (0 - Não / 1 - Sim)"},"priorizar":{"type":"boolean","description":"Priorizar? (0 - Não / 1 - Sim)"},"dataSeparacao":{"type":"string","format":"date","description":"Data da Separação (YYYY-MM-DD)"},"horaGeracao":{"type":"string","description":"Hora da Separação"},"produto":{"type":"array","description":"Produtos da Sugestão","items":{"$ref":"#/components/schemas/ProdutoSugestaoFatPedido"}}}},"ProdutoSugestaoFatPedido":{"type":"object","properties":{"itemPedido":{"type":"integer","description":"Item do Pedido de Venda"},"codProduto":{"type":"string","description":"Código do Produto"},"qtdSugerida":{"type":"number","description":"Quantidade Sugerida para o Produto"},"qtdConferida":{"type":"number","description":"Quantidade Conferida para o Produto"},"caixa":{"type":"array","description":"Caixas da Sugestão","items":{"$ref":"#/components/schemas/CaixaSugestaoFatPedido"}}}},"CaixaSugestaoFatPedido":{"type":"object","properties":{"codCaixa":{"type":"string","description":"Código da Caixa"},"codTag":{"type":"array","description":"Tags da Caixa (Códigos de Barra)","items":{"type":"string"}}}}}}} ``` ## The ListaRomaneio object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ListaRomaneio":{"type":"object","properties":{"continuationToken":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Romaneio"}}}},"Romaneio":{"type":"object","properties":{"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codPedido":{"type":"string","description":"Código do Pedido"},"loteProducao":{"type":"string","description":"Lote de Produção"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"percComissao":{"type":"number","maximum":999.99,"multipleOf":0.01,"description":"Percentual de Comissão"},"codVencimento1":{"type":"string","description":"Vencimento dias"},"codVencimento2":{"type":"string","description":"Vencimento dias"},"codVencimento3":{"type":"string","description":"Vencimento dias"},"codVencimento4":{"type":"string","description":"Vencimento dias"},"codVencimento5":{"type":"string","description":"Vencimento dias"},"codVencimento6":{"type":"string","description":"Vencimento dias"},"codVencimento7":{"type":"string","description":"Vencimento dias"},"codVencimento8":{"type":"string","description":"Vencimento dias"},"codVencimento9":{"type":"string","description":"Vencimento dias"},"codVencimento10":{"type":"string","description":"Vencimento dias"},"codVencimento11":{"type":"string","description":"Vencimento dias"},"codVencimento12":{"type":"string","description":"Vencimento dias"},"codVencimento13":{"type":"string","description":"Vencimento dias"},"codVencimento14":{"type":"string","description":"Vencimento dias"},"codVencimento15":{"type":"string","description":"Vencimento dias"},"codVencimento16":{"type":"string","description":"Vencimento dias"},"codVencimento17":{"type":"string","description":"Vencimento dias"},"codVencimento18":{"type":"string","description":"Vencimento dias"},"desconto1":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto2":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto3":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto4":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"dataPrevisaoFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codRedespacho":{"type":"integer","description":"Código Redespacho"},"tipoFreteTransportadora":{"type":"integer","description":"Tipo de Frete da Transportadora"},"situacao":{"type":"integer","description":"Situação do Romaneio (1 - Digitado, 2 - Listado, 3 - Encerrado, 4 - Baixado)","enum":[1,2,3,4]},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor total do Romaneio"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso líquido do Romaneio"},"dataEncerramento":{"type":"string","format":"date","description":"Data Encerramento"},"condicaoVenda":{"type":"integer","description":"Código da Condição de Venda"},"tipoFreteRedespacho":{"type":"integer","description":"Tipo de Frete Redespacho"},"cancelarSaldo":{"type":"boolean","description":"Cancelar Saldo do Romaneio"},"observacao":{"type":"string","description":"Observação Romaneio"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimo1":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo2":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo3":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo4":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"qtdVolumes":{"type":"number"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Romaneio"},"tipoNota":{"type":"integer","description":"Tipo de Nota Fiscal (Quando Romaneio sem Pedido)"},"consumidorProprio":{"type":"boolean","description":"Consumidor Próprio (Quando Romaneio sem Pedido)"},"codPortador":{"type":"integer","description":"Código do Portador (Quando Romaneio sem Pedido)"},"tipoCobranca":{"type":"integer","description":"Tipo de Cobrança (Quando Romaneio sem Pedido)"},"localExpedicao":{"type":"string","description":"Localização na Expedição"},"nomeOperador":{"type":"string","description":"Operador da Liberação para Partidas"},"bloqComercial":{"type":"string","description":"Bloqueado pelo Comercial clientes vips"},"tabelaPreco":{"type":"string","description":"Código da Tabela de Preço"},"itens":{"type":"array","description":"Itens do Romaneio","items":{"$ref":"#/components/schemas/ItemRomaneio"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemRomaneio":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do produto (item filho)"},"codCor":{"type":"string","description":"Código da Cor do Produto"},"precoUnitario":{"type":"number","description":"Preço Unitário"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso Bruto"},"numeroEtiqueta":{"type":"integer","description":"Número da Etiqueta Sequência"},"alteracaoManual":{"type":"boolean","description":"Alteração Manual"},"ordemProducao":{"type":"string","description":"Código da Ordem de Produção"},"qtdVolumesPesado":{"type":"number","description":"Quantidade de Volumes Pesado"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréscimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","multipleOf":0.01,"description":"Acréscimo do Item"},"descontoCapa":{"type":"number","multipleOf":0.01,"description":"Desconto Proporcional da Capa"},"etiquetaAcabado":{"type":"integer","description":"Código da Etiqueta do Produto Acabado"},"precoUnitarioMT":{"type":"number","multipleOf":0.01,"description":"Preço Unitário Multi Tabela"},"cancelaSaldoPedido":{"type":"boolean","description":"Cancelar Saldo do Pedido"},"codQualidade":{"type":"integer","description":"Código da Qualidade"},"itemPedido":{"type":"integer","description":"Código do Item do Pedido"},"statusEtiqueta":{"type":"integer","description":"Status Original da Etiqueta"},"nomeOperador":{"type":"string","description":"Nome do Operador na Montagem do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Romaneio object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"Romaneio":{"type":"object","properties":{"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codPedido":{"type":"string","description":"Código do Pedido"},"loteProducao":{"type":"string","description":"Lote de Produção"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"percComissao":{"type":"number","maximum":999.99,"multipleOf":0.01,"description":"Percentual de Comissão"},"codVencimento1":{"type":"string","description":"Vencimento dias"},"codVencimento2":{"type":"string","description":"Vencimento dias"},"codVencimento3":{"type":"string","description":"Vencimento dias"},"codVencimento4":{"type":"string","description":"Vencimento dias"},"codVencimento5":{"type":"string","description":"Vencimento dias"},"codVencimento6":{"type":"string","description":"Vencimento dias"},"codVencimento7":{"type":"string","description":"Vencimento dias"},"codVencimento8":{"type":"string","description":"Vencimento dias"},"codVencimento9":{"type":"string","description":"Vencimento dias"},"codVencimento10":{"type":"string","description":"Vencimento dias"},"codVencimento11":{"type":"string","description":"Vencimento dias"},"codVencimento12":{"type":"string","description":"Vencimento dias"},"codVencimento13":{"type":"string","description":"Vencimento dias"},"codVencimento14":{"type":"string","description":"Vencimento dias"},"codVencimento15":{"type":"string","description":"Vencimento dias"},"codVencimento16":{"type":"string","description":"Vencimento dias"},"codVencimento17":{"type":"string","description":"Vencimento dias"},"codVencimento18":{"type":"string","description":"Vencimento dias"},"desconto1":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto2":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto3":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"desconto4":{"type":"number","multipleOf":0.01,"description":"Descontos Percentuais"},"dataPrevisaoFaturamento":{"type":"string","format":"date","description":"Data de Previsão de Faturamento"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codRedespacho":{"type":"integer","description":"Código Redespacho"},"tipoFreteTransportadora":{"type":"integer","description":"Tipo de Frete da Transportadora"},"situacao":{"type":"integer","description":"Situação do Romaneio (1 - Digitado, 2 - Listado, 3 - Encerrado, 4 - Baixado)","enum":[1,2,3,4]},"valorTotal":{"type":"number","multipleOf":0.01,"description":"Valor total do Romaneio"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso líquido do Romaneio"},"dataEncerramento":{"type":"string","format":"date","description":"Data Encerramento"},"condicaoVenda":{"type":"integer","description":"Código da Condição de Venda"},"tipoFreteRedespacho":{"type":"integer","description":"Tipo de Frete Redespacho"},"cancelarSaldo":{"type":"boolean","description":"Cancelar Saldo do Romaneio"},"observacao":{"type":"string","description":"Observação Romaneio"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimo1":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo2":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo3":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"acrescimo4":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"qtdVolumes":{"type":"number"},"valorFrete":{"type":"number","multipleOf":0.01,"description":"Percentual de Acréscimo"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Romaneio"},"tipoNota":{"type":"integer","description":"Tipo de Nota Fiscal (Quando Romaneio sem Pedido)"},"consumidorProprio":{"type":"boolean","description":"Consumidor Próprio (Quando Romaneio sem Pedido)"},"codPortador":{"type":"integer","description":"Código do Portador (Quando Romaneio sem Pedido)"},"tipoCobranca":{"type":"integer","description":"Tipo de Cobrança (Quando Romaneio sem Pedido)"},"localExpedicao":{"type":"string","description":"Localização na Expedição"},"nomeOperador":{"type":"string","description":"Operador da Liberação para Partidas"},"bloqComercial":{"type":"string","description":"Bloqueado pelo Comercial clientes vips"},"tabelaPreco":{"type":"string","description":"Código da Tabela de Preço"},"itens":{"type":"array","description":"Itens do Romaneio","items":{"$ref":"#/components/schemas/ItemRomaneio"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemRomaneio":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do produto (item filho)"},"codCor":{"type":"string","description":"Código da Cor do Produto"},"precoUnitario":{"type":"number","description":"Preço Unitário"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso Bruto"},"numeroEtiqueta":{"type":"integer","description":"Número da Etiqueta Sequência"},"alteracaoManual":{"type":"boolean","description":"Alteração Manual"},"ordemProducao":{"type":"string","description":"Código da Ordem de Produção"},"qtdVolumesPesado":{"type":"number","description":"Quantidade de Volumes Pesado"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréscimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","multipleOf":0.01,"description":"Acréscimo do Item"},"descontoCapa":{"type":"number","multipleOf":0.01,"description":"Desconto Proporcional da Capa"},"etiquetaAcabado":{"type":"integer","description":"Código da Etiqueta do Produto Acabado"},"precoUnitarioMT":{"type":"number","multipleOf":0.01,"description":"Preço Unitário Multi Tabela"},"cancelaSaldoPedido":{"type":"boolean","description":"Cancelar Saldo do Pedido"},"codQualidade":{"type":"integer","description":"Código da Qualidade"},"itemPedido":{"type":"integer","description":"Código do Item do Pedido"},"statusEtiqueta":{"type":"integer","description":"Status Original da Etiqueta"},"nomeOperador":{"type":"string","description":"Nome do Operador na Montagem do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItemRomaneio object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ItemRomaneio":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do produto (item filho)"},"codCor":{"type":"string","description":"Código da Cor do Produto"},"precoUnitario":{"type":"number","description":"Preço Unitário"},"pesoLiquido":{"type":"number","multipleOf":0.001,"description":"Peso Líquido"},"pesoBruto":{"type":"number","multipleOf":0.001,"description":"Peso Bruto"},"numeroEtiqueta":{"type":"integer","description":"Número da Etiqueta Sequência"},"alteracaoManual":{"type":"boolean","description":"Alteração Manual"},"ordemProducao":{"type":"string","description":"Código da Ordem de Produção"},"qtdVolumesPesado":{"type":"number","description":"Quantidade de Volumes Pesado"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréscimo (0 - Percentual, 1 - Valor)","enum":[0,1]},"acrescimoItem":{"type":"number","multipleOf":0.01,"description":"Acréscimo do Item"},"descontoCapa":{"type":"number","multipleOf":0.01,"description":"Desconto Proporcional da Capa"},"etiquetaAcabado":{"type":"integer","description":"Código da Etiqueta do Produto Acabado"},"precoUnitarioMT":{"type":"number","multipleOf":0.01,"description":"Preço Unitário Multi Tabela"},"cancelaSaldoPedido":{"type":"boolean","description":"Cancelar Saldo do Pedido"},"codQualidade":{"type":"integer","description":"Código da Qualidade"},"itemPedido":{"type":"integer","description":"Código do Item do Pedido"},"statusEtiqueta":{"type":"integer","description":"Status Original da Etiqueta"},"nomeOperador":{"type":"string","description":"Nome do Operador na Montagem do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaTransporte object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ListaTransporte":{"type":"object","properties":{"codListaTransporte":{"type":"integer","description":"Código da Lista de Transporte"},"situacao":{"type":"integer","description":"Código da Situação de Lista de Transporte"},"descSituacao":{"type":"string","description":"Descrição da Situação da Lista de Transporte"},"codTransportadora":{"type":"integer","description":"Código da Transportadora da Lista de Transporte"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora da Lista de Transporte"},"notasFiscaisListaTransp":{"type":"array","items":{"$ref":"#/components/schemas/notaFiscalListaTransporte"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"notaFiscalListaTransporte":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal"},"notaFiscal":{"type":"string","description":"Código da Nota Fiscal"},"qtdTotalVolume":{"type":"integer","description":"Quantidade Total de Volumes da Nota Fiscal"},"qtdVolumeSaldo":{"type":"integer","description":"Quantidade de Volumes Pendentes para Conferência"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The notaFiscalListaTransporte object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"notaFiscalListaTransporte":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal"},"notaFiscal":{"type":"string","description":"Código da Nota Fiscal"},"qtdTotalVolume":{"type":"integer","description":"Quantidade Total de Volumes da Nota Fiscal"},"qtdVolumeSaldo":{"type":"integer","description":"Quantidade de Volumes Pendentes para Conferência"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The EtiquetasConfListaTransporte object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"EtiquetasConfListaTransporte":{"type":"object","required":["etiquetaVolume","etiquetaRomaneio"],"properties":{"etiquetaVolume":{"type":"string","description":"Código da Etiqueta de Volume da Nota Fiscal da Lista de Transporte"},"etiquetaRomaneio":{"type":"string","description":"Código da Etiqueta do Romaneio da Nota Fiscal da Lista de Transporte"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ConferenciaEtqListaTransporte object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"ConferenciaEtqListaTransporte":{"type":"object","properties":{"qtdVolumePendenteEtqRom":{"type":"integer","description":"Quantidade de volumes pendentes de conferência da etiqueta de romaneio"},"ListaTransporte":{"$ref":"#/components/schemas/ListaTransporte"}}},"ListaTransporte":{"type":"object","properties":{"codListaTransporte":{"type":"integer","description":"Código da Lista de Transporte"},"situacao":{"type":"integer","description":"Código da Situação de Lista de Transporte"},"descSituacao":{"type":"string","description":"Descrição da Situação da Lista de Transporte"},"codTransportadora":{"type":"integer","description":"Código da Transportadora da Lista de Transporte"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora da Lista de Transporte"},"notasFiscaisListaTransp":{"type":"array","items":{"$ref":"#/components/schemas/notaFiscalListaTransporte"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"notaFiscalListaTransporte":{"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão da Nota Fiscal"},"notaFiscal":{"type":"string","description":"Código da Nota Fiscal"},"qtdTotalVolume":{"type":"integer","description":"Quantidade Total de Volumes da Nota Fiscal"},"qtdVolumeSaldo":{"type":"integer","description":"Quantidade de Volumes Pendentes para Conferência"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Comercial v2.0 # Devolução Nota Fiscal devolucaoNota ## PUT /devolucaoNota > Devolução Nota Fiscal ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"tags":[{"name":"Devolução Nota Fiscal","description":"devolucaoNota"}],"servers":[{"url":"https://localhost/comercial/v20"},{"url":"http://localhost/comercial/v20"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"NotaDevolucaoPut":{"required":["codParametro","codRepresentante","cpfCnpjCliente","dataEmissao","dataEntrada","ipiBaseICMS","motivoDev","numeroDocumento","serieFiscal","tipoDocumento"],"type":"object","properties":{"numeroDocumento":{"maximum":999999999,"type":"integer","description":"Número do Documento"},"serieFiscal":{"maximum":9999,"type":"integer","description":"Código da Série Fiscal"},"cpfCnpjCliente":{"maxLength":14,"minLength":11,"type":"string","description":"Código do CPF/CNPJ do Cliente"},"codParametro":{"maximum":99,"type":"integer","description":"Código do Parâmetro de Devolução"},"dataEntrada":{"type":"string","description":"Data da Entrada da Nota (YYYY-MM-DD)","format":"date"},"dataEmissao":{"type":"string","description":"Data de Emissão da Nota (YYYY-MM-DD)","format":"date"},"motivoDev":{"maximum":9999,"type":"integer","description":"Motivo da Devolução"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codAtendente":{"type":"integer","description":"Código da Atendente"},"tipoDocumento":{"type":"integer","description":"Tipo de Documento"},"chaveNFe":{"maxLength":44,"type":"string","description":"Chave Nf-e"},"estruturaComercial":{"maxLength":35,"type":"string","description":"Estrutura Comercial"},"ipiBaseICMS":{"type":"integer","description":"IPI Soma na Base do ICMS (0 - Não, 1 - Sim)","enum":[0,1]},"observacao":{"maxLength":100,"type":"string","description":"Observação"},"valorTotal":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Total"},"valorFrete":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Frete"},"valorSeguro":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Seguro"},"valorOutrasDesp":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Outras Despesas"},"descontoEspecial":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Desconto Especial"},"descontoZonaFranca":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Desconto Zona Franca"},"valorISS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Iss"},"valorDescontoDuplicata":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Desconto Duplicata"},"valorPISRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Pis Retido"},"valorCOFINSRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Cofins Retido"},"valorCSLLRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Csll Retido"},"valorIRRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor ir Retido"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"documento":{"maxLength":10,"type":"string","description":"Documento"},"historico":{"maxLength":100,"type":"string","description":"Histórico"},"notasDevolvidas":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/NotasDevolvidas"}},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NotasDevolvidas":{"required":["dataEmissaoNotaDevolvida","numeroNotaDevolvida"],"type":"object","properties":{"numeroNotaDevolvida":{"maxLength":20,"type":"string","description":"Número da Nota Devolvida"},"dataEmissaoNotaDevolvida":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"}}},"ItensDevolucao":{"required":["cfop","codProduto","cstCOFINS","cstICMS","cstIPI","cstPIS","motivoDevItem","precoUnitario","quantidade"],"type":"object","properties":{"codProduto":{"maxLength":20,"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"maximum":999999.999,"type":"number","description":"Quantidade de Produtos"},"precoUnitario":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Preço Unitário do Produto"},"valorTotal":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Total"},"cfop":{"maxLength":5,"type":"string","description":"Código da CFOP"},"motivoDevItem":{"maximum":9999,"type":"integer","description":"Motivo Devolução do Item"},"parametroItem":{"maxLength":2,"type":"string","description":"Parâmetro Devolução Item"},"codFinalidadeProd":{"maxLength":6,"type":"string","description":"Código da Finalidade do Produto"},"percentualComisRep":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante"},"valorComisRep":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Representante"},"percentualComisAtend":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual da Comissão do Atendente"},"valorComisAtend":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Atendente"},"cstICMS":{"maxLength":3,"type":"string","description":"Código de Situação Tributária ICMS (CST ICMS)"},"baseICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base do ICMS"},"aliquotaICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do ICMS"},"valorICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do ICMS"},"ICMSIsentas":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Isentas ou Não Tributárias"},"ICMSOutras":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Outras"},"fcpICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP ICMS"},"difalRemetente":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Remetente"},"difalDestinatario":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Destinatário"},"FCPDifal":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP Difal"},"baseST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base da Substituição Tributária"},"valorST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Substituição Tributária"},"aliquotaST":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota Substituição Tributária"},"valorFcpST":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do Fcp Retido Por Substituição Tributária"},"situacaoST":{"type":"integer","description":"Tipo de Substituição Tributária do ICMS (0 - Não Possui, 1 - Com Crédito, 2 - Sem Crédito)","enum":[0,1,2]},"cstIPI":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - IPI"},"baseIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base IPI"},"aliquotaIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do IPI"},"valorIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor IPI"},"IPIIsentas":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Isentas"},"IPIOutras":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Outras"},"cstPIS":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - PIS"},"basePIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base PIS"},"aliquotaPIS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota PIS"},"valorPIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do PIS"},"tipoBasePIS":{"type":"integer","description":"Tipo de Base de Crédito do Pis (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"cstCOFINS":{"maxLength":3,"type":"string","description":"Código da Situação Tributária COFINS"},"baseCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base COFINS"},"aliquotaCOFINS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Aliquota do COFINS"},"valorCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do COFINS"},"tipoBaseCOFINS":{"type":"integer","description":"Tipo de Base de Crédito do Cofins (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"cClassTribIS":{"type":"string","maxLength":6,"description":"cClassTrib do IS"},"cstIS":{"type":"string","maxLength":3,"description":"CST do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/devolucaoNota":{"put":{"tags":["Devolução Nota Fiscal"],"summary":"Devolução Nota Fiscal","operationId":"DevolucaoNotaFiscal","parameters":[{"name":"empresa","in":"header","description":"Empresa para Importação da Devolução","required":true,"schema":{"maximum":99999,"minimum":1,"type":"integer"}}],"requestBody":{"description":"Nota Fiscal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaDevolucaoPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The NotaDevolucaoPut object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"NotaDevolucaoPut":{"required":["codParametro","codRepresentante","cpfCnpjCliente","dataEmissao","dataEntrada","ipiBaseICMS","motivoDev","numeroDocumento","serieFiscal","tipoDocumento"],"type":"object","properties":{"numeroDocumento":{"maximum":999999999,"type":"integer","description":"Número do Documento"},"serieFiscal":{"maximum":9999,"type":"integer","description":"Código da Série Fiscal"},"cpfCnpjCliente":{"maxLength":14,"minLength":11,"type":"string","description":"Código do CPF/CNPJ do Cliente"},"codParametro":{"maximum":99,"type":"integer","description":"Código do Parâmetro de Devolução"},"dataEntrada":{"type":"string","description":"Data da Entrada da Nota (YYYY-MM-DD)","format":"date"},"dataEmissao":{"type":"string","description":"Data de Emissão da Nota (YYYY-MM-DD)","format":"date"},"motivoDev":{"maximum":9999,"type":"integer","description":"Motivo da Devolução"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codAtendente":{"type":"integer","description":"Código da Atendente"},"tipoDocumento":{"type":"integer","description":"Tipo de Documento"},"chaveNFe":{"maxLength":44,"type":"string","description":"Chave Nf-e"},"estruturaComercial":{"maxLength":35,"type":"string","description":"Estrutura Comercial"},"ipiBaseICMS":{"type":"integer","description":"IPI Soma na Base do ICMS (0 - Não, 1 - Sim)","enum":[0,1]},"observacao":{"maxLength":100,"type":"string","description":"Observação"},"valorTotal":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Total"},"valorFrete":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Frete"},"valorSeguro":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Seguro"},"valorOutrasDesp":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Outras Despesas"},"descontoEspecial":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Desconto Especial"},"descontoZonaFranca":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Desconto Zona Franca"},"valorISS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Iss"},"valorDescontoDuplicata":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Desconto Duplicata"},"valorPISRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Pis Retido"},"valorCOFINSRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Cofins Retido"},"valorCSLLRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Csll Retido"},"valorIRRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor ir Retido"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"documento":{"maxLength":10,"type":"string","description":"Documento"},"historico":{"maxLength":100,"type":"string","description":"Histórico"},"notasDevolvidas":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/NotasDevolvidas"}},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NotasDevolvidas":{"required":["dataEmissaoNotaDevolvida","numeroNotaDevolvida"],"type":"object","properties":{"numeroNotaDevolvida":{"maxLength":20,"type":"string","description":"Número da Nota Devolvida"},"dataEmissaoNotaDevolvida":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"}}},"ItensDevolucao":{"required":["cfop","codProduto","cstCOFINS","cstICMS","cstIPI","cstPIS","motivoDevItem","precoUnitario","quantidade"],"type":"object","properties":{"codProduto":{"maxLength":20,"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"maximum":999999.999,"type":"number","description":"Quantidade de Produtos"},"precoUnitario":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Preço Unitário do Produto"},"valorTotal":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Total"},"cfop":{"maxLength":5,"type":"string","description":"Código da CFOP"},"motivoDevItem":{"maximum":9999,"type":"integer","description":"Motivo Devolução do Item"},"parametroItem":{"maxLength":2,"type":"string","description":"Parâmetro Devolução Item"},"codFinalidadeProd":{"maxLength":6,"type":"string","description":"Código da Finalidade do Produto"},"percentualComisRep":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante"},"valorComisRep":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Representante"},"percentualComisAtend":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual da Comissão do Atendente"},"valorComisAtend":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Atendente"},"cstICMS":{"maxLength":3,"type":"string","description":"Código de Situação Tributária ICMS (CST ICMS)"},"baseICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base do ICMS"},"aliquotaICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do ICMS"},"valorICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do ICMS"},"ICMSIsentas":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Isentas ou Não Tributárias"},"ICMSOutras":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Outras"},"fcpICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP ICMS"},"difalRemetente":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Remetente"},"difalDestinatario":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Destinatário"},"FCPDifal":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP Difal"},"baseST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base da Substituição Tributária"},"valorST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Substituição Tributária"},"aliquotaST":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota Substituição Tributária"},"valorFcpST":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do Fcp Retido Por Substituição Tributária"},"situacaoST":{"type":"integer","description":"Tipo de Substituição Tributária do ICMS (0 - Não Possui, 1 - Com Crédito, 2 - Sem Crédito)","enum":[0,1,2]},"cstIPI":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - IPI"},"baseIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base IPI"},"aliquotaIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do IPI"},"valorIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor IPI"},"IPIIsentas":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Isentas"},"IPIOutras":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Outras"},"cstPIS":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - PIS"},"basePIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base PIS"},"aliquotaPIS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota PIS"},"valorPIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do PIS"},"tipoBasePIS":{"type":"integer","description":"Tipo de Base de Crédito do Pis (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"cstCOFINS":{"maxLength":3,"type":"string","description":"Código da Situação Tributária COFINS"},"baseCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base COFINS"},"aliquotaCOFINS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Aliquota do COFINS"},"valorCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do COFINS"},"tipoBaseCOFINS":{"type":"integer","description":"Tipo de Base de Crédito do Cofins (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"cClassTribIS":{"type":"string","maxLength":6,"description":"cClassTrib do IS"},"cstIS":{"type":"string","maxLength":3,"description":"CST do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItensDevolucao object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"ItensDevolucao":{"required":["cfop","codProduto","cstCOFINS","cstICMS","cstIPI","cstPIS","motivoDevItem","precoUnitario","quantidade"],"type":"object","properties":{"codProduto":{"maxLength":20,"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"maximum":999999.999,"type":"number","description":"Quantidade de Produtos"},"precoUnitario":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Preço Unitário do Produto"},"valorTotal":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Total"},"cfop":{"maxLength":5,"type":"string","description":"Código da CFOP"},"motivoDevItem":{"maximum":9999,"type":"integer","description":"Motivo Devolução do Item"},"parametroItem":{"maxLength":2,"type":"string","description":"Parâmetro Devolução Item"},"codFinalidadeProd":{"maxLength":6,"type":"string","description":"Código da Finalidade do Produto"},"percentualComisRep":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante"},"valorComisRep":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Representante"},"percentualComisAtend":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual da Comissão do Atendente"},"valorComisAtend":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Atendente"},"cstICMS":{"maxLength":3,"type":"string","description":"Código de Situação Tributária ICMS (CST ICMS)"},"baseICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base do ICMS"},"aliquotaICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do ICMS"},"valorICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do ICMS"},"ICMSIsentas":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Isentas ou Não Tributárias"},"ICMSOutras":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Outras"},"fcpICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP ICMS"},"difalRemetente":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Remetente"},"difalDestinatario":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Destinatário"},"FCPDifal":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP Difal"},"baseST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base da Substituição Tributária"},"valorST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Substituição Tributária"},"aliquotaST":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota Substituição Tributária"},"valorFcpST":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do Fcp Retido Por Substituição Tributária"},"situacaoST":{"type":"integer","description":"Tipo de Substituição Tributária do ICMS (0 - Não Possui, 1 - Com Crédito, 2 - Sem Crédito)","enum":[0,1,2]},"cstIPI":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - IPI"},"baseIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base IPI"},"aliquotaIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do IPI"},"valorIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor IPI"},"IPIIsentas":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Isentas"},"IPIOutras":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Outras"},"cstPIS":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - PIS"},"basePIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base PIS"},"aliquotaPIS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota PIS"},"valorPIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do PIS"},"tipoBasePIS":{"type":"integer","description":"Tipo de Base de Crédito do Pis (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"cstCOFINS":{"maxLength":3,"type":"string","description":"Código da Situação Tributária COFINS"},"baseCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base COFINS"},"aliquotaCOFINS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Aliquota do COFINS"},"valorCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do COFINS"},"tipoBaseCOFINS":{"type":"integer","description":"Tipo de Base de Crédito do Cofins (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"cClassTribIS":{"type":"string","maxLength":6,"description":"cClassTrib do IS"},"cstIS":{"type":"string","maxLength":3,"description":"CST do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotasDevolvidas object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"NotasDevolvidas":{"required":["dataEmissaoNotaDevolvida","numeroNotaDevolvida"],"type":"object","properties":{"numeroNotaDevolvida":{"maxLength":20,"type":"string","description":"Número da Nota Devolvida"},"dataEmissaoNotaDevolvida":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Comissão sobre Vendas v1.0 API referente ao módulo de Comissão sobre Vendas do ERP Consistem. # Comissão Sobre Vendas comissaoSobreVendas ## GET /extratoComissoes > Lista Extrato de Comissões ```json {"openapi":"3.0.1","info":{"title":"Comercial - Comissão sobre Vendas","version":"1.0"},"tags":[{"name":"Comissão sobre Vendas","description":"comissaoSobreVendas"}],"servers":[{"url":"https://localhost/comissaosobrevendas/v10"},{"url":"http://localhost/comissaosobrevendas/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ExtratoComissoes":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"extratosComissaoSobreVendas":{"type":"array","items":{"$ref":"#/components/schemas/ListaComissaoRepresentante"}}}},"ListaComissaoRepresentante":{"type":"object","properties":{"codRepresentante":{"type":"integer","description":"Código do Representante"},"dataInicialFechamento":{"type":"string","description":"Data Inicial de Fechamento (YYYY-MM-DD)","format":"date"},"dataFinalFechamento":{"type":"string","description":"Data Final de Fechamento (YYYY-MM-DD)","format":"date"},"lancamentos":{"type":"array","description":"Lista de lançamentos","items":{"$ref":"#/components/schemas/LancamentosComissaoRepresentante"}},"valoresReferencia":{"type":"array","description":"Lista de valores de referência","items":{"$ref":"#/components/schemas/ValoresRefComissaoRepresentante"}},"valoresResumoNota":{"type":"array","description":"Resumo de valores da nota","items":{"$ref":"#/components/schemas/ValoresResumoNotaComissaoRepresentante"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"LancamentosComissaoRepresentante":{"type":"object","properties":{"seqLancamento":{"type":"integer","description":"Sequência do Lançamento no Extrato de Comissões"},"dataLancamento":{"type":"string","description":"Data de Lançamento (YYYY-MM-DD)","format":"date"},"descricaoLancamento":{"type":"string","description":"Descrição do Lançamento"},"historicoLancamento":{"type":"string","description":"Histórico do Lançamento"},"tipoLancamento":{"type":"string","description":"Tipo do Lançamento (C - Crédito, D - Débito)","enum":["C","D"]},"valorLancamento":{"multipleOf":0.01,"type":"number","description":"Valor do Lançamento"},"titulosRefLancamento":{"type":"array","items":{"$ref":"#/components/schemas/TitulosReferentesLancamento"}}}},"TitulosReferentesLancamento":{"type":"object","properties":{"codTitulo":{"type":"string","description":"Código do Título"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"valorComissao":{"multipleOf":0.01,"type":"number","description":"Valor da Comissão sobre o Título"},"notaFiscalOrigem":{"type":"string","description":"Nota Fiscal de Origem do Título"},"serieNotaFiscalOrigem":{"maximum":999,"type":"integer","description":"Código da Série da Nota Fiscal"},"chaveNFEOrigem":{"type":"string","description":"Chave de Autenticação da Nota Fiscal de Origem do Título"}}},"ValoresRefComissaoRepresentante":{"type":"object","properties":{"dataFechamentoAnterior":{"type":"string","description":"Data do Último Fechamento da Comissão do Representante (YYYY-MM-DD)","format":"date"},"valorSaldoFechamentoAnterior":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo do Último Fechamento"},"tipoSaldoFechamentoAnterior":{"type":"string","description":"Tipo do Saldo do Último Fechamento (C - Credor, D - Devedor)","enum":["C","D"]},"dataAnteriorSaldo":{"type":"string","description":"Saldo da Data Anteior ao Período Inicial Informado da Comissão do Representante (YYYY-MM-DD)","format":"date"},"valorSaldoDataAnterior":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo na Data Inicial do Período Informado da Comissão do Representante (YYYY-MM-DD)"},"tipoSaldoDataAnterior":{"type":"string","description":"Tipo do Saldo na Data Inicial do Período Informado da Comissão do Representante (C - Credor, D - Devedor)","enum":["C","D"]},"valorTotalCreditos":{"multipleOf":0.01,"type":"number","description":"Valor Total dos Lançamentos de Crédito"},"valorTotalDebitos":{"multipleOf":0.01,"type":"number","description":"Valor Total dos Lançamentos de Débito"},"dataFechamentoAtual":{"type":"string","description":"Data do Atual do Fechamento da Comissão do Representante (YYYY-MM-DD)","format":"date"},"saldoFechamentoAtual":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo do Fechamento Atual"},"tipoSaldoAtual":{"type":"string","description":"Tipo do Saldo do Fechamento Atual (C - Credor, D - Devedor)","enum":["C","D"]}}},"ValoresResumoNotaComissaoRepresentante":{"type":"object","properties":{"valorComissao":{"multipleOf":0.01,"type":"number","description":"Valor da Comissão do Representante"},"valorAvosComissao":{"multipleOf":0.01,"type":"number","description":"Valor 1/12 Avos Comissao do Representante"},"valorIRF":{"multipleOf":0.01,"type":"number","description":"Valor do IRF"},"valorNota":{"multipleOf":0.01,"type":"number","description":"Valor da Nota Fiscal a ser Emitida pelo Representante"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/extratoComissoes":{"get":{"tags":["Comissão sobre Vendas"],"summary":"Lista Extrato de Comissões","operationId":"ObterExtratoComissoes","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"integer"}},{"name":"continuationToken","in":"query","description":"Identificador de Paginação da Consulta","schema":{"type":"string"}},{"name":"dataComissoesInicial","in":"query","description":"Período Comissões Data Inicial (YYYY-MM-DD)","required":true,"schema":{"type":"string"}},{"name":"dataComissoesFinal","in":"query","description":"Período Comissões Data Final (YYYY-MM-DD)","required":true,"schema":{"type":"string"}},{"name":"representantes","in":"query","description":"Lista de Código de Representante","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExtratoComissoes"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The ExtratoComissoes object ```json {"openapi":"3.0.1","info":{"title":"Comercial - Comissão sobre Vendas","version":"1.0"},"components":{"schemas":{"ExtratoComissoes":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"extratosComissaoSobreVendas":{"type":"array","items":{"$ref":"#/components/schemas/ListaComissaoRepresentante"}}}},"ListaComissaoRepresentante":{"type":"object","properties":{"codRepresentante":{"type":"integer","description":"Código do Representante"},"dataInicialFechamento":{"type":"string","description":"Data Inicial de Fechamento (YYYY-MM-DD)","format":"date"},"dataFinalFechamento":{"type":"string","description":"Data Final de Fechamento (YYYY-MM-DD)","format":"date"},"lancamentos":{"type":"array","description":"Lista de lançamentos","items":{"$ref":"#/components/schemas/LancamentosComissaoRepresentante"}},"valoresReferencia":{"type":"array","description":"Lista de valores de referência","items":{"$ref":"#/components/schemas/ValoresRefComissaoRepresentante"}},"valoresResumoNota":{"type":"array","description":"Resumo de valores da nota","items":{"$ref":"#/components/schemas/ValoresResumoNotaComissaoRepresentante"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"LancamentosComissaoRepresentante":{"type":"object","properties":{"seqLancamento":{"type":"integer","description":"Sequência do Lançamento no Extrato de Comissões"},"dataLancamento":{"type":"string","description":"Data de Lançamento (YYYY-MM-DD)","format":"date"},"descricaoLancamento":{"type":"string","description":"Descrição do Lançamento"},"historicoLancamento":{"type":"string","description":"Histórico do Lançamento"},"tipoLancamento":{"type":"string","description":"Tipo do Lançamento (C - Crédito, D - Débito)","enum":["C","D"]},"valorLancamento":{"multipleOf":0.01,"type":"number","description":"Valor do Lançamento"},"titulosRefLancamento":{"type":"array","items":{"$ref":"#/components/schemas/TitulosReferentesLancamento"}}}},"TitulosReferentesLancamento":{"type":"object","properties":{"codTitulo":{"type":"string","description":"Código do Título"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"valorComissao":{"multipleOf":0.01,"type":"number","description":"Valor da Comissão sobre o Título"},"notaFiscalOrigem":{"type":"string","description":"Nota Fiscal de Origem do Título"},"serieNotaFiscalOrigem":{"maximum":999,"type":"integer","description":"Código da Série da Nota Fiscal"},"chaveNFEOrigem":{"type":"string","description":"Chave de Autenticação da Nota Fiscal de Origem do Título"}}},"ValoresRefComissaoRepresentante":{"type":"object","properties":{"dataFechamentoAnterior":{"type":"string","description":"Data do Último Fechamento da Comissão do Representante (YYYY-MM-DD)","format":"date"},"valorSaldoFechamentoAnterior":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo do Último Fechamento"},"tipoSaldoFechamentoAnterior":{"type":"string","description":"Tipo do Saldo do Último Fechamento (C - Credor, D - Devedor)","enum":["C","D"]},"dataAnteriorSaldo":{"type":"string","description":"Saldo da Data Anteior ao Período Inicial Informado da Comissão do Representante (YYYY-MM-DD)","format":"date"},"valorSaldoDataAnterior":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo na Data Inicial do Período Informado da Comissão do Representante (YYYY-MM-DD)"},"tipoSaldoDataAnterior":{"type":"string","description":"Tipo do Saldo na Data Inicial do Período Informado da Comissão do Representante (C - Credor, D - Devedor)","enum":["C","D"]},"valorTotalCreditos":{"multipleOf":0.01,"type":"number","description":"Valor Total dos Lançamentos de Crédito"},"valorTotalDebitos":{"multipleOf":0.01,"type":"number","description":"Valor Total dos Lançamentos de Débito"},"dataFechamentoAtual":{"type":"string","description":"Data do Atual do Fechamento da Comissão do Representante (YYYY-MM-DD)","format":"date"},"saldoFechamentoAtual":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo do Fechamento Atual"},"tipoSaldoAtual":{"type":"string","description":"Tipo do Saldo do Fechamento Atual (C - Credor, D - Devedor)","enum":["C","D"]}}},"ValoresResumoNotaComissaoRepresentante":{"type":"object","properties":{"valorComissao":{"multipleOf":0.01,"type":"number","description":"Valor da Comissão do Representante"},"valorAvosComissao":{"multipleOf":0.01,"type":"number","description":"Valor 1/12 Avos Comissao do Representante"},"valorIRF":{"multipleOf":0.01,"type":"number","description":"Valor do IRF"},"valorNota":{"multipleOf":0.01,"type":"number","description":"Valor da Nota Fiscal a ser Emitida pelo Representante"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaComissaoRepresentante object ```json {"openapi":"3.0.1","info":{"title":"Comercial - Comissão sobre Vendas","version":"1.0"},"components":{"schemas":{"ListaComissaoRepresentante":{"type":"object","properties":{"codRepresentante":{"type":"integer","description":"Código do Representante"},"dataInicialFechamento":{"type":"string","description":"Data Inicial de Fechamento (YYYY-MM-DD)","format":"date"},"dataFinalFechamento":{"type":"string","description":"Data Final de Fechamento (YYYY-MM-DD)","format":"date"},"lancamentos":{"type":"array","description":"Lista de lançamentos","items":{"$ref":"#/components/schemas/LancamentosComissaoRepresentante"}},"valoresReferencia":{"type":"array","description":"Lista de valores de referência","items":{"$ref":"#/components/schemas/ValoresRefComissaoRepresentante"}},"valoresResumoNota":{"type":"array","description":"Resumo de valores da nota","items":{"$ref":"#/components/schemas/ValoresResumoNotaComissaoRepresentante"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"LancamentosComissaoRepresentante":{"type":"object","properties":{"seqLancamento":{"type":"integer","description":"Sequência do Lançamento no Extrato de Comissões"},"dataLancamento":{"type":"string","description":"Data de Lançamento (YYYY-MM-DD)","format":"date"},"descricaoLancamento":{"type":"string","description":"Descrição do Lançamento"},"historicoLancamento":{"type":"string","description":"Histórico do Lançamento"},"tipoLancamento":{"type":"string","description":"Tipo do Lançamento (C - Crédito, D - Débito)","enum":["C","D"]},"valorLancamento":{"multipleOf":0.01,"type":"number","description":"Valor do Lançamento"},"titulosRefLancamento":{"type":"array","items":{"$ref":"#/components/schemas/TitulosReferentesLancamento"}}}},"TitulosReferentesLancamento":{"type":"object","properties":{"codTitulo":{"type":"string","description":"Código do Título"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"valorComissao":{"multipleOf":0.01,"type":"number","description":"Valor da Comissão sobre o Título"},"notaFiscalOrigem":{"type":"string","description":"Nota Fiscal de Origem do Título"},"serieNotaFiscalOrigem":{"maximum":999,"type":"integer","description":"Código da Série da Nota Fiscal"},"chaveNFEOrigem":{"type":"string","description":"Chave de Autenticação da Nota Fiscal de Origem do Título"}}},"ValoresRefComissaoRepresentante":{"type":"object","properties":{"dataFechamentoAnterior":{"type":"string","description":"Data do Último Fechamento da Comissão do Representante (YYYY-MM-DD)","format":"date"},"valorSaldoFechamentoAnterior":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo do Último Fechamento"},"tipoSaldoFechamentoAnterior":{"type":"string","description":"Tipo do Saldo do Último Fechamento (C - Credor, D - Devedor)","enum":["C","D"]},"dataAnteriorSaldo":{"type":"string","description":"Saldo da Data Anteior ao Período Inicial Informado da Comissão do Representante (YYYY-MM-DD)","format":"date"},"valorSaldoDataAnterior":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo na Data Inicial do Período Informado da Comissão do Representante (YYYY-MM-DD)"},"tipoSaldoDataAnterior":{"type":"string","description":"Tipo do Saldo na Data Inicial do Período Informado da Comissão do Representante (C - Credor, D - Devedor)","enum":["C","D"]},"valorTotalCreditos":{"multipleOf":0.01,"type":"number","description":"Valor Total dos Lançamentos de Crédito"},"valorTotalDebitos":{"multipleOf":0.01,"type":"number","description":"Valor Total dos Lançamentos de Débito"},"dataFechamentoAtual":{"type":"string","description":"Data do Atual do Fechamento da Comissão do Representante (YYYY-MM-DD)","format":"date"},"saldoFechamentoAtual":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo do Fechamento Atual"},"tipoSaldoAtual":{"type":"string","description":"Tipo do Saldo do Fechamento Atual (C - Credor, D - Devedor)","enum":["C","D"]}}},"ValoresResumoNotaComissaoRepresentante":{"type":"object","properties":{"valorComissao":{"multipleOf":0.01,"type":"number","description":"Valor da Comissão do Representante"},"valorAvosComissao":{"multipleOf":0.01,"type":"number","description":"Valor 1/12 Avos Comissao do Representante"},"valorIRF":{"multipleOf":0.01,"type":"number","description":"Valor do IRF"},"valorNota":{"multipleOf":0.01,"type":"number","description":"Valor da Nota Fiscal a ser Emitida pelo Representante"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The LancamentosComissaoRepresentante object ```json {"openapi":"3.0.1","info":{"title":"Comercial - Comissão sobre Vendas","version":"1.0"},"components":{"schemas":{"LancamentosComissaoRepresentante":{"type":"object","properties":{"seqLancamento":{"type":"integer","description":"Sequência do Lançamento no Extrato de Comissões"},"dataLancamento":{"type":"string","description":"Data de Lançamento (YYYY-MM-DD)","format":"date"},"descricaoLancamento":{"type":"string","description":"Descrição do Lançamento"},"historicoLancamento":{"type":"string","description":"Histórico do Lançamento"},"tipoLancamento":{"type":"string","description":"Tipo do Lançamento (C - Crédito, D - Débito)","enum":["C","D"]},"valorLancamento":{"multipleOf":0.01,"type":"number","description":"Valor do Lançamento"},"titulosRefLancamento":{"type":"array","items":{"$ref":"#/components/schemas/TitulosReferentesLancamento"}}}},"TitulosReferentesLancamento":{"type":"object","properties":{"codTitulo":{"type":"string","description":"Código do Título"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"valorComissao":{"multipleOf":0.01,"type":"number","description":"Valor da Comissão sobre o Título"},"notaFiscalOrigem":{"type":"string","description":"Nota Fiscal de Origem do Título"},"serieNotaFiscalOrigem":{"maximum":999,"type":"integer","description":"Código da Série da Nota Fiscal"},"chaveNFEOrigem":{"type":"string","description":"Chave de Autenticação da Nota Fiscal de Origem do Título"}}}}}} ``` ## The ValoresRefComissaoRepresentante object ```json {"openapi":"3.0.1","info":{"title":"Comercial - Comissão sobre Vendas","version":"1.0"},"components":{"schemas":{"ValoresRefComissaoRepresentante":{"type":"object","properties":{"dataFechamentoAnterior":{"type":"string","description":"Data do Último Fechamento da Comissão do Representante (YYYY-MM-DD)","format":"date"},"valorSaldoFechamentoAnterior":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo do Último Fechamento"},"tipoSaldoFechamentoAnterior":{"type":"string","description":"Tipo do Saldo do Último Fechamento (C - Credor, D - Devedor)","enum":["C","D"]},"dataAnteriorSaldo":{"type":"string","description":"Saldo da Data Anteior ao Período Inicial Informado da Comissão do Representante (YYYY-MM-DD)","format":"date"},"valorSaldoDataAnterior":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo na Data Inicial do Período Informado da Comissão do Representante (YYYY-MM-DD)"},"tipoSaldoDataAnterior":{"type":"string","description":"Tipo do Saldo na Data Inicial do Período Informado da Comissão do Representante (C - Credor, D - Devedor)","enum":["C","D"]},"valorTotalCreditos":{"multipleOf":0.01,"type":"number","description":"Valor Total dos Lançamentos de Crédito"},"valorTotalDebitos":{"multipleOf":0.01,"type":"number","description":"Valor Total dos Lançamentos de Débito"},"dataFechamentoAtual":{"type":"string","description":"Data do Atual do Fechamento da Comissão do Representante (YYYY-MM-DD)","format":"date"},"saldoFechamentoAtual":{"multipleOf":0.01,"type":"number","description":"Valor do Saldo do Fechamento Atual"},"tipoSaldoAtual":{"type":"string","description":"Tipo do Saldo do Fechamento Atual (C - Credor, D - Devedor)","enum":["C","D"]}}}}}} ``` ## The TitulosReferentesLancamento object ```json {"openapi":"3.0.1","info":{"title":"Comercial - Comissão sobre Vendas","version":"1.0"},"components":{"schemas":{"TitulosReferentesLancamento":{"type":"object","properties":{"codTitulo":{"type":"string","description":"Código do Título"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"valorComissao":{"multipleOf":0.01,"type":"number","description":"Valor da Comissão sobre o Título"},"notaFiscalOrigem":{"type":"string","description":"Nota Fiscal de Origem do Título"},"serieNotaFiscalOrigem":{"maximum":999,"type":"integer","description":"Código da Série da Nota Fiscal"},"chaveNFEOrigem":{"type":"string","description":"Chave de Autenticação da Nota Fiscal de Origem do Título"}}}}}} ``` ## The ValoresResumoNotaComissaoRepresentante object ```json {"openapi":"3.0.1","info":{"title":"Comercial - Comissão sobre Vendas","version":"1.0"},"components":{"schemas":{"ValoresResumoNotaComissaoRepresentante":{"type":"object","properties":{"valorComissao":{"multipleOf":0.01,"type":"number","description":"Valor da Comissão do Representante"},"valorAvosComissao":{"multipleOf":0.01,"type":"number","description":"Valor 1/12 Avos Comissao do Representante"},"valorIRF":{"multipleOf":0.01,"type":"number","description":"Valor do IRF"},"valorNota":{"multipleOf":0.01,"type":"number","description":"Valor da Nota Fiscal a ser Emitida pelo Representante"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Comercial - Comissão sobre Vendas","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Comercial - Comissão sobre Vendas","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Integração Deps v1.0 # Integração DEPS deps ## POST /pedido > Automação de Pedido Deps. - Integração Reversa ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"tags":[{"name":"Integração DEPS","description":"deps"}],"servers":[{"url":"https://localhost/deps/v10"},{"url":"http://localhost/deps/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Pedido":{"required":["codPedido","situacaoPedido"],"type":"object","properties":{"situacaoPedido":{"type":"string","description":"Situação do Pedido"},"codPedido":{"type":"string","description":"Código do Pedido"},"usuario":{"type":"string","description":"Usuário do Bloqueio"},"motivosBloqueio":{"type":"string","description":"Motivos do Bloqueio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedido":{"post":{"tags":["Integração DEPS"],"summary":"Automação de Pedido Deps. - Integração Reversa","operationId":"AtualizarPedidoDeps","requestBody":{"description":"Dados do Pedido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pedido"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /cliente/limite > Automação de Limite de Crédito de Cliente ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"tags":[{"name":"Integração DEPS","description":"deps"}],"servers":[{"url":"https://localhost/deps/v10"},{"url":"http://localhost/deps/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"LimiteCliente":{"required":["cnpjCpf"],"type":"object","properties":{"cnpjCpf":{"type":"string","description":"Código do CPF/CNPJ"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito"},"usuario":{"type":"string","description":"Código do Usuário do Limite"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cliente/limite":{"post":{"tags":["Integração DEPS"],"summary":"Automação de Limite de Crédito de Cliente","operationId":"AtualizarLimiteCredito","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados de Limite de Crédito do Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimiteCliente"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /grupoCliente > Atualização de Grupos de Cliente ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"tags":[{"name":"Integração DEPS","description":"deps"}],"servers":[{"url":"https://localhost/deps/v10"},{"url":"http://localhost/deps/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"GrupoCliente":{"required":["codGrupo"],"type":"object","properties":{"codGrupo":{"type":"string","description":"Código do Grupo de Clientes"},"listaClienteGrupo":{"type":"array","description":"Clientes do Grupo","items":{"$ref":"#/components/schemas/ClienteGrupo"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteGrupo":{"type":"object","properties":{"documento":{"type":"string","description":"Documento do Cliente"},"codigoSistemaGestao":{"type":"string","description":"Documento do Sistema de Gestão"},"tipoPessoa":{"type":"string","description":"Tipo de Pessoa"},"operacao":{"type":"string","description":"Operação (I - Incluir, E - Excluir, M - Manter)","enum":["I","E","M"]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente":{"post":{"tags":["Integração DEPS"],"summary":"Atualização de Grupos de Cliente","operationId":"AtualizarGrupoCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Grupo de Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrupoCliente"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /grupoCliente/limite > Automação de Limite de Crédito de Grupo de Cliente ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"tags":[{"name":"Integração DEPS","description":"deps"}],"servers":[{"url":"https://localhost/deps/v10"},{"url":"http://localhost/deps/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"LimiteGrupo":{"required":["codGrupo"],"type":"object","properties":{"codGrupo":{"type":"string","description":"Código do Grupo de Clientes"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito"},"usuario":{"type":"string","description":"Código do Usuário do Limite"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente/limite":{"post":{"tags":["Integração DEPS"],"summary":"Automação de Limite de Crédito de Grupo de Cliente","operationId":"AtualizarLimiteCreditoGrupo","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados de Limite de Crédito de Grupo de Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimiteGrupo"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The Pedido object ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"components":{"schemas":{"Pedido":{"required":["codPedido","situacaoPedido"],"type":"object","properties":{"situacaoPedido":{"type":"string","description":"Situação do Pedido"},"codPedido":{"type":"string","description":"Código do Pedido"},"usuario":{"type":"string","description":"Usuário do Bloqueio"},"motivosBloqueio":{"type":"string","description":"Motivos do Bloqueio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The LimiteCliente object ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"components":{"schemas":{"LimiteCliente":{"required":["cnpjCpf"],"type":"object","properties":{"cnpjCpf":{"type":"string","description":"Código do CPF/CNPJ"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito"},"usuario":{"type":"string","description":"Código do Usuário do Limite"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The LimiteGrupo object ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"components":{"schemas":{"LimiteGrupo":{"required":["codGrupo"],"type":"object","properties":{"codGrupo":{"type":"string","description":"Código do Grupo de Clientes"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito"},"usuario":{"type":"string","description":"Código do Usuário do Limite"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The GrupoCliente object ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"components":{"schemas":{"GrupoCliente":{"required":["codGrupo"],"type":"object","properties":{"codGrupo":{"type":"string","description":"Código do Grupo de Clientes"},"listaClienteGrupo":{"type":"array","description":"Clientes do Grupo","items":{"$ref":"#/components/schemas/ClienteGrupo"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteGrupo":{"type":"object","properties":{"documento":{"type":"string","description":"Documento do Cliente"},"codigoSistemaGestao":{"type":"string","description":"Documento do Sistema de Gestão"},"tipoPessoa":{"type":"string","description":"Tipo de Pessoa"},"operacao":{"type":"string","description":"Operação (I - Incluir, E - Excluir, M - Manter)","enum":["I","E","M"]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ClienteGrupo object ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"components":{"schemas":{"ClienteGrupo":{"type":"object","properties":{"documento":{"type":"string","description":"Documento do Cliente"},"codigoSistemaGestao":{"type":"string","description":"Documento do Sistema de Gestão"},"tipoPessoa":{"type":"string","description":"Tipo de Pessoa"},"operacao":{"type":"string","description":"Operação (I - Incluir, E - Excluir, M - Manter)","enum":["I","E","M"]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Integração Deps","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` # Loja v1.0 # Estoque Movimentos inventario ## PUT /inventario/{natureza} > Gerar Movimento de Estoque ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Estoque - Movimentos","description":"inventario"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaMovimentoEstoquePut":{"type":"object","properties":{"produtos":{"type":"array","description":"Lista de Movimentação de Estoque","items":{"$ref":"#/components/schemas/MovimentoEstoquePut"}}}},"MovimentoEstoquePut":{"type":"object","required":["codProduto","saldo","dataMovimento"],"properties":{"codProduto":{"type":"string","minLength":1,"maxLength":20,"description":"Código do Produto"},"saldo":{"type":"number","maximum":9999999.999,"multipleOf":0.001,"description":"Saldo do Estoque do Produto"},"dataMovimento":{"type":"string","format":"date","description":"Data da Movimentação de Estoque (YYYY-MM-DD)"}}}}},"paths":{"/inventario/{natureza}":{"put":{"summary":"Gerar Movimento de Estoque","operationId":"GerarMovimentoEstoque","tags":["Estoque - Movimentos"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"natureza","in":"path","required":true,"description":"Código da Natureza","schema":{"type":"string"}}],"requestBody":{"description":"Dados de Saldo do Produto","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaMovimentoEstoquePut"}}}}}}}} ``` # Inventário Loja naturezaEstoque ## POST /naturezaEstoque/{id}/abrirInventarioLoja > Abrir Inventário Loja ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Inventário Loja","description":"naturezaEstoque"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/naturezaEstoque/{id}/abrirInventarioLoja":{"post":{"summary":"Abrir Inventário Loja","operationId":"AbrirInventarioLoja","tags":["Inventário Loja"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Natureza","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Natureza de Estoque","required":true,"schema":{"type":"integer"}}]}}}} ``` ## POST /naturezaEstoque/{id}/fecharInventarioLoja > Fechar Inventário Loja ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Inventário Loja","description":"naturezaEstoque"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/naturezaEstoque/{id}/fecharInventarioLoja":{"post":{"summary":"Fechar Inventário Loja","operationId":"FecharInventarioLoja","tags":["Inventário Loja"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Natureza","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Natureza de Estoque","required":true,"schema":{"type":"integer"}}]}}}} ``` # Importar Cheque cheque ## PUT /cheque/{id} > Importar Cheques ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Importar Cheque","description":"cheque"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaImportacaoChequePut":{"type":"object","properties":{"cheques":{"type":"array","description":"Lista de Importação de Cheques","items":{"$ref":"#/components/schemas/ImportacaoChequePut"}}}},"ImportacaoChequePut":{"type":"object","required":["CNPJCPFCliente","codBanco","dataEntrada","dataVencimento","tipoEmitente","valorCheque"],"properties":{"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"codBanco":{"type":"integer","minimum":1,"maximum":999,"description":"Código do Banco"},"numeroAgencia":{"type":"integer","minimum":1,"maximum":9999,"description":"Número da Agência"},"numeroConta":{"type":"integer","minimum":1,"maximum":99999999,"description":"Número da Conta"},"numeroCheque":{"type":"integer","minimum":1,"maximum":999999,"description":"Número do Cheque"},"codCompensacao":{"type":"integer","minimum":1,"maximum":999,"description":"Código da Compensação"},"valorCheque":{"type":"number","maximum":99999999999.99,"multipleOf":0.01,"description":"Valor do Cheque"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento (YYYY-MM-DD)"},"tipoEmitente":{"type":"integer","description":"Tipo do Emitente (1 - Cliente, 2 - Terceiro)","enum":[1,2]},"CNPJCPFEmitente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Emitente"},"nomeEmitente":{"type":"string","description":"Nome do Emitente"},"telefoneEmitente":{"type":"string","description":"Telefone do Emitente"}}}}},"paths":{"/cheque/{id}":{"put":{"summary":"Importar Cheques","operationId":"ImportarCheques","tags":["Importar Cheque"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"id","in":"path","description":"Loja para Importação dos Cheques","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados de Saldo do Produto","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaImportacaoChequePut"}}}}}}}} ``` # Documento Fiscal documentoFiscal ## PUT /documentoFiscal > Cadastrar Documento Fiscal ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Documento Fiscal","description":"documentoFiscal"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaDocumentoFiscalPut":{"type":"object","properties":{"documentosFiscais":{"type":"array","items":{"$ref":"#/components/schemas/DocumentoFiscalPut"}}}},"DocumentoFiscalPut":{"type":"object","required":["dataEmissao","tipoDocumento","codECF","numeroDocumento","tipoCliente","CNPJCPFCliente"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"tipoDocumento":{"type":"integer","description":"Tipo de documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"tipoCliente":{"type":"integer","description":"Tipo do cliente (1-CNPJ, 2-CPF, 3-Exterior)","enum":[1,2,3]},"CNPJCPFCliente":{"type":"string","minLength":1,"maxLength":14,"description":"CNPJ/CPF do cliente - Para ECF repassar Zeros / Para Exterior repassar o código RUC"},"valorTotalNota":{"type":"number","multipleOf":0.01,"maximum":999999999.99,"description":"Valor total da nota"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"observacao":{"type":"string","maxLength":1000,"description":"Observação"},"modeloDocumento":{"type":"integer","description":"Modelo do documento (55 – NF-e, 59 – CF-e SAT, 65 – NFC-e (Não repassar para ECF))","enum":[55,59,65]},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44,"maxLength":44},"situacaoNota":{"type":"integer","description":"Situação da nota (0-Emitida, 1-Cancelada, 2-Inutilizada, 3-Contingência)","enum":[0,1,2,3]},"numeroSerieEquipamentoSAT":{"type":"integer","maximum":999999999,"description":"Número de série do equipamento SAT - Somente obrigatório para modelos de documento = 59 – CF-e SAT"},"protocoloAurizacao":{"type":"string","maxLength":36,"description":"Protocolo da autorização"},"protocoloCancelamento":{"type":"string","maxLength":36,"description":"Protocolo de cancelamento"},"motivoCancelamento":{"type":"string","maxLength":80,"description":"Motivo de cancelamento"},"dataCancelamento":{"type":"string","format":"date","description":"Data de cancelamento (YYYY-MM-DD)"},"pesoLiquido":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso liquido"},"pesoBruto":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso bruto"},"especieVolumes":{"type":"string","maxLength":80,"description":"Espécie dos volumes"},"quantidadeVolumes":{"type":"integer","maximum":999999999,"description":"Quantidade de volumes"},"notaFiscalComplemento":{"type":"integer","description":"Nota fiscal de complemento? (0-Não, 1-Sim)","enum":[0,1]},"itensDocumentoFiscal":{"type":"array","description":"Itens do documento fiscal","items":{"$ref":"#/components/schemas/ItensDocumentoFiscal"}},"duplicatasDocumentoFiscal":{"type":"array","description":"Duplicatas do documento fiscal","items":{"$ref":"#/components/schemas/duplicatasDocumentoFiscal"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDocumentoFiscal":{"type":"object","required":["sequenciaItem","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioBruto":{"type":"number","maximum":999999999.99999,"multipleOf":0.01,"description":"Preço unitário - As casas decimais podem variar de 2 à 5 casas decimais, conforme a configuração no ERP Consistem."},"vlrTotalBruto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total bruto"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"valorICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"valorICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS isenta"},"valorICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"Código CST ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"valorIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"valorIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"valorIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código do CST IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código CST PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"valorPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código do CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"valorCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"valorDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"valorDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"valorDIFALFCP":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL FCP"},"valorOutrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de outras despesas"},"valorFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"valorST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"percentualFCPICMS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Base de ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ICMS"},"percentualFCPST":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Percentual FCP ST"},"valorFCPST":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ST"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"duplicatasDocumentoFiscal":{"type":"object","description":"Não Repassar esses dados caso a nota esteja Cancelada.","required":["sequenciaDuplicata","valorParcela","quantidade"],"properties":{"sequenciaDuplicata":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência da duplicata"},"valorParcela":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de vencimento (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1 – Dinheiro, 2 – Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"codPortador":{"type":"integer","minimum":1,"maximum":9999,"description":"Código do portador"},"tipoCobranca":{"type":"integer","minimum":1,"maximum":99,"description":"Tipo de cobrança"},"numBancario":{"type":"string","maxLength":20,"description":"Número bancário"},"carteira":{"type":"string","maxLength":3,"description":"Carteira"},"contaBancaria":{"type":"string","maxLength":10,"description":"Conta bancária"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}},"paths":{"/documentoFiscal":{"put":{"summary":"Cadastrar Documento Fiscal","description":"","operationId":"CadastrarDocumentoFiscal","tags":["Documento Fiscal"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Loja para Importação do Documento Fiscal","required":true,"schema":{"type":"integer","minimum":1,"maximum":99999}}],"requestBody":{"description":"Dados do Documento Fiscal","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaDocumentoFiscalPut"}}}}}}}} ``` # Baixa De Títulos baixaTitulos ## PUT /baixaTitulos/baixaTitulo > Baixa de Títulos ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Baixa de Títulos","description":"baixaTitulos"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaBaixaTitulosPut":{"type":"object","properties":{"baixaTitulos":{"type":"array","items":{"$ref":"#/components/schemas/BaixaTitulosPut"}}}},"BaixaTitulosPut":{"type":"object","required":["numeroTitulo","dataBaixa","codRecebimento","vlrBaixa"],"properties":{"numeroTitulo":{"type":"string","maxLength":12,"description":"Número do título"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}},"paths":{"/baixaTitulos/baixaTitulo":{"put":{"summary":"Baixa de Títulos","description":"","operationId":"BaixaTitulos","tags":["Baixa de Títulos"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Loja para Importação do Documento Fiscal","required":true,"schema":{"type":"integer","minimum":1,"maximum":99999}}],"requestBody":{"description":"Dados da Baixa de Titulos","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaBaixaTitulosPut"}}}}}}}} ``` ## PUT /baixaTitulos/baixaDocumentoTitulo > Baixa de Títulos por Documento ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Baixa de Títulos","description":"baixaTitulos"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaBaixaDocumentoTitulosPut":{"type":"object","properties":{"baixaDocumentoTitulos":{"type":"array","items":{"$ref":"#/components/schemas/BaixaDocumentoTitulosPut"}}}},"BaixaDocumentoTitulosPut":{"type":"object","required":["dataEmissao","numeroDocumento","serieFiscal","sequeciaParcela","vlrBaixa","dataBaixa","codRecebimento"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data da emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"sequeciaParcela":{"type":"integer","minimum":1,"maximum":99,"description":"Sequencial da parcela"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}},"paths":{"/baixaTitulos/baixaDocumentoTitulo":{"put":{"summary":"Baixa de Títulos por Documento","description":"","operationId":"BaixaDocumentoTitulo","tags":["Baixa de Títulos"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Loja para Importação do Documento Fiscal","required":true,"schema":{"type":"integer","minimum":1,"maximum":99999}}],"requestBody":{"description":"Dados da Baixa de Titulos","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaBaixaDocumentoTitulosPut"}}}}}}}} ``` # Aceite De Nota aceiteNota ## PUT /aceiteNota > Aceite de Nota ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Aceite de Nota","description":"aceiteNota"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaAceiteNotaPut":{"type":"object","properties":{"aceiteNota":{"type":"array","items":{"$ref":"#/components/schemas/AceiteNotaPut"}}}},"AceiteNotaPut":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"dataAceiteNota":{"type":"string","format":"date","description":"Data do aceite de nota (YYYY-MM-DD)"},"numeroNotaAceite":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número da nota do aceite"},"CNPJEmissorNota":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ emissão da nota"},"transferenciaLojas":{"type":"integer","description":"Transferência entre lojas (0 - Não, 1 - Sim | Quando a nota foi emitida pela Loja, esse campo deve ser repassado como SIM. Caso contrário o sistema irá buscar uma pendência no módulo de aceite no ERP Consistem)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}},"paths":{"/aceiteNota":{"put":{"summary":"Aceite de Nota","description":"","operationId":"AceiteNota","tags":["Aceite de Nota"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Loja para Importação do Documento Fiscal","required":true,"schema":{"type":"integer","minimum":1,"maximum":99999}}],"requestBody":{"description":"Dados do Aceite de Nota","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaAceiteNotaPut"}}}}}}}} ``` # Devolução Nota Loja devolucaoNotaLoja ## PUT /devolucaoNotaLoja > Devolução Nota Fiscal Loja ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Devolução Nota Loja","description":"devolucaoNotaLoja"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaNotaDevolucaoPut":{"type":"object","properties":{"notasDevolucao":{"type":"array","items":{"$ref":"#/components/schemas/NotaDevolucaoPut"}}}},"NotaDevolucaoPut":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"CNPJ/CPF do cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44},"tipoDevolucao":{"type":"integer","description":"Tipo de devolução (0 - Própria, 1 - Cliente)","enum":[0,1]},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"itensDevolucao":{"type":"array","description":"Itens da devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço unitário liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total liquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS isentas"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"CST do ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"CST do IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"CST do PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de emissão da nota de devolução (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"integer","maximum":999999999,"description":"Número da nota devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}},"paths":{"/devolucaoNotaLoja":{"put":{"summary":"Devolução Nota Fiscal Loja","operationId":"DevolucaoNotaFiscalLoja","tags":["Devolução Nota Loja"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Empresa para Importação da Devolução","required":true,"schema":{"type":"integer","minimum":1,"maximum":99999}}],"requestBody":{"description":"notaFiscal","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaNotaDevolucaoPut"}}}}}}}} ``` # Notas De Transferência notasTransferidas ## GET /notasTransferencia > Notas de Transferência ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Notas de Transferência","description":"notasTransferidas"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaNotaTransferencia":{"type":"object","properties":{"notaTransferencia":{"type":"array","items":{"$ref":"#/components/schemas/NotaTransferencia"}}}},"NotaTransferencia":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"codItemPai":{"type":"string","description":"Código do item pai"},"descProduto":{"type":"string","description":"Descrição do produto"},"unidadeMedida":{"type":"string","description":"Unidade de medida"},"ncm":{"type":"string","description":"Código da NCM"},"codItemFilho":{"type":"string","description":"Código do item filho"},"codCor":{"type":"string","description":"Código da cor"},"descCor":{"type":"string","description":"Descrição da cor"},"tamanho":{"type":"string","description":"Código do tamanho"},"tag":{"type":"string","description":"Código da TAG"},"codEPC":{"type":"string","description":"Código do EPC"},"codBarras":{"type":"string","description":"Código de barras"},"preco":{"type":"string","description":"Preço da peça"},"codQualidade":{"type":"string","description":"Código da qualidade"},"descQualidade":{"type":"string","description":"Descrição da qualidade"},"skuItemEditado":{"type":"string","description":"SKU item editado"},"qtdeFaturada":{"type":"string","description":"Quantidade faturada"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/notasTransferencia":{"get":{"summary":"Notas de Transferência","operationId":"NotasTransferencia","tags":["Notas de Transferência"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaNotaTransferencia"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Empresa Origem","required":true,"schema":{"type":"integer","minimum":1,"maximum":99999}},{"name":"dataEmissao","in":"query","description":"Data de Emissão - (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}},{"name":"numeroNota","in":"query","description":"Número da Nota","required":true,"schema":{"type":"integer","minimum":1,"maximum":999999999}}]}}}} ``` # Cancelamento De Nota Fiscal cancelamentoNota ## POST /cancelamentoNota > Cancelamento de Nota Fiscal ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"tags":[{"name":"Cancelamento de Nota Fiscal","description":"cancelamentoNota"}],"servers":[{"url":"https://localhost/loja/v10"},{"url":"http://localhost/loja/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaNotaCancelamentoPut":{"type":"object","properties":{"notasCancelamento":{"type":"array","items":{"$ref":"#/components/schemas/NotaCancelamentoPut"}}}},"NotaCancelamentoPut":{"type":"object","required":["dataEmissao","numeroDocumento","tipoDocumento","codECF"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"tipoDocumento":{"type":"integer","description":"Tipo do documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"motivoCancelamento":{"type":"string","maxLength":30,"description":"Motivo do cancelamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}},"paths":{"/cancelamentoNota":{"post":{"summary":"Cancelamento de Nota Fiscal","operationId":"CancelamentoNotaFiscal","tags":["Cancelamento de Nota Fiscal"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Empresa para Importação do Cancelamento","required":true,"schema":{"type":"integer","minimum":1,"maximum":99999}}],"requestBody":{"description":"notaFiscal","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaNotaCancelamentoPut"}}}}}}}} ``` # Models ## The ListaNotaCancelamentoPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaNotaCancelamentoPut":{"type":"object","properties":{"notasCancelamento":{"type":"array","items":{"$ref":"#/components/schemas/NotaCancelamentoPut"}}}},"NotaCancelamentoPut":{"type":"object","required":["dataEmissao","numeroDocumento","tipoDocumento","codECF"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"tipoDocumento":{"type":"integer","description":"Tipo do documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"motivoCancelamento":{"type":"string","maxLength":30,"description":"Motivo do cancelamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaCancelamentoPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"NotaCancelamentoPut":{"type":"object","required":["dataEmissao","numeroDocumento","tipoDocumento","codECF"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"tipoDocumento":{"type":"integer","description":"Tipo do documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"motivoCancelamento":{"type":"string","maxLength":30,"description":"Motivo do cancelamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaNotaDevolucaoPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaNotaDevolucaoPut":{"type":"object","properties":{"notasDevolucao":{"type":"array","items":{"$ref":"#/components/schemas/NotaDevolucaoPut"}}}},"NotaDevolucaoPut":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"CNPJ/CPF do cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44},"tipoDevolucao":{"type":"integer","description":"Tipo de devolução (0 - Própria, 1 - Cliente)","enum":[0,1]},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"itensDevolucao":{"type":"array","description":"Itens da devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço unitário liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total liquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS isentas"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"CST do ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"CST do IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"CST do PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de emissão da nota de devolução (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"integer","maximum":999999999,"description":"Número da nota devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaDevolucaoPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"NotaDevolucaoPut":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"CNPJ/CPF do cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44},"tipoDevolucao":{"type":"integer","description":"Tipo de devolução (0 - Própria, 1 - Cliente)","enum":[0,1]},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"itensDevolucao":{"type":"array","description":"Itens da devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço unitário liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total liquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS isentas"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"CST do ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"CST do IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"CST do PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de emissão da nota de devolução (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"integer","maximum":999999999,"description":"Número da nota devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItensDevolucao object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço unitário liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total liquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS isentas"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"CST do ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"CST do IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"CST do PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de emissão da nota de devolução (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"integer","maximum":999999999,"description":"Número da nota devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The MovimentoEstoquePut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"MovimentoEstoquePut":{"type":"object","required":["codProduto","saldo","dataMovimento"],"properties":{"codProduto":{"type":"string","minLength":1,"maxLength":20,"description":"Código do Produto"},"saldo":{"type":"number","maximum":9999999.999,"multipleOf":0.001,"description":"Saldo do Estoque do Produto"},"dataMovimento":{"type":"string","format":"date","description":"Data da Movimentação de Estoque (YYYY-MM-DD)"}}}}}} ``` ## The ListaMovimentoEstoquePut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaMovimentoEstoquePut":{"type":"object","properties":{"produtos":{"type":"array","description":"Lista de Movimentação de Estoque","items":{"$ref":"#/components/schemas/MovimentoEstoquePut"}}}},"MovimentoEstoquePut":{"type":"object","required":["codProduto","saldo","dataMovimento"],"properties":{"codProduto":{"type":"string","minLength":1,"maxLength":20,"description":"Código do Produto"},"saldo":{"type":"number","maximum":9999999.999,"multipleOf":0.001,"description":"Saldo do Estoque do Produto"},"dataMovimento":{"type":"string","format":"date","description":"Data da Movimentação de Estoque (YYYY-MM-DD)"}}}}}} ``` ## The ImportacaoChequePut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ImportacaoChequePut":{"type":"object","required":["CNPJCPFCliente","codBanco","dataEntrada","dataVencimento","tipoEmitente","valorCheque"],"properties":{"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"codBanco":{"type":"integer","minimum":1,"maximum":999,"description":"Código do Banco"},"numeroAgencia":{"type":"integer","minimum":1,"maximum":9999,"description":"Número da Agência"},"numeroConta":{"type":"integer","minimum":1,"maximum":99999999,"description":"Número da Conta"},"numeroCheque":{"type":"integer","minimum":1,"maximum":999999,"description":"Número do Cheque"},"codCompensacao":{"type":"integer","minimum":1,"maximum":999,"description":"Código da Compensação"},"valorCheque":{"type":"number","maximum":99999999999.99,"multipleOf":0.01,"description":"Valor do Cheque"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento (YYYY-MM-DD)"},"tipoEmitente":{"type":"integer","description":"Tipo do Emitente (1 - Cliente, 2 - Terceiro)","enum":[1,2]},"CNPJCPFEmitente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Emitente"},"nomeEmitente":{"type":"string","description":"Nome do Emitente"},"telefoneEmitente":{"type":"string","description":"Telefone do Emitente"}}}}}} ``` ## The ListaImportacaoChequePut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaImportacaoChequePut":{"type":"object","properties":{"cheques":{"type":"array","description":"Lista de Importação de Cheques","items":{"$ref":"#/components/schemas/ImportacaoChequePut"}}}},"ImportacaoChequePut":{"type":"object","required":["CNPJCPFCliente","codBanco","dataEntrada","dataVencimento","tipoEmitente","valorCheque"],"properties":{"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"codBanco":{"type":"integer","minimum":1,"maximum":999,"description":"Código do Banco"},"numeroAgencia":{"type":"integer","minimum":1,"maximum":9999,"description":"Número da Agência"},"numeroConta":{"type":"integer","minimum":1,"maximum":99999999,"description":"Número da Conta"},"numeroCheque":{"type":"integer","minimum":1,"maximum":999999,"description":"Número do Cheque"},"codCompensacao":{"type":"integer","minimum":1,"maximum":999,"description":"Código da Compensação"},"valorCheque":{"type":"number","maximum":99999999999.99,"multipleOf":0.01,"description":"Valor do Cheque"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento (YYYY-MM-DD)"},"tipoEmitente":{"type":"integer","description":"Tipo do Emitente (1 - Cliente, 2 - Terceiro)","enum":[1,2]},"CNPJCPFEmitente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Emitente"},"nomeEmitente":{"type":"string","description":"Nome do Emitente"},"telefoneEmitente":{"type":"string","description":"Telefone do Emitente"}}}}}} ``` ## The ListaAceiteNotaPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaAceiteNotaPut":{"type":"object","properties":{"aceiteNota":{"type":"array","items":{"$ref":"#/components/schemas/AceiteNotaPut"}}}},"AceiteNotaPut":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"dataAceiteNota":{"type":"string","format":"date","description":"Data do aceite de nota (YYYY-MM-DD)"},"numeroNotaAceite":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número da nota do aceite"},"CNPJEmissorNota":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ emissão da nota"},"transferenciaLojas":{"type":"integer","description":"Transferência entre lojas (0 - Não, 1 - Sim | Quando a nota foi emitida pela Loja, esse campo deve ser repassado como SIM. Caso contrário o sistema irá buscar uma pendência no módulo de aceite no ERP Consistem)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The AceiteNotaPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"AceiteNotaPut":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"dataAceiteNota":{"type":"string","format":"date","description":"Data do aceite de nota (YYYY-MM-DD)"},"numeroNotaAceite":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número da nota do aceite"},"CNPJEmissorNota":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ emissão da nota"},"transferenciaLojas":{"type":"integer","description":"Transferência entre lojas (0 - Não, 1 - Sim | Quando a nota foi emitida pela Loja, esse campo deve ser repassado como SIM. Caso contrário o sistema irá buscar uma pendência no módulo de aceite no ERP Consistem)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaNotaTransferencia object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaNotaTransferencia":{"type":"object","properties":{"notaTransferencia":{"type":"array","items":{"$ref":"#/components/schemas/NotaTransferencia"}}}},"NotaTransferencia":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"codItemPai":{"type":"string","description":"Código do item pai"},"descProduto":{"type":"string","description":"Descrição do produto"},"unidadeMedida":{"type":"string","description":"Unidade de medida"},"ncm":{"type":"string","description":"Código da NCM"},"codItemFilho":{"type":"string","description":"Código do item filho"},"codCor":{"type":"string","description":"Código da cor"},"descCor":{"type":"string","description":"Descrição da cor"},"tamanho":{"type":"string","description":"Código do tamanho"},"tag":{"type":"string","description":"Código da TAG"},"codEPC":{"type":"string","description":"Código do EPC"},"codBarras":{"type":"string","description":"Código de barras"},"preco":{"type":"string","description":"Preço da peça"},"codQualidade":{"type":"string","description":"Código da qualidade"},"descQualidade":{"type":"string","description":"Descrição da qualidade"},"skuItemEditado":{"type":"string","description":"SKU item editado"},"qtdeFaturada":{"type":"string","description":"Quantidade faturada"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaTransferencia object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"NotaTransferencia":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"codItemPai":{"type":"string","description":"Código do item pai"},"descProduto":{"type":"string","description":"Descrição do produto"},"unidadeMedida":{"type":"string","description":"Unidade de medida"},"ncm":{"type":"string","description":"Código da NCM"},"codItemFilho":{"type":"string","description":"Código do item filho"},"codCor":{"type":"string","description":"Código da cor"},"descCor":{"type":"string","description":"Descrição da cor"},"tamanho":{"type":"string","description":"Código do tamanho"},"tag":{"type":"string","description":"Código da TAG"},"codEPC":{"type":"string","description":"Código do EPC"},"codBarras":{"type":"string","description":"Código de barras"},"preco":{"type":"string","description":"Preço da peça"},"codQualidade":{"type":"string","description":"Código da qualidade"},"descQualidade":{"type":"string","description":"Descrição da qualidade"},"skuItemEditado":{"type":"string","description":"SKU item editado"},"qtdeFaturada":{"type":"string","description":"Quantidade faturada"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaBaixaTitulosPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaBaixaTitulosPut":{"type":"object","properties":{"baixaTitulos":{"type":"array","items":{"$ref":"#/components/schemas/BaixaTitulosPut"}}}},"BaixaTitulosPut":{"type":"object","required":["numeroTitulo","dataBaixa","codRecebimento","vlrBaixa"],"properties":{"numeroTitulo":{"type":"string","maxLength":12,"description":"Número do título"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The BaixaTitulosPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"BaixaTitulosPut":{"type":"object","required":["numeroTitulo","dataBaixa","codRecebimento","vlrBaixa"],"properties":{"numeroTitulo":{"type":"string","maxLength":12,"description":"Número do título"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaBaixaDocumentoTitulosPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaBaixaDocumentoTitulosPut":{"type":"object","properties":{"baixaDocumentoTitulos":{"type":"array","items":{"$ref":"#/components/schemas/BaixaDocumentoTitulosPut"}}}},"BaixaDocumentoTitulosPut":{"type":"object","required":["dataEmissao","numeroDocumento","serieFiscal","sequeciaParcela","vlrBaixa","dataBaixa","codRecebimento"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data da emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"sequeciaParcela":{"type":"integer","minimum":1,"maximum":99,"description":"Sequencial da parcela"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The BaixaDocumentoTitulosPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"BaixaDocumentoTitulosPut":{"type":"object","required":["dataEmissao","numeroDocumento","serieFiscal","sequeciaParcela","vlrBaixa","dataBaixa","codRecebimento"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data da emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"sequeciaParcela":{"type":"integer","minimum":1,"maximum":99,"description":"Sequencial da parcela"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaDocumentoFiscalPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaDocumentoFiscalPut":{"type":"object","properties":{"documentosFiscais":{"type":"array","items":{"$ref":"#/components/schemas/DocumentoFiscalPut"}}}},"DocumentoFiscalPut":{"type":"object","required":["dataEmissao","tipoDocumento","codECF","numeroDocumento","tipoCliente","CNPJCPFCliente"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"tipoDocumento":{"type":"integer","description":"Tipo de documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"tipoCliente":{"type":"integer","description":"Tipo do cliente (1-CNPJ, 2-CPF, 3-Exterior)","enum":[1,2,3]},"CNPJCPFCliente":{"type":"string","minLength":1,"maxLength":14,"description":"CNPJ/CPF do cliente - Para ECF repassar Zeros / Para Exterior repassar o código RUC"},"valorTotalNota":{"type":"number","multipleOf":0.01,"maximum":999999999.99,"description":"Valor total da nota"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"observacao":{"type":"string","maxLength":1000,"description":"Observação"},"modeloDocumento":{"type":"integer","description":"Modelo do documento (55 – NF-e, 59 – CF-e SAT, 65 – NFC-e (Não repassar para ECF))","enum":[55,59,65]},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44,"maxLength":44},"situacaoNota":{"type":"integer","description":"Situação da nota (0-Emitida, 1-Cancelada, 2-Inutilizada, 3-Contingência)","enum":[0,1,2,3]},"numeroSerieEquipamentoSAT":{"type":"integer","maximum":999999999,"description":"Número de série do equipamento SAT - Somente obrigatório para modelos de documento = 59 – CF-e SAT"},"protocoloAurizacao":{"type":"string","maxLength":36,"description":"Protocolo da autorização"},"protocoloCancelamento":{"type":"string","maxLength":36,"description":"Protocolo de cancelamento"},"motivoCancelamento":{"type":"string","maxLength":80,"description":"Motivo de cancelamento"},"dataCancelamento":{"type":"string","format":"date","description":"Data de cancelamento (YYYY-MM-DD)"},"pesoLiquido":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso liquido"},"pesoBruto":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso bruto"},"especieVolumes":{"type":"string","maxLength":80,"description":"Espécie dos volumes"},"quantidadeVolumes":{"type":"integer","maximum":999999999,"description":"Quantidade de volumes"},"notaFiscalComplemento":{"type":"integer","description":"Nota fiscal de complemento? (0-Não, 1-Sim)","enum":[0,1]},"itensDocumentoFiscal":{"type":"array","description":"Itens do documento fiscal","items":{"$ref":"#/components/schemas/ItensDocumentoFiscal"}},"duplicatasDocumentoFiscal":{"type":"array","description":"Duplicatas do documento fiscal","items":{"$ref":"#/components/schemas/duplicatasDocumentoFiscal"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDocumentoFiscal":{"type":"object","required":["sequenciaItem","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioBruto":{"type":"number","maximum":999999999.99999,"multipleOf":0.01,"description":"Preço unitário - As casas decimais podem variar de 2 à 5 casas decimais, conforme a configuração no ERP Consistem."},"vlrTotalBruto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total bruto"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"valorICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"valorICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS isenta"},"valorICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"Código CST ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"valorIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"valorIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"valorIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código do CST IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código CST PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"valorPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código do CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"valorCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"valorDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"valorDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"valorDIFALFCP":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL FCP"},"valorOutrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de outras despesas"},"valorFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"valorST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"percentualFCPICMS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Base de ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ICMS"},"percentualFCPST":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Percentual FCP ST"},"valorFCPST":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ST"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"duplicatasDocumentoFiscal":{"type":"object","description":"Não Repassar esses dados caso a nota esteja Cancelada.","required":["sequenciaDuplicata","valorParcela","quantidade"],"properties":{"sequenciaDuplicata":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência da duplicata"},"valorParcela":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de vencimento (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1 – Dinheiro, 2 – Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"codPortador":{"type":"integer","minimum":1,"maximum":9999,"description":"Código do portador"},"tipoCobranca":{"type":"integer","minimum":1,"maximum":99,"description":"Tipo de cobrança"},"numBancario":{"type":"string","maxLength":20,"description":"Número bancário"},"carteira":{"type":"string","maxLength":3,"description":"Carteira"},"contaBancaria":{"type":"string","maxLength":10,"description":"Conta bancária"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}}} ``` ## The DocumentoFiscalPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"DocumentoFiscalPut":{"type":"object","required":["dataEmissao","tipoDocumento","codECF","numeroDocumento","tipoCliente","CNPJCPFCliente"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"tipoDocumento":{"type":"integer","description":"Tipo de documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"tipoCliente":{"type":"integer","description":"Tipo do cliente (1-CNPJ, 2-CPF, 3-Exterior)","enum":[1,2,3]},"CNPJCPFCliente":{"type":"string","minLength":1,"maxLength":14,"description":"CNPJ/CPF do cliente - Para ECF repassar Zeros / Para Exterior repassar o código RUC"},"valorTotalNota":{"type":"number","multipleOf":0.01,"maximum":999999999.99,"description":"Valor total da nota"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"observacao":{"type":"string","maxLength":1000,"description":"Observação"},"modeloDocumento":{"type":"integer","description":"Modelo do documento (55 – NF-e, 59 – CF-e SAT, 65 – NFC-e (Não repassar para ECF))","enum":[55,59,65]},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44,"maxLength":44},"situacaoNota":{"type":"integer","description":"Situação da nota (0-Emitida, 1-Cancelada, 2-Inutilizada, 3-Contingência)","enum":[0,1,2,3]},"numeroSerieEquipamentoSAT":{"type":"integer","maximum":999999999,"description":"Número de série do equipamento SAT - Somente obrigatório para modelos de documento = 59 – CF-e SAT"},"protocoloAurizacao":{"type":"string","maxLength":36,"description":"Protocolo da autorização"},"protocoloCancelamento":{"type":"string","maxLength":36,"description":"Protocolo de cancelamento"},"motivoCancelamento":{"type":"string","maxLength":80,"description":"Motivo de cancelamento"},"dataCancelamento":{"type":"string","format":"date","description":"Data de cancelamento (YYYY-MM-DD)"},"pesoLiquido":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso liquido"},"pesoBruto":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso bruto"},"especieVolumes":{"type":"string","maxLength":80,"description":"Espécie dos volumes"},"quantidadeVolumes":{"type":"integer","maximum":999999999,"description":"Quantidade de volumes"},"notaFiscalComplemento":{"type":"integer","description":"Nota fiscal de complemento? (0-Não, 1-Sim)","enum":[0,1]},"itensDocumentoFiscal":{"type":"array","description":"Itens do documento fiscal","items":{"$ref":"#/components/schemas/ItensDocumentoFiscal"}},"duplicatasDocumentoFiscal":{"type":"array","description":"Duplicatas do documento fiscal","items":{"$ref":"#/components/schemas/duplicatasDocumentoFiscal"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDocumentoFiscal":{"type":"object","required":["sequenciaItem","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioBruto":{"type":"number","maximum":999999999.99999,"multipleOf":0.01,"description":"Preço unitário - As casas decimais podem variar de 2 à 5 casas decimais, conforme a configuração no ERP Consistem."},"vlrTotalBruto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total bruto"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"valorICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"valorICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS isenta"},"valorICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"Código CST ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"valorIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"valorIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"valorIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código do CST IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código CST PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"valorPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código do CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"valorCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"valorDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"valorDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"valorDIFALFCP":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL FCP"},"valorOutrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de outras despesas"},"valorFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"valorST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"percentualFCPICMS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Base de ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ICMS"},"percentualFCPST":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Percentual FCP ST"},"valorFCPST":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ST"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"duplicatasDocumentoFiscal":{"type":"object","description":"Não Repassar esses dados caso a nota esteja Cancelada.","required":["sequenciaDuplicata","valorParcela","quantidade"],"properties":{"sequenciaDuplicata":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência da duplicata"},"valorParcela":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de vencimento (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1 – Dinheiro, 2 – Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"codPortador":{"type":"integer","minimum":1,"maximum":9999,"description":"Código do portador"},"tipoCobranca":{"type":"integer","minimum":1,"maximum":99,"description":"Tipo de cobrança"},"numBancario":{"type":"string","maxLength":20,"description":"Número bancário"},"carteira":{"type":"string","maxLength":3,"description":"Carteira"},"contaBancaria":{"type":"string","maxLength":10,"description":"Conta bancária"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}}} ``` ## The duplicatasDocumentoFiscal object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"duplicatasDocumentoFiscal":{"type":"object","description":"Não Repassar esses dados caso a nota esteja Cancelada.","required":["sequenciaDuplicata","valorParcela","quantidade"],"properties":{"sequenciaDuplicata":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência da duplicata"},"valorParcela":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de vencimento (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1 – Dinheiro, 2 – Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"codPortador":{"type":"integer","minimum":1,"maximum":9999,"description":"Código do portador"},"tipoCobranca":{"type":"integer","minimum":1,"maximum":99,"description":"Tipo de cobrança"},"numBancario":{"type":"string","maxLength":20,"description":"Número bancário"},"carteira":{"type":"string","maxLength":3,"description":"Carteira"},"contaBancaria":{"type":"string","maxLength":10,"description":"Conta bancária"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItensDocumentoFiscal object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ItensDocumentoFiscal":{"type":"object","required":["sequenciaItem","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioBruto":{"type":"number","maximum":999999999.99999,"multipleOf":0.01,"description":"Preço unitário - As casas decimais podem variar de 2 à 5 casas decimais, conforme a configuração no ERP Consistem."},"vlrTotalBruto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total bruto"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"valorICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"valorICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS isenta"},"valorICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"Código CST ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"valorIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"valorIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"valorIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código do CST IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código CST PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"valorPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código do CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"valorCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"valorDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"valorDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"valorDIFALFCP":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL FCP"},"valorOutrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de outras despesas"},"valorFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"valorST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"percentualFCPICMS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Base de ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ICMS"},"percentualFCPST":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Percentual FCP ST"},"valorFCPST":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ST"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Pedido de Serviço v1.0 # Cadastros Gerais cadastrosgerais ## GET /servicosLei1162003 > Obter Listagem de Serviços da Lei 116/2003 ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Cadastros Gerais","description":"cadastrosgerais"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaServicosLei1162003":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaServicosLei1162003":{"type":"array","items":{"$ref":"#/components/schemas/ServicoLei1162003"}}}},"ServicoLei1162003":{"type":"object","properties":{"codServicoLei1162003":{"type":"string","description":"Código do Serviço Lei 116/2003"},"descricao":{"type":"string","description":"Descrição do Serviço Lei 116/2003"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/servicosLei1162003":{"get":{"tags":["Cadastros Gerais"],"summary":"Obter Listagem de Serviços da Lei 116/2003","operationId":"ObterListaServicosLei1162003","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaServicosLei1162003"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /NBS > Obter Listagem de NBS ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Cadastros Gerais","description":"cadastrosgerais"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaNBS":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaNBS":{"type":"array","items":{"$ref":"#/components/schemas/NBS"}}}},"NBS":{"type":"object","properties":{"codNBS":{"type":"string","description":"Código do NBS"},"descricao":{"type":"string","description":"Descrição do NBS"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/NBS":{"get":{"tags":["Cadastros Gerais"],"summary":"Obter Listagem de NBS","operationId":"ObterListaNBS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaNBS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /indicadoresOperacaoServico > Obter Listagem de Indicadores da Operação do Serviço ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Cadastros Gerais","description":"cadastrosgerais"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaIndicadoresOperacao":{"type":"object","properties":{"continuationToken":{"type":"string"},"listaIndicadoresOperacao":{"type":"array","items":{"$ref":"#/components/schemas/IndicadorOperacao"}}}},"IndicadorOperacao":{"type":"object","properties":{"codIndicador":{"type":"string","description":"Código do Indicador de Operação do Serviço"},"nomeOperacao":{"type":"string","maxLength":300,"description":"Nome da Operação"},"textoDispLegal":{"type":"string","maxLength":300,"description":"Texto do Dispositivo Legal"},"textoLocalOperacao":{"type":"string","maxLength":300,"description":"Texto de Local de Operação"},"textoLocalFornec":{"type":"string","maxLength":300,"description":"Texto de Local do Fornecimento"},"textoCaractFornec":{"type":"string","maxLength":300,"description":"Texto de Caracterização do Fornecimento"},"dataPublicacao":{"type":"string","format":"date","description":"Data de Publicação (YYYY-MM-DD)"},"dataIniVig":{"type":"string","format":"date","description":"Data Início de Vigência (YYYY-MM-DD)"},"dataFimVig":{"type":"string","format":"date","description":"Data Fim de Vigência (YYYY-MM-DD)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/indicadoresOperacaoServico":{"get":{"tags":["Cadastros Gerais"],"summary":"Obter Listagem de Indicadores da Operação do Serviço","operationId":"ObterListaIndicadoresOperacao","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaIndicadoresOperacao"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /mensagemReducaoISS > Obter Listagem de Mensagens para a Redução do ISS ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Cadastros Gerais","description":"cadastrosgerais"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaMensagemReducaoISS":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaMensagensReducaoISS":{"type":"array","items":{"$ref":"#/components/schemas/MensagemReducao"}}}},"MensagemReducao":{"type":"object","properties":{"codMensagem":{"type":"integer","description":"Código da Mensagem"},"descricao":{"type":"string","maxLength":66,"description":"Mensagem de Redução do ISS"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/mensagemReducaoISS":{"get":{"tags":["Cadastros Gerais"],"summary":"Obter Listagem de Mensagens para a Redução do ISS","operationId":"ObterListaMensagemReducaoISS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaMensagemReducaoISS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /obra > Obter Listagem de CEI/CNO (Obra) ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Cadastros Gerais","description":"cadastrosgerais"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaObras":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaObras":{"type":"array","items":{"$ref":"#/components/schemas/Obra"}}}},"Obra":{"type":"object","properties":{"codObra":{"type":"integer","maximum":999999,"description":"Código da Obra"},"cnocei":{"type":"integer","maximum":99999999999999,"description":"CNO/CEI"},"numeroMatricula":{"type":"integer","maximum":99999999999999,"description":"Número da Matrícula"},"descObra":{"type":"string","maxLength":45,"description":"Número da Matrícula"},"empreitada":{"type":"integer","description":"Tipo Empreitada (1-Empreitada Total, 2-Empreitada Parcial)","enum":[1,2]},"tipoCNO":{"type":"integer","description":"Tipo CNO (1-Própria, 2-Terceiros)","enum":[1,2]},"dataObraEncerrada":{"type":"string","format":"date","description":"Data de Encerramento da Obra (YYYY-MM-DD)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/obra":{"get":{"tags":["Cadastros Gerais"],"summary":"Obter Listagem de CEI/CNO (Obra)","operationId":"ObterListaObras","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaObras"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Pedido De Serviço pedidoservico ## GET /pedidoServico > Obtem Listagem de Pedidos de Serviço ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Pedido de Serviço","description":"pedidoservico"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaPedidosServico":{"type":"object","properties":{"continuationToken":{"type":"string"},"listaPedidosServico":{"type":"array","items":{"$ref":"#/components/schemas/ListaPedidoServico"}}}},"ListaPedidoServico":{"type":"object","properties":{"codPedido":{"type":"integer","maximum":9,"description":"Código do Pedido de Serviço"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"vlrTotal":{"type":"number","multipleOf":0.01,"description":"Valor do Pedido Serviço"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevisao":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"dataFaturado":{"type":"string","format":"date","description":"Data de Faturamento (YYYY-MM-DD)"},"numNFSe":{"type":"string","description":"Número da NFS-e"},"sitPedido":{"type":"integer","description":"Situação do Pedido (0 - Aberto, 1-Faturado, 2-Cancelado)"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoServico":{"get":{"summary":"Obtem Listagem de Pedidos de Serviço","operationId":"ObterPedidosServico","tags":["Pedido de Serviço"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaPedidosServico"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"continuationToken","in":"query","required":false,"description":"Identificador de Paginação da Consulta","schema":{"type":"string","nullable":true}},{"name":"dataPrevisaoFaturamentoInicio","in":"query","required":false,"description":"Data de Previsao de Faturamento Inicial (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataPrevisaoFaturamentoFim","in":"query","required":false,"description":"Data de Previsao de Faturamento Final (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataEmissaoInicio","in":"query","required":false,"description":"Data de Emissão do Pedido Inicial (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataEmissaoFim","in":"query","required":false,"description":"Data de Emissão do Pedido Final (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataFaturamentoInicio","in":"query","required":false,"description":"Data de Faturamento Inicial (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"dataFaturamentoFim","in":"query","required":false,"description":"Data de Faturamento Final (YYYY-MM-DD)","schema":{"type":"string","nullable":true}},{"name":"clientes","in":"query","required":false,"description":"Lista de Código de Cliente","schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"tipoNota","in":"query","required":false,"description":"Lista de Código do Tipo de Nota","schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"representantes","in":"query","required":false,"description":"Lista de Código de Representante","schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"servico","in":"query","required":false,"description":"Lista de Código de Serviço","schema":{"type":"array","nullable":true,"items":{"type":"integer"}}},{"name":"situacao","in":"query","required":false,"description":"Lista de Situação de Pedidos (0-Aberto, 1-Faturado, 2-Cancelado)","schema":{"type":"array","nullable":true,"items":{"type":"integer","enum":[0,1,2]}}},{"name":"paginacao","in":"query","required":false,"description":"Quantidade de Pedidos na Paginação de Retorno","schema":{"type":"integer","nullable":true}}]}}}} ``` ## PUT /pedidoServico > Pedido de Serviço ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Pedido de Serviço","description":"pedidoservico"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PedidoServicoPut":{"required":["codCliente","codTipoNF","codRepresentante","codCondVenda","codPortador","codTipoCobranca"],"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCondVenda":{"type":"integer","maximum":99999,"description":"Condição de Venda"},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codAtendente":{"type":"string","description":"Código do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto":{"type":"number","multipleOf":0.01,"description":"Desconto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Serviço"},"observacaoNota":{"type":"string","maxLength":1000,"description":"Observação para a Nota Fiscal"},"listaServicos":{"type":"array","description":"Itens do Pedido de Serviço","items":{"$ref":"#/components/schemas/ListaServico"}},"listaProdutosFaturar":{"type":"array","description":"Lista de Produtos para Faturar","items":{"$ref":"#/components/schemas/ListaProdutoFaturar"}},"listaProdutosRemessa":{"type":"array","description":"Lista de Produtos para Remessa","items":{"$ref":"#/components/schemas/ListaProdutoRemessa"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaServico":{"type":"object","required":["codServico","undServico","qtdServico","precoUNServicoLiquido","codServico116","codNBS","codIndicadorOperacao","cepMunGer","localPrestacao","cepLocPrestServ"],"properties":{"codServico":{"description":"Código do Serviço","type":"integer","maximum":9999},"complementoServico":{"type":"string","maxLength":1000,"description":"Complemento Serviço (NFS-e)"},"undServico":{"type":"string","maxLength":6,"description":"Medida de Unidade do Serviço"},"qtdServico":{"type":"number","multipleOf":0.001,"description":"Quantidade do Serviço"},"precoUNServicoLiquido":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Líquido do Serviço"},"precoBrutoUNServico":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Bruto do Serviço"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto Item"},"aliquotaISS":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do ISS"},"percIRRF":{"type":"number","multipleOf":0.01,"description":"Percentual IRRF"},"percComisRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"percComisAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"codServico116":{"type":"string","maxLength":6,"description":"Código da lista de serviços da Lei Complementar 116/2003"},"codNBS":{"type":"string","maxLength":12,"description":"Código do NBS"},"codOAT":{"type":"string","maxLength":6,"description":"Código da Ordem de Assistência Técnica"},"codIndicadorOperacao":{"type":"string","maxLength":6,"description":"Indicador da Operação"},"percReducaoISS":{"type":"number","multipleOf":0.00001,"description":"PPercentual de redução do ISS"},"codMSGReducao":{"type":"integer","maximum":99999,"description":"Código da Mensagem Redução ISS"},"tipoTributacao":{"type":"integer","description":"Tipo de Tributação (0-Normal, 1-Retida, 2-Substituida, 3-Isenta)","enum":[0,1,2,3]},"cepMunGer":{"type":"integer","maximum":99999,"description":"CEP do Município Ocorrência do Fato Gerador"},"localPrestacao":{"type":"integer","description":"Local Prestação do Serviço (1-Município Prestador, 2-Município Tomador, 3-Outro Município)","enum":[1,2,3]},"cepLocPrestServ":{"type":"string","maxLength":8,"description":"CEP Local Prestação do Serviço"},"codCEI":{"type":"string","maxLength":15,"description":"Código CEI/CNO (Obra)"},"matriculaObra":{"type":"string","maxLength":15,"description":"Matrícula da Obra"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ListaProdutoFaturar":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaProdutoRemessa":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoServicoGet":{"type":"object","properties":{"codPedido":{"type":"integer","maximum":999999999,"description":"Código do Pedido de Serviço"},"situacaoPedido":{"type":"integer","description":"Situação do Pedido (0-Aberto, 1-Faturado, 2-Cancelado)","enum":[0,1,2]},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCondVenda":{"type":"integer","maximum":99999,"description":"Condição de Venda"},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codAtendente":{"type":"string","description":"Código do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto":{"type":"number","multipleOf":0.01,"description":"Desconto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Serviço"},"observacaoNota":{"type":"string","maxLength":1000,"description":"Observação para a Nota Fiscal"},"listaServicos":{"type":"array","description":"Itens do Pedido de Serviço","items":{"$ref":"#/components/schemas/ListaServico"}},"listaProdutosFaturar":{"type":"array","description":"Lista de Produtos para Faturar","items":{"$ref":"#/components/schemas/ListaProdutoFaturar"}},"listaProdutosRemessa":{"type":"array","description":"Lista de Produtos para Remessa","items":{"$ref":"#/components/schemas/ListaProdutoRemessa"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoServico":{"put":{"tags":["Pedido de Serviço"],"summary":"Pedido de Serviço","operationId":"CadastrarPedidoServico","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Pedido de Serviço","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoServicoPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoServicoGet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /pedidoServico/{codPedido} > Obtem um Pedido de Serviço ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Pedido de Serviço","description":"pedidoservico"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PedidoServicoGet":{"type":"object","properties":{"codPedido":{"type":"integer","maximum":999999999,"description":"Código do Pedido de Serviço"},"situacaoPedido":{"type":"integer","description":"Situação do Pedido (0-Aberto, 1-Faturado, 2-Cancelado)","enum":[0,1,2]},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCondVenda":{"type":"integer","maximum":99999,"description":"Condição de Venda"},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codAtendente":{"type":"string","description":"Código do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto":{"type":"number","multipleOf":0.01,"description":"Desconto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Serviço"},"observacaoNota":{"type":"string","maxLength":1000,"description":"Observação para a Nota Fiscal"},"listaServicos":{"type":"array","description":"Itens do Pedido de Serviço","items":{"$ref":"#/components/schemas/ListaServico"}},"listaProdutosFaturar":{"type":"array","description":"Lista de Produtos para Faturar","items":{"$ref":"#/components/schemas/ListaProdutoFaturar"}},"listaProdutosRemessa":{"type":"array","description":"Lista de Produtos para Remessa","items":{"$ref":"#/components/schemas/ListaProdutoRemessa"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaServico":{"type":"object","required":["codServico","undServico","qtdServico","precoUNServicoLiquido","codServico116","codNBS","codIndicadorOperacao","cepMunGer","localPrestacao","cepLocPrestServ"],"properties":{"codServico":{"description":"Código do Serviço","type":"integer","maximum":9999},"complementoServico":{"type":"string","maxLength":1000,"description":"Complemento Serviço (NFS-e)"},"undServico":{"type":"string","maxLength":6,"description":"Medida de Unidade do Serviço"},"qtdServico":{"type":"number","multipleOf":0.001,"description":"Quantidade do Serviço"},"precoUNServicoLiquido":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Líquido do Serviço"},"precoBrutoUNServico":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Bruto do Serviço"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto Item"},"aliquotaISS":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do ISS"},"percIRRF":{"type":"number","multipleOf":0.01,"description":"Percentual IRRF"},"percComisRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"percComisAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"codServico116":{"type":"string","maxLength":6,"description":"Código da lista de serviços da Lei Complementar 116/2003"},"codNBS":{"type":"string","maxLength":12,"description":"Código do NBS"},"codOAT":{"type":"string","maxLength":6,"description":"Código da Ordem de Assistência Técnica"},"codIndicadorOperacao":{"type":"string","maxLength":6,"description":"Indicador da Operação"},"percReducaoISS":{"type":"number","multipleOf":0.00001,"description":"PPercentual de redução do ISS"},"codMSGReducao":{"type":"integer","maximum":99999,"description":"Código da Mensagem Redução ISS"},"tipoTributacao":{"type":"integer","description":"Tipo de Tributação (0-Normal, 1-Retida, 2-Substituida, 3-Isenta)","enum":[0,1,2,3]},"cepMunGer":{"type":"integer","maximum":99999,"description":"CEP do Município Ocorrência do Fato Gerador"},"localPrestacao":{"type":"integer","description":"Local Prestação do Serviço (1-Município Prestador, 2-Município Tomador, 3-Outro Município)","enum":[1,2,3]},"cepLocPrestServ":{"type":"string","maxLength":8,"description":"CEP Local Prestação do Serviço"},"codCEI":{"type":"string","maxLength":15,"description":"Código CEI/CNO (Obra)"},"matriculaObra":{"type":"string","maxLength":15,"description":"Matrícula da Obra"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ListaProdutoFaturar":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaProdutoRemessa":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoServico/{codPedido}":{"get":{"summary":"Obtem um Pedido de Serviço","operationId":"ObterPedidoServico","tags":["Pedido de Serviço"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoServicoGet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"codPedido","in":"path","description":"Código do Pedido de Serviço","required":true,"schema":{"type":"string"}}]}}}} ``` ## POST /pedidoServico/{codPedido} > Atualizar um Pedido de Serviço ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Pedido de Serviço","description":"pedidoservico"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PedidoServicoPut":{"required":["codCliente","codTipoNF","codRepresentante","codCondVenda","codPortador","codTipoCobranca"],"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCondVenda":{"type":"integer","maximum":99999,"description":"Condição de Venda"},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codAtendente":{"type":"string","description":"Código do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto":{"type":"number","multipleOf":0.01,"description":"Desconto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Serviço"},"observacaoNota":{"type":"string","maxLength":1000,"description":"Observação para a Nota Fiscal"},"listaServicos":{"type":"array","description":"Itens do Pedido de Serviço","items":{"$ref":"#/components/schemas/ListaServico"}},"listaProdutosFaturar":{"type":"array","description":"Lista de Produtos para Faturar","items":{"$ref":"#/components/schemas/ListaProdutoFaturar"}},"listaProdutosRemessa":{"type":"array","description":"Lista de Produtos para Remessa","items":{"$ref":"#/components/schemas/ListaProdutoRemessa"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaServico":{"type":"object","required":["codServico","undServico","qtdServico","precoUNServicoLiquido","codServico116","codNBS","codIndicadorOperacao","cepMunGer","localPrestacao","cepLocPrestServ"],"properties":{"codServico":{"description":"Código do Serviço","type":"integer","maximum":9999},"complementoServico":{"type":"string","maxLength":1000,"description":"Complemento Serviço (NFS-e)"},"undServico":{"type":"string","maxLength":6,"description":"Medida de Unidade do Serviço"},"qtdServico":{"type":"number","multipleOf":0.001,"description":"Quantidade do Serviço"},"precoUNServicoLiquido":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Líquido do Serviço"},"precoBrutoUNServico":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Bruto do Serviço"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto Item"},"aliquotaISS":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do ISS"},"percIRRF":{"type":"number","multipleOf":0.01,"description":"Percentual IRRF"},"percComisRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"percComisAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"codServico116":{"type":"string","maxLength":6,"description":"Código da lista de serviços da Lei Complementar 116/2003"},"codNBS":{"type":"string","maxLength":12,"description":"Código do NBS"},"codOAT":{"type":"string","maxLength":6,"description":"Código da Ordem de Assistência Técnica"},"codIndicadorOperacao":{"type":"string","maxLength":6,"description":"Indicador da Operação"},"percReducaoISS":{"type":"number","multipleOf":0.00001,"description":"PPercentual de redução do ISS"},"codMSGReducao":{"type":"integer","maximum":99999,"description":"Código da Mensagem Redução ISS"},"tipoTributacao":{"type":"integer","description":"Tipo de Tributação (0-Normal, 1-Retida, 2-Substituida, 3-Isenta)","enum":[0,1,2,3]},"cepMunGer":{"type":"integer","maximum":99999,"description":"CEP do Município Ocorrência do Fato Gerador"},"localPrestacao":{"type":"integer","description":"Local Prestação do Serviço (1-Município Prestador, 2-Município Tomador, 3-Outro Município)","enum":[1,2,3]},"cepLocPrestServ":{"type":"string","maxLength":8,"description":"CEP Local Prestação do Serviço"},"codCEI":{"type":"string","maxLength":15,"description":"Código CEI/CNO (Obra)"},"matriculaObra":{"type":"string","maxLength":15,"description":"Matrícula da Obra"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ListaProdutoFaturar":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaProdutoRemessa":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"PedidoServicoGet":{"type":"object","properties":{"codPedido":{"type":"integer","maximum":999999999,"description":"Código do Pedido de Serviço"},"situacaoPedido":{"type":"integer","description":"Situação do Pedido (0-Aberto, 1-Faturado, 2-Cancelado)","enum":[0,1,2]},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCondVenda":{"type":"integer","maximum":99999,"description":"Condição de Venda"},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codAtendente":{"type":"string","description":"Código do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto":{"type":"number","multipleOf":0.01,"description":"Desconto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Serviço"},"observacaoNota":{"type":"string","maxLength":1000,"description":"Observação para a Nota Fiscal"},"listaServicos":{"type":"array","description":"Itens do Pedido de Serviço","items":{"$ref":"#/components/schemas/ListaServico"}},"listaProdutosFaturar":{"type":"array","description":"Lista de Produtos para Faturar","items":{"$ref":"#/components/schemas/ListaProdutoFaturar"}},"listaProdutosRemessa":{"type":"array","description":"Lista de Produtos para Remessa","items":{"$ref":"#/components/schemas/ListaProdutoRemessa"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoServico/{codPedido}":{"post":{"tags":["Pedido de Serviço"],"summary":"Atualizar um Pedido de Serviço","operationId":"AtualizarPedidoServico","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codPedido","in":"path","description":"Código do Pedido de Serviço","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Pedido de Serviço","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoServicoPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoServicoGet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /pedidoServico/{codPedido} > Exclui um Pedido de Serviço ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Pedido de Serviço","description":"pedidoservico"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoServico/{codPedido}":{"delete":{"summary":"Exclui um Pedido de Serviço","operationId":"ExcluirPedidoServico","tags":["Pedido de Serviço"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","required":true,"description":"Código da Empresa","schema":{"type":"string"}},{"name":"codPedido","in":"path","description":"Código do Pedido de Serviço","required":true,"schema":{"type":"string"}}]}}}} ``` ## POST /pedidoServico/{codPedido}/cancelar > Cancelar um Pedido de Serviço ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"tags":[{"name":"Pedido de Serviço","description":"pedidoservico"}],"servers":[{"url":"https://localhost/comercialpedidoservico/v10"},{"url":"http://localhost/comercialpedidoservico/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"DadosCancelarPedidoServico":{"type":"object","required":["codMotivoCancelar"],"properties":{"codMotivoCancelar":{"type":"integer","maximum":99,"description":"Código do Motivo de Cancelamento"},"detMotivoCancelar":{"type":"string","maxLength":1000,"description":"Detalhes do Cancelamento do Pedido de Serviço"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"PedidoServicoGet":{"type":"object","properties":{"codPedido":{"type":"integer","maximum":999999999,"description":"Código do Pedido de Serviço"},"situacaoPedido":{"type":"integer","description":"Situação do Pedido (0-Aberto, 1-Faturado, 2-Cancelado)","enum":[0,1,2]},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCondVenda":{"type":"integer","maximum":99999,"description":"Condição de Venda"},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codAtendente":{"type":"string","description":"Código do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto":{"type":"number","multipleOf":0.01,"description":"Desconto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Serviço"},"observacaoNota":{"type":"string","maxLength":1000,"description":"Observação para a Nota Fiscal"},"listaServicos":{"type":"array","description":"Itens do Pedido de Serviço","items":{"$ref":"#/components/schemas/ListaServico"}},"listaProdutosFaturar":{"type":"array","description":"Lista de Produtos para Faturar","items":{"$ref":"#/components/schemas/ListaProdutoFaturar"}},"listaProdutosRemessa":{"type":"array","description":"Lista de Produtos para Remessa","items":{"$ref":"#/components/schemas/ListaProdutoRemessa"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaServico":{"type":"object","required":["codServico","undServico","qtdServico","precoUNServicoLiquido","codServico116","codNBS","codIndicadorOperacao","cepMunGer","localPrestacao","cepLocPrestServ"],"properties":{"codServico":{"description":"Código do Serviço","type":"integer","maximum":9999},"complementoServico":{"type":"string","maxLength":1000,"description":"Complemento Serviço (NFS-e)"},"undServico":{"type":"string","maxLength":6,"description":"Medida de Unidade do Serviço"},"qtdServico":{"type":"number","multipleOf":0.001,"description":"Quantidade do Serviço"},"precoUNServicoLiquido":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Líquido do Serviço"},"precoBrutoUNServico":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Bruto do Serviço"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto Item"},"aliquotaISS":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do ISS"},"percIRRF":{"type":"number","multipleOf":0.01,"description":"Percentual IRRF"},"percComisRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"percComisAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"codServico116":{"type":"string","maxLength":6,"description":"Código da lista de serviços da Lei Complementar 116/2003"},"codNBS":{"type":"string","maxLength":12,"description":"Código do NBS"},"codOAT":{"type":"string","maxLength":6,"description":"Código da Ordem de Assistência Técnica"},"codIndicadorOperacao":{"type":"string","maxLength":6,"description":"Indicador da Operação"},"percReducaoISS":{"type":"number","multipleOf":0.00001,"description":"PPercentual de redução do ISS"},"codMSGReducao":{"type":"integer","maximum":99999,"description":"Código da Mensagem Redução ISS"},"tipoTributacao":{"type":"integer","description":"Tipo de Tributação (0-Normal, 1-Retida, 2-Substituida, 3-Isenta)","enum":[0,1,2,3]},"cepMunGer":{"type":"integer","maximum":99999,"description":"CEP do Município Ocorrência do Fato Gerador"},"localPrestacao":{"type":"integer","description":"Local Prestação do Serviço (1-Município Prestador, 2-Município Tomador, 3-Outro Município)","enum":[1,2,3]},"cepLocPrestServ":{"type":"string","maxLength":8,"description":"CEP Local Prestação do Serviço"},"codCEI":{"type":"string","maxLength":15,"description":"Código CEI/CNO (Obra)"},"matriculaObra":{"type":"string","maxLength":15,"description":"Matrícula da Obra"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaProdutoFaturar":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaProdutoRemessa":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoServico/{codPedido}/cancelar":{"post":{"tags":["Pedido de Serviço"],"summary":"Cancelar um Pedido de Serviço","operationId":"CancelarPedidoServico","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codPedido","in":"path","description":"Código do Pedido de Serviço","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para cancelamento do Pedido de Serviço","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DadosCancelarPedidoServico"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoServicoGet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The ListaServicosLei1162003 object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaServicosLei1162003":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaServicosLei1162003":{"type":"array","items":{"$ref":"#/components/schemas/ServicoLei1162003"}}}},"ServicoLei1162003":{"type":"object","properties":{"codServicoLei1162003":{"type":"string","description":"Código do Serviço Lei 116/2003"},"descricao":{"type":"string","description":"Descrição do Serviço Lei 116/2003"}}}}}} ``` ## The ServicoLei1162003 object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ServicoLei1162003":{"type":"object","properties":{"codServicoLei1162003":{"type":"string","description":"Código do Serviço Lei 116/2003"},"descricao":{"type":"string","description":"Descrição do Serviço Lei 116/2003"}}}}}} ``` ## The ListaNBS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaNBS":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaNBS":{"type":"array","items":{"$ref":"#/components/schemas/NBS"}}}},"NBS":{"type":"object","properties":{"codNBS":{"type":"string","description":"Código do NBS"},"descricao":{"type":"string","description":"Descrição do NBS"}}}}}} ``` ## The NBS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"NBS":{"type":"object","properties":{"codNBS":{"type":"string","description":"Código do NBS"},"descricao":{"type":"string","description":"Descrição do NBS"}}}}}} ``` ## The ListaIndicadoresOperacao object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaIndicadoresOperacao":{"type":"object","properties":{"continuationToken":{"type":"string"},"listaIndicadoresOperacao":{"type":"array","items":{"$ref":"#/components/schemas/IndicadorOperacao"}}}},"IndicadorOperacao":{"type":"object","properties":{"codIndicador":{"type":"string","description":"Código do Indicador de Operação do Serviço"},"nomeOperacao":{"type":"string","maxLength":300,"description":"Nome da Operação"},"textoDispLegal":{"type":"string","maxLength":300,"description":"Texto do Dispositivo Legal"},"textoLocalOperacao":{"type":"string","maxLength":300,"description":"Texto de Local de Operação"},"textoLocalFornec":{"type":"string","maxLength":300,"description":"Texto de Local do Fornecimento"},"textoCaractFornec":{"type":"string","maxLength":300,"description":"Texto de Caracterização do Fornecimento"},"dataPublicacao":{"type":"string","format":"date","description":"Data de Publicação (YYYY-MM-DD)"},"dataIniVig":{"type":"string","format":"date","description":"Data Início de Vigência (YYYY-MM-DD)"},"dataFimVig":{"type":"string","format":"date","description":"Data Fim de Vigência (YYYY-MM-DD)"}}}}}} ``` ## The IndicadorOperacao object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"IndicadorOperacao":{"type":"object","properties":{"codIndicador":{"type":"string","description":"Código do Indicador de Operação do Serviço"},"nomeOperacao":{"type":"string","maxLength":300,"description":"Nome da Operação"},"textoDispLegal":{"type":"string","maxLength":300,"description":"Texto do Dispositivo Legal"},"textoLocalOperacao":{"type":"string","maxLength":300,"description":"Texto de Local de Operação"},"textoLocalFornec":{"type":"string","maxLength":300,"description":"Texto de Local do Fornecimento"},"textoCaractFornec":{"type":"string","maxLength":300,"description":"Texto de Caracterização do Fornecimento"},"dataPublicacao":{"type":"string","format":"date","description":"Data de Publicação (YYYY-MM-DD)"},"dataIniVig":{"type":"string","format":"date","description":"Data Início de Vigência (YYYY-MM-DD)"},"dataFimVig":{"type":"string","format":"date","description":"Data Fim de Vigência (YYYY-MM-DD)"}}}}}} ``` ## The ListaMensagemReducaoISS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaMensagemReducaoISS":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaMensagensReducaoISS":{"type":"array","items":{"$ref":"#/components/schemas/MensagemReducao"}}}},"MensagemReducao":{"type":"object","properties":{"codMensagem":{"type":"integer","description":"Código da Mensagem"},"descricao":{"type":"string","maxLength":66,"description":"Mensagem de Redução do ISS"}}}}}} ``` ## The MensagemReducao object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"MensagemReducao":{"type":"object","properties":{"codMensagem":{"type":"integer","description":"Código da Mensagem"},"descricao":{"type":"string","maxLength":66,"description":"Mensagem de Redução do ISS"}}}}}} ``` ## The ListaObras object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaObras":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"listaObras":{"type":"array","items":{"$ref":"#/components/schemas/Obra"}}}},"Obra":{"type":"object","properties":{"codObra":{"type":"integer","maximum":999999,"description":"Código da Obra"},"cnocei":{"type":"integer","maximum":99999999999999,"description":"CNO/CEI"},"numeroMatricula":{"type":"integer","maximum":99999999999999,"description":"Número da Matrícula"},"descObra":{"type":"string","maxLength":45,"description":"Número da Matrícula"},"empreitada":{"type":"integer","description":"Tipo Empreitada (1-Empreitada Total, 2-Empreitada Parcial)","enum":[1,2]},"tipoCNO":{"type":"integer","description":"Tipo CNO (1-Própria, 2-Terceiros)","enum":[1,2]},"dataObraEncerrada":{"type":"string","format":"date","description":"Data de Encerramento da Obra (YYYY-MM-DD)"}}}}}} ``` ## The Obra object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"Obra":{"type":"object","properties":{"codObra":{"type":"integer","maximum":999999,"description":"Código da Obra"},"cnocei":{"type":"integer","maximum":99999999999999,"description":"CNO/CEI"},"numeroMatricula":{"type":"integer","maximum":99999999999999,"description":"Número da Matrícula"},"descObra":{"type":"string","maxLength":45,"description":"Número da Matrícula"},"empreitada":{"type":"integer","description":"Tipo Empreitada (1-Empreitada Total, 2-Empreitada Parcial)","enum":[1,2]},"tipoCNO":{"type":"integer","description":"Tipo CNO (1-Própria, 2-Terceiros)","enum":[1,2]},"dataObraEncerrada":{"type":"string","format":"date","description":"Data de Encerramento da Obra (YYYY-MM-DD)"}}}}}} ``` ## The ListaPedidosServico object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaPedidosServico":{"type":"object","properties":{"continuationToken":{"type":"string"},"listaPedidosServico":{"type":"array","items":{"$ref":"#/components/schemas/ListaPedidoServico"}}}},"ListaPedidoServico":{"type":"object","properties":{"codPedido":{"type":"integer","maximum":9,"description":"Código do Pedido de Serviço"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"vlrTotal":{"type":"number","multipleOf":0.01,"description":"Valor do Pedido Serviço"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevisao":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"dataFaturado":{"type":"string","format":"date","description":"Data de Faturamento (YYYY-MM-DD)"},"numNFSe":{"type":"string","description":"Número da NFS-e"},"sitPedido":{"type":"integer","description":"Situação do Pedido (0 - Aberto, 1-Faturado, 2-Cancelado)"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaPedidoServico object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaPedidoServico":{"type":"object","properties":{"codPedido":{"type":"integer","maximum":9,"description":"Código do Pedido de Serviço"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"vlrTotal":{"type":"number","multipleOf":0.01,"description":"Valor do Pedido Serviço"},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevisao":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"dataFaturado":{"type":"string","format":"date","description":"Data de Faturamento (YYYY-MM-DD)"},"numNFSe":{"type":"string","description":"Número da NFS-e"},"sitPedido":{"type":"integer","description":"Situação do Pedido (0 - Aberto, 1-Faturado, 2-Cancelado)"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The PedidoServicoGet object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"PedidoServicoGet":{"type":"object","properties":{"codPedido":{"type":"integer","maximum":999999999,"description":"Código do Pedido de Serviço"},"situacaoPedido":{"type":"integer","description":"Situação do Pedido (0-Aberto, 1-Faturado, 2-Cancelado)","enum":[0,1,2]},"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCondVenda":{"type":"integer","maximum":99999,"description":"Condição de Venda"},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codAtendente":{"type":"string","description":"Código do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto":{"type":"number","multipleOf":0.01,"description":"Desconto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Serviço"},"observacaoNota":{"type":"string","maxLength":1000,"description":"Observação para a Nota Fiscal"},"listaServicos":{"type":"array","description":"Itens do Pedido de Serviço","items":{"$ref":"#/components/schemas/ListaServico"}},"listaProdutosFaturar":{"type":"array","description":"Lista de Produtos para Faturar","items":{"$ref":"#/components/schemas/ListaProdutoFaturar"}},"listaProdutosRemessa":{"type":"array","description":"Lista de Produtos para Remessa","items":{"$ref":"#/components/schemas/ListaProdutoRemessa"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaServico":{"type":"object","required":["codServico","undServico","qtdServico","precoUNServicoLiquido","codServico116","codNBS","codIndicadorOperacao","cepMunGer","localPrestacao","cepLocPrestServ"],"properties":{"codServico":{"description":"Código do Serviço","type":"integer","maximum":9999},"complementoServico":{"type":"string","maxLength":1000,"description":"Complemento Serviço (NFS-e)"},"undServico":{"type":"string","maxLength":6,"description":"Medida de Unidade do Serviço"},"qtdServico":{"type":"number","multipleOf":0.001,"description":"Quantidade do Serviço"},"precoUNServicoLiquido":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Líquido do Serviço"},"precoBrutoUNServico":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Bruto do Serviço"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto Item"},"aliquotaISS":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do ISS"},"percIRRF":{"type":"number","multipleOf":0.01,"description":"Percentual IRRF"},"percComisRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"percComisAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"codServico116":{"type":"string","maxLength":6,"description":"Código da lista de serviços da Lei Complementar 116/2003"},"codNBS":{"type":"string","maxLength":12,"description":"Código do NBS"},"codOAT":{"type":"string","maxLength":6,"description":"Código da Ordem de Assistência Técnica"},"codIndicadorOperacao":{"type":"string","maxLength":6,"description":"Indicador da Operação"},"percReducaoISS":{"type":"number","multipleOf":0.00001,"description":"PPercentual de redução do ISS"},"codMSGReducao":{"type":"integer","maximum":99999,"description":"Código da Mensagem Redução ISS"},"tipoTributacao":{"type":"integer","description":"Tipo de Tributação (0-Normal, 1-Retida, 2-Substituida, 3-Isenta)","enum":[0,1,2,3]},"cepMunGer":{"type":"integer","maximum":99999,"description":"CEP do Município Ocorrência do Fato Gerador"},"localPrestacao":{"type":"integer","description":"Local Prestação do Serviço (1-Município Prestador, 2-Município Tomador, 3-Outro Município)","enum":[1,2,3]},"cepLocPrestServ":{"type":"string","maxLength":8,"description":"CEP Local Prestação do Serviço"},"codCEI":{"type":"string","maxLength":15,"description":"Código CEI/CNO (Obra)"},"matriculaObra":{"type":"string","maxLength":15,"description":"Matrícula da Obra"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ListaProdutoFaturar":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaProdutoRemessa":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}}} ``` ## The PedidoServicoPut object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"PedidoServicoPut":{"required":["codCliente","codTipoNF","codRepresentante","codCondVenda","codPortador","codTipoCobranca"],"type":"object","properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de Emissão do Pedido de Serviço (YYYY-MM-DD)"},"dataPrevFat":{"type":"string","format":"date","description":"Data de Previsão de Faturamento (YYYY-MM-DD)"},"codCliente":{"type":"integer","maximum":9999999,"description":"Código do Cliente"},"codRepresentante":{"type":"integer","maximum":9999,"description":"Código do Representante"},"codTipoNF":{"type":"integer","maximum":9999,"description":"Código do Tipo de Nota"},"codCondVenda":{"type":"integer","maximum":99999,"description":"Condição de Venda"},"codPortador":{"type":"integer","maximum":9999,"description":"Código do Portador"},"codTipoCobranca":{"type":"integer","maximum":99,"description":"Código do Tipo de Cobrança"},"vlrAntecipado":{"type":"number","multipleOf":0.01,"description":"Valor pago antecipadamente"},"codAtendente":{"type":"string","description":"Código do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"desconto":{"type":"number","multipleOf":0.01,"description":"Desconto"},"codPedidoCliente":{"type":"string","maxLength":15,"description":"Código do Pedido do Cliente"},"observacaoPedido":{"type":"string","maxLength":1000,"description":"Observação para o Pedido de Serviço"},"observacaoNota":{"type":"string","maxLength":1000,"description":"Observação para a Nota Fiscal"},"listaServicos":{"type":"array","description":"Itens do Pedido de Serviço","items":{"$ref":"#/components/schemas/ListaServico"}},"listaProdutosFaturar":{"type":"array","description":"Lista de Produtos para Faturar","items":{"$ref":"#/components/schemas/ListaProdutoFaturar"}},"listaProdutosRemessa":{"type":"array","description":"Lista de Produtos para Remessa","items":{"$ref":"#/components/schemas/ListaProdutoRemessa"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaServico":{"type":"object","required":["codServico","undServico","qtdServico","precoUNServicoLiquido","codServico116","codNBS","codIndicadorOperacao","cepMunGer","localPrestacao","cepLocPrestServ"],"properties":{"codServico":{"description":"Código do Serviço","type":"integer","maximum":9999},"complementoServico":{"type":"string","maxLength":1000,"description":"Complemento Serviço (NFS-e)"},"undServico":{"type":"string","maxLength":6,"description":"Medida de Unidade do Serviço"},"qtdServico":{"type":"number","multipleOf":0.001,"description":"Quantidade do Serviço"},"precoUNServicoLiquido":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Líquido do Serviço"},"precoBrutoUNServico":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Bruto do Serviço"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto Item"},"aliquotaISS":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do ISS"},"percIRRF":{"type":"number","multipleOf":0.01,"description":"Percentual IRRF"},"percComisRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"percComisAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"codServico116":{"type":"string","maxLength":6,"description":"Código da lista de serviços da Lei Complementar 116/2003"},"codNBS":{"type":"string","maxLength":12,"description":"Código do NBS"},"codOAT":{"type":"string","maxLength":6,"description":"Código da Ordem de Assistência Técnica"},"codIndicadorOperacao":{"type":"string","maxLength":6,"description":"Indicador da Operação"},"percReducaoISS":{"type":"number","multipleOf":0.00001,"description":"PPercentual de redução do ISS"},"codMSGReducao":{"type":"integer","maximum":99999,"description":"Código da Mensagem Redução ISS"},"tipoTributacao":{"type":"integer","description":"Tipo de Tributação (0-Normal, 1-Retida, 2-Substituida, 3-Isenta)","enum":[0,1,2,3]},"cepMunGer":{"type":"integer","maximum":99999,"description":"CEP do Município Ocorrência do Fato Gerador"},"localPrestacao":{"type":"integer","description":"Local Prestação do Serviço (1-Município Prestador, 2-Município Tomador, 3-Outro Município)","enum":[1,2,3]},"cepLocPrestServ":{"type":"string","maxLength":8,"description":"CEP Local Prestação do Serviço"},"codCEI":{"type":"string","maxLength":15,"description":"Código CEI/CNO (Obra)"},"matriculaObra":{"type":"string","maxLength":15,"description":"Matrícula da Obra"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ListaProdutoFaturar":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ListaProdutoRemessa":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}}} ``` ## The ListaServico object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaServico":{"type":"object","required":["codServico","undServico","qtdServico","precoUNServicoLiquido","codServico116","codNBS","codIndicadorOperacao","cepMunGer","localPrestacao","cepLocPrestServ"],"properties":{"codServico":{"description":"Código do Serviço","type":"integer","maximum":9999},"complementoServico":{"type":"string","maxLength":1000,"description":"Complemento Serviço (NFS-e)"},"undServico":{"type":"string","maxLength":6,"description":"Medida de Unidade do Serviço"},"qtdServico":{"type":"number","multipleOf":0.001,"description":"Quantidade do Serviço"},"precoUNServicoLiquido":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Líquido do Serviço"},"precoBrutoUNServico":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário Bruto do Serviço"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Percentual, 1 - Valor)","enum":[0,1]},"descontoItem":{"type":"number","multipleOf":0.01,"description":"Desconto Item"},"aliquotaISS":{"type":"number","multipleOf":0.01,"description":"Percentual de Redução do ISS"},"percIRRF":{"type":"number","multipleOf":0.01,"description":"Percentual IRRF"},"percComisRepresentante":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Representante"},"percComisAtendente":{"type":"number","multipleOf":0.01,"description":"Percentual de Comissão do Atendente"},"codServico116":{"type":"string","maxLength":6,"description":"Código da lista de serviços da Lei Complementar 116/2003"},"codNBS":{"type":"string","maxLength":12,"description":"Código do NBS"},"codOAT":{"type":"string","maxLength":6,"description":"Código da Ordem de Assistência Técnica"},"codIndicadorOperacao":{"type":"string","maxLength":6,"description":"Indicador da Operação"},"percReducaoISS":{"type":"number","multipleOf":0.00001,"description":"PPercentual de redução do ISS"},"codMSGReducao":{"type":"integer","maximum":99999,"description":"Código da Mensagem Redução ISS"},"tipoTributacao":{"type":"integer","description":"Tipo de Tributação (0-Normal, 1-Retida, 2-Substituida, 3-Isenta)","enum":[0,1,2,3]},"cepMunGer":{"type":"integer","maximum":99999,"description":"CEP do Município Ocorrência do Fato Gerador"},"localPrestacao":{"type":"integer","description":"Local Prestação do Serviço (1-Município Prestador, 2-Município Tomador, 3-Outro Município)","enum":[1,2,3]},"cepLocPrestServ":{"type":"string","maxLength":8,"description":"CEP Local Prestação do Serviço"},"codCEI":{"type":"string","maxLength":15,"description":"Código CEI/CNO (Obra)"},"matriculaObra":{"type":"string","maxLength":15,"description":"Matrícula da Obra"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaProdutoFaturar object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaProdutoFaturar":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaProdutoRemessa object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"ListaProdutoRemessa":{"type":"object","required":["codProduto","qtdProduto"],"properties":{"codProduto":{"description":"Código do Produto","type":"string"},"qtdProduto":{"type":"number","multipleOf":0.001,"description":"Quantidade"},"precoUnitario":{"type":"number","multipleOf":0.0001,"description":"Preço Unitário"},"percentualIPI":{"type":"number","multipleOf":0.01,"description":"Percentual de IPI"},"transacaoEstoque":{"type":"string","maxLength":4,"description":"Código da Transação de Estoque"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCancelarPedidoServico object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"DadosCancelarPedidoServico":{"type":"object","required":["codMotivoCancelar"],"properties":{"codMotivoCancelar":{"type":"integer","maximum":99,"description":"Código do Motivo de Cancelamento"},"detMotivoCancelar":{"type":"string","maxLength":1000,"description":"Detalhes do Cancelamento do Pedido de Serviço"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Comercial Pedido de Serviço","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Seleção Especial v1.0 # Seleção Especial selecaoespecial ## PUT /selecaoespecial > Gerar Seleção Especial ```json {"openapi":"3.0.1","info":{"title":"Comercial Seleção Especial","version":"1.0"},"tags":[{"name":"Seleção Especial","description":"selecaoespecial"}],"servers":[{"url":"https://localhost/selecaoespecial/v10"},{"url":"http://localhost/selecaoespecial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"SelecaoEspecial":{"required":["atendimentoPresencial","codCliente","codRepresentante","codTipoNota","condicaoVenda","consumoProprio","retiraICMSbasePisCofins"],"type":"object","properties":{"codCliente":{"maximum":99999999999999,"type":"integer","description":"Código do Cliente"},"codRepresentante":{"maximum":9999,"type":"integer","description":"Código do Representante"},"codTipoNota":{"maximum":9999,"type":"integer","description":"Tipo de Nota"},"consumoProprio":{"type":"integer","description":"Consumo Próprio (0 - Não, 1 - Sim)","enum":[0,1]},"condicaoVenda":{"maximum":9999,"type":"integer","description":"Condição de Venda"},"codAtendente":{"maximum":9999,"type":"integer","description":"Atendente"},"cfop":{"maximum":9,"type":"integer","description":"Primeiro Dígito da Cfop"},"codTransportadora":{"maximum":9999,"type":"integer","description":"Código da Transportadora"},"tipoFrete":{"maximum":9999,"type":"integer","description":"Código do Tipo de Frete"},"tabelaPreco":{"maximum":9999,"type":"integer","description":"Código da Tablea de Preço"},"valorOutrasDespesas":{"multipleOf":0.01,"maximum":9999999999.99,"minimum":0.01,"type":"number","description":"Valor de Outras Despesas"},"desconto1":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 1"},"desconto2":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 2"},"desconto3":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 3"},"desconto4":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 4"},"acrescimo1":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 1"},"acrescimo2":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 2"},"acrescimo3":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 3"},"acrescimo4":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 4"},"valorAntecipado":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.01,"type":"number","description":"Valor Antecipado"},"valorDesconto":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.01,"type":"number","description":"Valor Desconto"},"pedidoCliente":{"maxLength":15,"type":"string","description":"Código do Pedido do Cliente"},"pedidoRepresentante":{"maxLength":10,"type":"string","description":"Código do Pedido do Representante"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0-Não se Aplica, 1-Operação Presencial, 2-Operação Não Presencial - Pela Internet, 3-Operação Não Presencial - Teleatendimento,9-Operação Não Presencial - Outros) (0 - NAO SE APLICA, 1 - OPERACAO PRESENCIAL, 2 - OPERACAO NAO PRESENCIAL PELA INTERNET, 3 - OPERACAO NAO PRESENCIAL TELEATENDIMENTO, 5 - OPERAÇÃO PRESENCIAL FORA DO ESTABELECIMENTO, 9 - OPERACAO NAO PRESENCIAL OUTROS)","enum":[0,1,2,3,9]},"intermediadorTransacao":{"maximum":999,"type":"integer","description":"Intermediador da Transação"},"retiraICMSbasePisCofins":{"type":"integer","description":"Retirar Icms da Base Pis/cofins (0 - Não, 1 - Sim)","enum":[0,1]},"processoRegimeEspecial":{"maxLength":60,"type":"string","description":"Processo/ato Concessório Regime Especial"},"origemProcesso":{"type":"integer","description":"Origem do Processo (0 - SEFAZ, 1 - Justiça Federal, 2 - Justiça Estadual, 3 - Secex/RFB, 9 - Outros)","enum":[0,1,2,3,9]},"tipoAto":{"type":"integer","description":"Tipo do Ato Concessório (8 - Termo de Acordo, 10 - Regime Especial, 12 - Autorização específica)","enum":[8,10,12]},"obsRegimeEspecial":{"maximum":9999,"type":"integer","description":"Observação Regime Especial"},"seguroSocial":{"type":"integer","description":"Seguro Social (0 - Não, 1 - Sim)","enum":[0,1]},"estruturaComercial":{"type":"integer","description":"Estrutura Comercial"},"codRedespacho":{"type":"integer","description":"Transportadora de Redespacho"},"tipoFreteRedespacho":{"maximum":99,"type":"integer","description":"Tipo de Frete de Redespacho"},"valorFrete":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Frete"},"valorSeguro":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Seguro"},"calcPeso":{"type":"integer","description":"Calcular Peso Automaticamente (0 - Não, 1 - Sim)","enum":[0,1]},"pesoLiquido":{"multipleOf":0.001,"maximum":99999999.999,"type":"number","description":"Peso Líquido"},"pesoBruto":{"multipleOf":0.001,"maximum":99999999.999,"type":"number","description":"Peso Bruto"},"qtdVolumes":{"maximum":9999999999,"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"maxLength":60,"type":"string","description":"Espécie de Volume"},"qtdPecas":{"maximum":999,"type":"integer","description":"Quantidade de Peças da Seleção Especial"},"dataSaida":{"type":"string","description":"Data de Saída (YYYY-MM-DD)","format":"date"},"horaSaida":{"maxLength":5,"minLength":5,"pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string","description":"Hora do Cálculo (HH:MM)"},"placa":{"maxLength":7,"type":"string","description":"Placa do Veículo"},"ufPlaca":{"maxLength":2,"type":"string","description":"uf da Placa"},"cpfMotorista":{"maxLength":14,"minLength":1,"type":"string","description":"Cpf do Motorista (sem formatação"},"nomeMotorista":{"maxLength":20,"type":"string","description":"Nome do Motorista"},"vencimentoEsp":{"maxItems":18,"type":"array","description":"Dias de Vencimento Especial (Obrigatório para condição de venda 99)","items":{"type":"string","format":"date"}},"codPortador":{"maximum":9999,"type":"integer","description":"Código do Portador"},"tipoCobranca":{"maximum":9999,"type":"integer","description":"Código do Tipo de Cobrança"},"percDescDuplicata":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Porcentagem de Desconto da Duplicata"},"diasDescDuplicata":{"maximum":99,"type":"integer","description":"Dias de Desconto da Duplicata"},"ajustaValorManual":{"type":"integer","description":"Ajustar Valor/Vencimento Manualmente (0 - Não, 1 - Sim)","enum":[0,1]},"formaPagamento":{"type":"string","description":" Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 15 - Boleto Bancário, 16 - Depósito Bancário, 17 - Pagamento Instantâneo (Pix) QR-Code - Estático, 18 - Transferência bancária, 19 - Carteira Digital, 20 - Pagamento Instantâneo (Pix) - Estático, 21 - Crédito em Loja, 22 - Pagamento Eletrônico não Informado - falha de hardware do sistema emissor, 90 - Sem pagamento, 99 - Outros)","enum":["01","02","03","04","05","10","11","12","13","15","16","17","18","19","20","21","22","90","99"]},"dataPagamento":{"type":"string","description":"Data de Saída (YYYY-MM-DD)","format":"date"},"cnpjLocalPagamento":{"type":"string","description":"CNPJ Local do Pagamento","format":"@'?.12AN2N"},"ufLocalPagamento":{"maxLength":2,"type":"string","description":"UF do Local do Pagamento"},"tipoIntegracao":{"type":"integer","description":"Tipo de Integração com a Máquina de Cartão (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Pagamento não integrado com o sistema de automação da empresa)","enum":[1,2]},"cnpjCredenciadora":{"type":"string","description":"CNPJ da Credenciadora","format":"@'?.12AN2N"},"bandeiraOperadora":{"type":"string","description":"Bandeira da Operadora (1 - Visa, 2 - Mastercard, 3 - American Express, 4 - Sorocred, 5 - Diners Club, 6 - Elo, 7 - Hipercard, 8 - Aura, 9 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"autorizacaoOpCartao":{"maxLength":20,"type":"string","description":"Código da Autorização da Operação"},"cnpjBeneficiarioPagamento":{"type":"string","description":"CNPJ Beneficiário do Pagamento","format":"@'?.12AN2N"},"terminalPagamento":{"maxLength":40,"type":"string","description":"Terminal de Pagamento"},"codMensagemNota":{"maximum":999,"type":"integer","description":"Código da Mensagem"},"obsNota":{"maxLength":1000,"type":"string","description":"Observações Para Nota"},"nomeTag":{"maxLength":20,"type":"string","description":"Nome da Tag"},"conteudoTag":{"maxLength":60,"type":"string","description":"Conteúdo da TAG"},"motivoEstorno":{"maxLength":55,"type":"string","description":"Motivo do estorno - nota fiscal de ajuste"},"outraIECliente":{"maxLength":15,"type":"string","description":"Cliente Inscrição Estadual"},"outraIETransportadora":{"maxLength":15,"type":"string","description":"Transportadora Inscrição Estadual"},"localEntrega":{"maxLength":40,"type":"string","description":"Nome do Local de Entrega"},"enderecoEntrega":{"maxLength":40,"type":"string","description":"Endereco do Local de Entrega"},"numeroCasa":{"maxLength":10,"type":"string","description":"Número do Endereço"},"complementoEntrega":{"maxLength":60,"type":"string","description":"Complemento do Endereço"},"bairroEntrega":{"maxLength":60,"type":"string","description":"Bairro de Entrega"},"cepEntrega":{"maximum":99999999,"type":"integer","description":"Cep do Local de Entrega"},"cnpjcpfEntrega":{"maximum":99999999999999,"type":"integer","description":"Cgc do Local de Entrega"},"ieEntrega":{"maxLength":18,"type":"string","description":"Incricao Estadual do Local de Entrega"},"foneEntrega":{"maxLength":20,"type":"string","description":"Telefone de Entrega"},"horaEntrega":{"maxLength":5,"minLength":5,"pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string","description":"Horario de Entrega (HH:MM)"},"codLocalColeta":{"maximum":99999,"type":"integer","description":"Código do Local de Coleta"},"ufEmbarque":{"maxLength":2,"type":"string","description":"UF de Embarque"},"localEmbarque":{"maxLength":50,"type":"string","description":"Local de Embarque"},"recintoAlfandegado":{"maxLength":50,"type":"string","description":"Recinto Alfandegado"},"docReferenciados":{"type":"array","description":"Chave NFe Referenciada","items":{"$ref":"#/components/schemas/NFeReferenciados"}},"ItensSelecaoEspecial":{"type":"array","description":"Itens Seleção Especial","items":{"$ref":"#/components/schemas/ItensSelecaoEspecial"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NFeReferenciados":{"type":"object","properties":{"chaveNFeReferenciada":{"maxLength":44,"minLength":44,"pattern":"^[0-9]{44}$","type":"string","description":"Chave de acesso da Nota Fiscal Eletrônica (NFe). Composta por 44 dígitos numéricos."}}},"ItensSelecaoEspecial":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto (aceita até 30 dígitos numéricos)"},"descricaoProduto":{"maxLength":140,"type":"string","description":"Descrição do Produto"},"unidade":{"maxLength":6,"type":"string","description":"Unidade de Medida do Item"},"quantidade":{"multipleOf":0.001,"maximum":99999999.999,"minimum":0.001,"type":"number","description":"Quantidade do Item (gravado Float)"},"precoUnitario":{"multipleOf":0.00001,"maximum":999999999.99999,"minimum":0.00001,"type":"number","description":"Preço Unitário do Item (gravado Float)"},"percentualIPI":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Ipi do Item"},"ncm":{"maximum":99999999,"type":"integer","description":"Ncm do Item"},"percentualICMS":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Icms do Item"},"percentualComissaoRepresentante":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Comissão do Representante"},"percentualComissaoAtendente":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Comissão do Atendente"},"origemMercadoria":{"type":"integer","description":"Código da Origem da Mercadoria (0 - Nacional, 1 - Estrangeira - Importação direta, 2 - Estrangeira - Adquirida no mercado interno, 3 - Nacional, com conteúdo importacao superior a 40% e inferior a 70%, 4 - Nacional, de acordo com processos produtivos básicos, 5 - Nacional, com conteúdo importação inferior a 40%, 6 - Estrangeira - Importação direta, sem similar nacional. (Camex), 7 - Estrangeira - Adquirida mercado interno, sem similar nacional. (Camex), 8 - Nacional, com conteúdo importação superior a 70%)","enum":[0,1,2,3,4,5,6,7,8]},"classificacaoFinalidade":{"type":"integer","description":"Código da Classificação Finalidade (1 - Item Venda, 2 - Item de Revenda, 3 - Item Consumo, 4 - Item Consumo/Revenda, 5 - Consumo/Venda)","enum":[1,2,3,4,5]},"percentualReducaoIcms":{"multipleOf":0.00001,"maximum":99.99999,"minimum":0.00001,"type":"number","description":"Porcentagem de Redução do Icms"},"codMsgRedIcms":{"maximum":999,"type":"integer","description":"Código da Mensagem de Redução de Icms"},"baseST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Base do Icms st"},"valorST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Icms st"},"aliquotaST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Alíquota do Icms st"},"percentualMVAST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem Mva do Icms"},"percentualFCPST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem Fcp do Icms st"},"valorFCPST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor Fcp Icms st"},"itemPedidoCliente":{"maximum":9999,"type":"integer","description":"Código do Item do Pedido do Cliente"},"valorIPIDevolvido":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Ipi Devolvido"},"cBenef":{"maxLength":12,"type":"string","description":"Código do Benefício Fiscal"},"transacaoEstoque":{"maximum":9999,"type":"integer","description":"Código de Transação do Estoque"},"codCest":{"maximum":99999999,"type":"integer","description":"Código Cest"},"codFinalidade":{"maximum":999999,"type":"integer","description":"Código de Finalidade do Produto"},"codigoANP":{"maximum":999999999,"type":"integer","description":"Código Anp do Produto"},"percentualDifalDevolucao":{"multipleOf":0.01,"maximum":99.99,"minimum":0,"type":"number","description":"Aliquota do Difal Para Nota de Devolução"},"qtdTributadaRetida":{"multipleOf":0.0001,"maximum":99999999999.9999,"minimum":0,"type":"number","description":"Quantidade Tributada Retida"},"aliquotaADRemRetido":{"multipleOf":0.0001,"maximum":999.9999,"minimum":0,"type":"number","description":"Alíquota ad Rem Retido"},"valorIcmsRetido":{"multipleOf":0.01,"maximum":9999999999999.99,"minimum":0,"type":"number","description":"Valor Icms Retido"},"percentualBiodiesel":{"multipleOf":0.0001,"maximum":999.9999,"minimum":0,"type":"number","description":"Percentual Mistura Biodiesel"},"ExportacaoIndireta":{"type":"array","description":"Item Dados Exportação Indireta","items":{"$ref":"#/components/schemas/ExportacaoIndireta"}},"Drawback":{"type":"array","description":"Ato Consessório Drawback","items":{"$ref":"#/components/schemas/Drawback"}}}},"ExportacaoIndireta":{"type":"object","properties":{"registroExportacao":{"maximum":999999999999,"type":"integer","description":"Valor Registro Exportação"},"chaveNFe":{"maxLength":44,"minLength":44,"pattern":"^[0-9]{44}$","type":"string","description":"Chave de acesso da Nota Fiscal Eletrônica (NFe). Composta por 44 dígitos numéricos."},"qtdExportada":{"multipleOf":0.001,"maximum":99999999.999,"minimum":0.001,"type":"number","description":"Quantidade Realmente Exportada"}}},"Drawback":{"type":"object","properties":{"atoConsessorioDrawback":{"maximum":99999999999,"type":"integer","description":"Número Ato Consessório"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"SelecaoEspecialGerada":{"required":["atendimentoPresencial","codCliente","codRepresentante","codTipoNota","condicaoVenda","consumoProprio","retiraICMSbasePisCofins"],"type":"object","properties":{"codSelecaoGerada":{"type":"integer","description":"Código da Seleção Especial que é gerado"},"codCliente":{"maximum":99999999999999,"type":"integer","description":"Código do Cliente"},"codRepresentante":{"maximum":9999,"type":"integer","description":"Código do Representante"},"codTipoNota":{"maximum":9999,"type":"integer","description":"Tipo de Nota"},"consumoProprio":{"type":"integer","description":"Consumo Próprio (0 - Não, 1 - Sim)","enum":[0,1]},"condicaoVenda":{"maximum":9999,"type":"integer","description":"Condição de Venda"},"codAtendente":{"maximum":9999,"type":"integer","description":"Atendente"},"cfop":{"maximum":9,"type":"integer","description":"Primeiro Dígito da Cfop"},"codTransportadora":{"maximum":9999,"type":"integer","description":"Código da Transportadora"},"tipoFrete":{"maximum":9999,"type":"integer","description":"Código do Tipo de Frete"},"tabelaPreco":{"maximum":9999,"type":"integer","description":"Código da Tablea de Preço"},"valorOutrasDespesas":{"multipleOf":0.01,"maximum":9999999999.99,"minimum":0.01,"type":"number","description":"Valor de Outras Despesas"},"desconto1":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 1"},"desconto2":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 2"},"desconto3":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 3"},"desconto4":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 4"},"acrescimo1":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 1"},"acrescimo2":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 2"},"acrescimo3":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 3"},"acrescimo4":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 4"},"valorAntecipado":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.01,"type":"number","description":"Valor Antecipado"},"valorDesconto":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.01,"type":"number","description":"Valor Desconto"},"pedidoCliente":{"maxLength":15,"type":"string","description":"Código do Pedido do Cliente"},"pedidoRepresentante":{"maxLength":10,"type":"string","description":"Código do Pedido do Representante"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0-Não se Aplica, 1-Operação Presencial, 2-Operação Não Presencial - Pela Internet, 3-Operação Não Presencial - Teleatendimento, 9-Operação Não Presencial - Outros) (0 - NAO SE APLICA, 1 - OPERACAO PRESENCIAL, 2 - OPERACAO NAO PRESENCIAL PELA INTERNET, 3 - OPERACAO NAO PRESENCIAL TELEATENDIMENTO, 5 - OPERAÇÃO PRESENCIAL FORA DO ESTABELECIMENTO, 9 - OPERACAO NAO PRESENCIAL OUTROS)","enum":[0,1,2,3,9]},"intermediadorTransacao":{"maximum":999,"type":"integer","description":"Intermediador da Transação"},"retiraICMSbasePisCofins":{"type":"integer","description":"Retirar Icms da Base Pis/cofins (0 - Não, 1 - Sim)","enum":[0,1]},"processoRegimeEspecial":{"maxLength":60,"type":"string","description":"Processo/ato Concessório Regime Especial"},"origemProcesso":{"type":"integer","description":"Origem do Processo (0 - SEFAZ, 1 - Justiça Federal, 2 - Justiça Estadual, 3 - Secex/RFB, 9 - Outros)","enum":[0,1,2,3,9]},"tipoAto":{"type":"integer","description":"Tipo do Ato Concessório (8 - Termo de Acordo, 10 - Regime Especial, 12 - Autorização específica)","enum":[8,10,12]},"obsRegimeEspecial":{"maximum":9999,"type":"integer","description":"Observação Regime Especial"},"seguroSocial":{"type":"integer","description":"Seguro Social (0 - Não, 1 - Sim)","enum":[0,1]},"estruturaComercial":{"type":"integer","description":"Estrutura Comercial"},"codRedespacho":{"type":"integer","description":"Transportadora de Redespacho"},"tipoFreteRedespacho":{"maximum":99,"type":"integer","description":"Tipo de Frete de Redespacho"},"valorFrete":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Frete"},"valorSeguro":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Seguro"},"calcPeso":{"type":"integer","description":"Calcular Peso Automaticamente (0 - Não, 1 - Sim)","enum":[0,1]},"pesoLiquido":{"multipleOf":0.001,"maximum":99999999.999,"type":"number","description":"Peso Líquido"},"pesoBruto":{"multipleOf":0.001,"maximum":99999999.999,"type":"number","description":"Peso Bruto"},"qtdVolumes":{"maximum":9999999999,"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"maxLength":60,"type":"string","description":"Espécie de Volume"},"qtdPecas":{"maximum":999,"type":"integer","description":"Quantidade de Peças da Seleção Especial"},"dataSaida":{"type":"string","description":"Data de Saída (YYYY-MM-DD)","format":"date"},"horaSaida":{"maxLength":5,"minLength":5,"pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string","description":"Hora do Cálculo (HH:MM)"},"placa":{"maxLength":7,"type":"string","description":"Placa do Veículo"},"ufPlaca":{"maxLength":2,"type":"string","description":"uf da Placa"},"cpfMotorista":{"maxLength":14,"minLength":1,"type":"string","description":"Cpf do Motorista (sem formatação"},"nomeMotorista":{"maxLength":20,"type":"string","description":"Nome do Motorista"},"vencimentoEsp":{"maxItems":18,"type":"array","description":"Dias de Vencimento Especial (Obrigatório para condição de venda 99)","items":{"type":"string","format":"date"}},"codPortador":{"maximum":9999,"type":"integer","description":"Código do Portador"},"tipoCobranca":{"maximum":9999,"type":"integer","description":"Código do Tipo de Cobrança"},"percDescDuplicata":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Porcentagem de Desconto da Duplicata"},"diasDescDuplicata":{"maximum":99,"type":"integer","description":"Dias de Desconto da Duplicata"},"ajustaValorManual":{"type":"integer","description":"Ajustar Valor/Vencimento Manualmente (0 - Não, 1 - Sim)","enum":[0,1]},"formaPagamento":{"type":"string","description":" Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 15 - Boleto Bancário, 16 - Depósito Bancário, 17 - Pagamento Instantâneo (Pix) QR-Code - Estático, 18 - Transferência bancária, 19 - Carteira Digital, 20 - Pagamento Instantâneo (Pix) - Estático, 21 - Crédito em Loja, 22 - Pagamento Eletrônico não Informado - falha de hardware do sistema emissor, 90 - Sem pagamento, 99 - Outros)","enum":["01","02","03","04","05","10","11","12","13","15","16","17","18","19","20","21","22","90","99"]},"dataPagamento":{"type":"string","description":"Data de Saída (YYYY-MM-DD)","format":"date"},"cnpjLocalPagamento":{"type":"string","description":"CNPJ Local do Pagamento","format":"@'?.12AN2N"},"ufLocalPagamento":{"maxLength":2,"type":"string","description":"UF do Local do Pagamento"},"tipoIntegracao":{"type":"integer","description":"Tipo de Integração com a Máquina de Cartão (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Pagamento não integrado com o sistema de automação da empresa)","enum":[1,2]},"cnpjCredenciadora":{"type":"string","description":"CNPJ da Credenciadora","format":"@'?.12AN2N"},"bandeiraOperadora":{"type":"integer","description":"Bandeira da Operadora (1 - Visa, 2 - Mastercard, 3 - American Express, 4 - Sorocred, 5 - Diners Club, 6 - Elo, 7 - Hipercard, 8 - Aura, 9 - Cabal, 99 - Outros)","enum":[1,2,3,4,5,6,7,8,9]},"autorizacaoOpCartao":{"maxLength":20,"type":"string","description":"Código da Autorização da Operação"},"cnpjBeneficiarioPagamento":{"type":"string","description":"CNPJ Beneficiário do Pagamento","format":"@'?.12AN2N"},"terminalPagamento":{"maxLength":40,"type":"string","description":"Terminal de Pagamento"},"codMensagemNota":{"maximum":999,"type":"integer","description":"Código da Mensagem"},"obsNota":{"maxLength":1000,"type":"string","description":"Observações Para Nota"},"nomeTag":{"maxLength":20,"type":"string","description":"Nome da Tag"},"conteudoTag":{"maxLength":60,"type":"string","description":"Conteúdo da TAG"},"motivoEstorno":{"maxLength":55,"type":"string","description":"Motivo do estorno - nota fiscal de ajuste"},"outraIECliente":{"maxLength":15,"type":"string","description":"Cliente Inscrição Estadual"},"outraIETransportadora":{"maxLength":15,"type":"string","description":"Transportadora Inscrição Estadual"},"localEntrega":{"maxLength":40,"type":"string","description":"Nome do Local de Entrega"},"enderecoEntrega":{"maxLength":40,"type":"string","description":"Endereco do Local de Entrega"},"numeroCasa":{"maxLength":10,"type":"string","description":"Número do Endereço"},"complementoEntrega":{"maxLength":60,"type":"string","description":"Complemento do Endereço"},"bairroEntrega":{"maxLength":60,"type":"string","description":"Bairro de Entrega"},"cepEntrega":{"maximum":99999999,"type":"integer","description":"Cep do Local de Entrega"},"cnpjcpfEntrega":{"maximum":99999999999999,"type":"integer","description":"Cgc do Local de Entrega"},"ieEntrega":{"maxLength":18,"type":"string","description":"Incricao Estadual do Local de Entrega"},"foneEntrega":{"maxLength":20,"type":"string","description":"Telefone de Entrega"},"horaEntrega":{"maxLength":5,"minLength":5,"pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string","description":"Horario de Entrega (HH:MM)"},"codLocalColeta":{"maximum":99999,"type":"integer","description":"Código do Local de Coleta"},"ufEmbarque":{"maxLength":2,"type":"string","description":"UF de Embarque"},"localEmbarque":{"maxLength":50,"type":"string","description":"Local de Embarque"},"recintoAlfandegado":{"maxLength":50,"type":"string","description":"Recinto Alfandegado"},"docReferenciados":{"type":"array","description":"Chave NFe Referenciada","items":{"$ref":"#/components/schemas/NFeReferenciados"}},"ItensSelecaoEspecial":{"type":"array","description":"Itens Seleção Especial","items":{"$ref":"#/components/schemas/ItensSelecaoEspecial"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/selecaoespecial":{"put":{"tags":["Seleção Especial"],"summary":"Gerar Seleção Especial","operationId":"GerarSelecaoEspecial","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Seleção Especial","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelecaoEspecial"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelecaoEspecialGerada"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The SelecaoEspecial object ```json {"openapi":"3.0.1","info":{"title":"Comercial Seleção Especial","version":"1.0"},"components":{"schemas":{"SelecaoEspecial":{"required":["atendimentoPresencial","codCliente","codRepresentante","codTipoNota","condicaoVenda","consumoProprio","retiraICMSbasePisCofins"],"type":"object","properties":{"codCliente":{"maximum":99999999999999,"type":"integer","description":"Código do Cliente"},"codRepresentante":{"maximum":9999,"type":"integer","description":"Código do Representante"},"codTipoNota":{"maximum":9999,"type":"integer","description":"Tipo de Nota"},"consumoProprio":{"type":"integer","description":"Consumo Próprio (0 - Não, 1 - Sim)","enum":[0,1]},"condicaoVenda":{"maximum":9999,"type":"integer","description":"Condição de Venda"},"codAtendente":{"maximum":9999,"type":"integer","description":"Atendente"},"cfop":{"maximum":9,"type":"integer","description":"Primeiro Dígito da Cfop"},"codTransportadora":{"maximum":9999,"type":"integer","description":"Código da Transportadora"},"tipoFrete":{"maximum":9999,"type":"integer","description":"Código do Tipo de Frete"},"tabelaPreco":{"maximum":9999,"type":"integer","description":"Código da Tablea de Preço"},"valorOutrasDespesas":{"multipleOf":0.01,"maximum":9999999999.99,"minimum":0.01,"type":"number","description":"Valor de Outras Despesas"},"desconto1":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 1"},"desconto2":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 2"},"desconto3":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 3"},"desconto4":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 4"},"acrescimo1":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 1"},"acrescimo2":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 2"},"acrescimo3":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 3"},"acrescimo4":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 4"},"valorAntecipado":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.01,"type":"number","description":"Valor Antecipado"},"valorDesconto":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.01,"type":"number","description":"Valor Desconto"},"pedidoCliente":{"maxLength":15,"type":"string","description":"Código do Pedido do Cliente"},"pedidoRepresentante":{"maxLength":10,"type":"string","description":"Código do Pedido do Representante"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0-Não se Aplica, 1-Operação Presencial, 2-Operação Não Presencial - Pela Internet, 3-Operação Não Presencial - Teleatendimento,9-Operação Não Presencial - Outros) (0 - NAO SE APLICA, 1 - OPERACAO PRESENCIAL, 2 - OPERACAO NAO PRESENCIAL PELA INTERNET, 3 - OPERACAO NAO PRESENCIAL TELEATENDIMENTO, 5 - OPERAÇÃO PRESENCIAL FORA DO ESTABELECIMENTO, 9 - OPERACAO NAO PRESENCIAL OUTROS)","enum":[0,1,2,3,9]},"intermediadorTransacao":{"maximum":999,"type":"integer","description":"Intermediador da Transação"},"retiraICMSbasePisCofins":{"type":"integer","description":"Retirar Icms da Base Pis/cofins (0 - Não, 1 - Sim)","enum":[0,1]},"processoRegimeEspecial":{"maxLength":60,"type":"string","description":"Processo/ato Concessório Regime Especial"},"origemProcesso":{"type":"integer","description":"Origem do Processo (0 - SEFAZ, 1 - Justiça Federal, 2 - Justiça Estadual, 3 - Secex/RFB, 9 - Outros)","enum":[0,1,2,3,9]},"tipoAto":{"type":"integer","description":"Tipo do Ato Concessório (8 - Termo de Acordo, 10 - Regime Especial, 12 - Autorização específica)","enum":[8,10,12]},"obsRegimeEspecial":{"maximum":9999,"type":"integer","description":"Observação Regime Especial"},"seguroSocial":{"type":"integer","description":"Seguro Social (0 - Não, 1 - Sim)","enum":[0,1]},"estruturaComercial":{"type":"integer","description":"Estrutura Comercial"},"codRedespacho":{"type":"integer","description":"Transportadora de Redespacho"},"tipoFreteRedespacho":{"maximum":99,"type":"integer","description":"Tipo de Frete de Redespacho"},"valorFrete":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Frete"},"valorSeguro":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Seguro"},"calcPeso":{"type":"integer","description":"Calcular Peso Automaticamente (0 - Não, 1 - Sim)","enum":[0,1]},"pesoLiquido":{"multipleOf":0.001,"maximum":99999999.999,"type":"number","description":"Peso Líquido"},"pesoBruto":{"multipleOf":0.001,"maximum":99999999.999,"type":"number","description":"Peso Bruto"},"qtdVolumes":{"maximum":9999999999,"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"maxLength":60,"type":"string","description":"Espécie de Volume"},"qtdPecas":{"maximum":999,"type":"integer","description":"Quantidade de Peças da Seleção Especial"},"dataSaida":{"type":"string","description":"Data de Saída (YYYY-MM-DD)","format":"date"},"horaSaida":{"maxLength":5,"minLength":5,"pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string","description":"Hora do Cálculo (HH:MM)"},"placa":{"maxLength":7,"type":"string","description":"Placa do Veículo"},"ufPlaca":{"maxLength":2,"type":"string","description":"uf da Placa"},"cpfMotorista":{"maxLength":14,"minLength":1,"type":"string","description":"Cpf do Motorista (sem formatação"},"nomeMotorista":{"maxLength":20,"type":"string","description":"Nome do Motorista"},"vencimentoEsp":{"maxItems":18,"type":"array","description":"Dias de Vencimento Especial (Obrigatório para condição de venda 99)","items":{"type":"string","format":"date"}},"codPortador":{"maximum":9999,"type":"integer","description":"Código do Portador"},"tipoCobranca":{"maximum":9999,"type":"integer","description":"Código do Tipo de Cobrança"},"percDescDuplicata":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Porcentagem de Desconto da Duplicata"},"diasDescDuplicata":{"maximum":99,"type":"integer","description":"Dias de Desconto da Duplicata"},"ajustaValorManual":{"type":"integer","description":"Ajustar Valor/Vencimento Manualmente (0 - Não, 1 - Sim)","enum":[0,1]},"formaPagamento":{"type":"string","description":" Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 15 - Boleto Bancário, 16 - Depósito Bancário, 17 - Pagamento Instantâneo (Pix) QR-Code - Estático, 18 - Transferência bancária, 19 - Carteira Digital, 20 - Pagamento Instantâneo (Pix) - Estático, 21 - Crédito em Loja, 22 - Pagamento Eletrônico não Informado - falha de hardware do sistema emissor, 90 - Sem pagamento, 99 - Outros)","enum":["01","02","03","04","05","10","11","12","13","15","16","17","18","19","20","21","22","90","99"]},"dataPagamento":{"type":"string","description":"Data de Saída (YYYY-MM-DD)","format":"date"},"cnpjLocalPagamento":{"type":"string","description":"CNPJ Local do Pagamento","format":"@'?.12AN2N"},"ufLocalPagamento":{"maxLength":2,"type":"string","description":"UF do Local do Pagamento"},"tipoIntegracao":{"type":"integer","description":"Tipo de Integração com a Máquina de Cartão (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Pagamento não integrado com o sistema de automação da empresa)","enum":[1,2]},"cnpjCredenciadora":{"type":"string","description":"CNPJ da Credenciadora","format":"@'?.12AN2N"},"bandeiraOperadora":{"type":"string","description":"Bandeira da Operadora (1 - Visa, 2 - Mastercard, 3 - American Express, 4 - Sorocred, 5 - Diners Club, 6 - Elo, 7 - Hipercard, 8 - Aura, 9 - Cabal, 99 - Outros)","enum":["01","02","03","04","05","06","07","08","09","99"]},"autorizacaoOpCartao":{"maxLength":20,"type":"string","description":"Código da Autorização da Operação"},"cnpjBeneficiarioPagamento":{"type":"string","description":"CNPJ Beneficiário do Pagamento","format":"@'?.12AN2N"},"terminalPagamento":{"maxLength":40,"type":"string","description":"Terminal de Pagamento"},"codMensagemNota":{"maximum":999,"type":"integer","description":"Código da Mensagem"},"obsNota":{"maxLength":1000,"type":"string","description":"Observações Para Nota"},"nomeTag":{"maxLength":20,"type":"string","description":"Nome da Tag"},"conteudoTag":{"maxLength":60,"type":"string","description":"Conteúdo da TAG"},"motivoEstorno":{"maxLength":55,"type":"string","description":"Motivo do estorno - nota fiscal de ajuste"},"outraIECliente":{"maxLength":15,"type":"string","description":"Cliente Inscrição Estadual"},"outraIETransportadora":{"maxLength":15,"type":"string","description":"Transportadora Inscrição Estadual"},"localEntrega":{"maxLength":40,"type":"string","description":"Nome do Local de Entrega"},"enderecoEntrega":{"maxLength":40,"type":"string","description":"Endereco do Local de Entrega"},"numeroCasa":{"maxLength":10,"type":"string","description":"Número do Endereço"},"complementoEntrega":{"maxLength":60,"type":"string","description":"Complemento do Endereço"},"bairroEntrega":{"maxLength":60,"type":"string","description":"Bairro de Entrega"},"cepEntrega":{"maximum":99999999,"type":"integer","description":"Cep do Local de Entrega"},"cnpjcpfEntrega":{"maximum":99999999999999,"type":"integer","description":"Cgc do Local de Entrega"},"ieEntrega":{"maxLength":18,"type":"string","description":"Incricao Estadual do Local de Entrega"},"foneEntrega":{"maxLength":20,"type":"string","description":"Telefone de Entrega"},"horaEntrega":{"maxLength":5,"minLength":5,"pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string","description":"Horario de Entrega (HH:MM)"},"codLocalColeta":{"maximum":99999,"type":"integer","description":"Código do Local de Coleta"},"ufEmbarque":{"maxLength":2,"type":"string","description":"UF de Embarque"},"localEmbarque":{"maxLength":50,"type":"string","description":"Local de Embarque"},"recintoAlfandegado":{"maxLength":50,"type":"string","description":"Recinto Alfandegado"},"docReferenciados":{"type":"array","description":"Chave NFe Referenciada","items":{"$ref":"#/components/schemas/NFeReferenciados"}},"ItensSelecaoEspecial":{"type":"array","description":"Itens Seleção Especial","items":{"$ref":"#/components/schemas/ItensSelecaoEspecial"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NFeReferenciados":{"type":"object","properties":{"chaveNFeReferenciada":{"maxLength":44,"minLength":44,"pattern":"^[0-9]{44}$","type":"string","description":"Chave de acesso da Nota Fiscal Eletrônica (NFe). Composta por 44 dígitos numéricos."}}},"ItensSelecaoEspecial":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto (aceita até 30 dígitos numéricos)"},"descricaoProduto":{"maxLength":140,"type":"string","description":"Descrição do Produto"},"unidade":{"maxLength":6,"type":"string","description":"Unidade de Medida do Item"},"quantidade":{"multipleOf":0.001,"maximum":99999999.999,"minimum":0.001,"type":"number","description":"Quantidade do Item (gravado Float)"},"precoUnitario":{"multipleOf":0.00001,"maximum":999999999.99999,"minimum":0.00001,"type":"number","description":"Preço Unitário do Item (gravado Float)"},"percentualIPI":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Ipi do Item"},"ncm":{"maximum":99999999,"type":"integer","description":"Ncm do Item"},"percentualICMS":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Icms do Item"},"percentualComissaoRepresentante":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Comissão do Representante"},"percentualComissaoAtendente":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Comissão do Atendente"},"origemMercadoria":{"type":"integer","description":"Código da Origem da Mercadoria (0 - Nacional, 1 - Estrangeira - Importação direta, 2 - Estrangeira - Adquirida no mercado interno, 3 - Nacional, com conteúdo importacao superior a 40% e inferior a 70%, 4 - Nacional, de acordo com processos produtivos básicos, 5 - Nacional, com conteúdo importação inferior a 40%, 6 - Estrangeira - Importação direta, sem similar nacional. (Camex), 7 - Estrangeira - Adquirida mercado interno, sem similar nacional. (Camex), 8 - Nacional, com conteúdo importação superior a 70%)","enum":[0,1,2,3,4,5,6,7,8]},"classificacaoFinalidade":{"type":"integer","description":"Código da Classificação Finalidade (1 - Item Venda, 2 - Item de Revenda, 3 - Item Consumo, 4 - Item Consumo/Revenda, 5 - Consumo/Venda)","enum":[1,2,3,4,5]},"percentualReducaoIcms":{"multipleOf":0.00001,"maximum":99.99999,"minimum":0.00001,"type":"number","description":"Porcentagem de Redução do Icms"},"codMsgRedIcms":{"maximum":999,"type":"integer","description":"Código da Mensagem de Redução de Icms"},"baseST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Base do Icms st"},"valorST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Icms st"},"aliquotaST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Alíquota do Icms st"},"percentualMVAST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem Mva do Icms"},"percentualFCPST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem Fcp do Icms st"},"valorFCPST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor Fcp Icms st"},"itemPedidoCliente":{"maximum":9999,"type":"integer","description":"Código do Item do Pedido do Cliente"},"valorIPIDevolvido":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Ipi Devolvido"},"cBenef":{"maxLength":12,"type":"string","description":"Código do Benefício Fiscal"},"transacaoEstoque":{"maximum":9999,"type":"integer","description":"Código de Transação do Estoque"},"codCest":{"maximum":99999999,"type":"integer","description":"Código Cest"},"codFinalidade":{"maximum":999999,"type":"integer","description":"Código de Finalidade do Produto"},"codigoANP":{"maximum":999999999,"type":"integer","description":"Código Anp do Produto"},"percentualDifalDevolucao":{"multipleOf":0.01,"maximum":99.99,"minimum":0,"type":"number","description":"Aliquota do Difal Para Nota de Devolução"},"qtdTributadaRetida":{"multipleOf":0.0001,"maximum":99999999999.9999,"minimum":0,"type":"number","description":"Quantidade Tributada Retida"},"aliquotaADRemRetido":{"multipleOf":0.0001,"maximum":999.9999,"minimum":0,"type":"number","description":"Alíquota ad Rem Retido"},"valorIcmsRetido":{"multipleOf":0.01,"maximum":9999999999999.99,"minimum":0,"type":"number","description":"Valor Icms Retido"},"percentualBiodiesel":{"multipleOf":0.0001,"maximum":999.9999,"minimum":0,"type":"number","description":"Percentual Mistura Biodiesel"},"ExportacaoIndireta":{"type":"array","description":"Item Dados Exportação Indireta","items":{"$ref":"#/components/schemas/ExportacaoIndireta"}},"Drawback":{"type":"array","description":"Ato Consessório Drawback","items":{"$ref":"#/components/schemas/Drawback"}}}},"ExportacaoIndireta":{"type":"object","properties":{"registroExportacao":{"maximum":999999999999,"type":"integer","description":"Valor Registro Exportação"},"chaveNFe":{"maxLength":44,"minLength":44,"pattern":"^[0-9]{44}$","type":"string","description":"Chave de acesso da Nota Fiscal Eletrônica (NFe). Composta por 44 dígitos numéricos."},"qtdExportada":{"multipleOf":0.001,"maximum":99999999.999,"minimum":0.001,"type":"number","description":"Quantidade Realmente Exportada"}}},"Drawback":{"type":"object","properties":{"atoConsessorioDrawback":{"maximum":99999999999,"type":"integer","description":"Número Ato Consessório"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The SelecaoEspecialGerada object ```json {"openapi":"3.0.1","info":{"title":"Comercial Seleção Especial","version":"1.0"},"components":{"schemas":{"SelecaoEspecialGerada":{"required":["atendimentoPresencial","codCliente","codRepresentante","codTipoNota","condicaoVenda","consumoProprio","retiraICMSbasePisCofins"],"type":"object","properties":{"codSelecaoGerada":{"type":"integer","description":"Código da Seleção Especial que é gerado"},"codCliente":{"maximum":99999999999999,"type":"integer","description":"Código do Cliente"},"codRepresentante":{"maximum":9999,"type":"integer","description":"Código do Representante"},"codTipoNota":{"maximum":9999,"type":"integer","description":"Tipo de Nota"},"consumoProprio":{"type":"integer","description":"Consumo Próprio (0 - Não, 1 - Sim)","enum":[0,1]},"condicaoVenda":{"maximum":9999,"type":"integer","description":"Condição de Venda"},"codAtendente":{"maximum":9999,"type":"integer","description":"Atendente"},"cfop":{"maximum":9,"type":"integer","description":"Primeiro Dígito da Cfop"},"codTransportadora":{"maximum":9999,"type":"integer","description":"Código da Transportadora"},"tipoFrete":{"maximum":9999,"type":"integer","description":"Código do Tipo de Frete"},"tabelaPreco":{"maximum":9999,"type":"integer","description":"Código da Tablea de Preço"},"valorOutrasDespesas":{"multipleOf":0.01,"maximum":9999999999.99,"minimum":0.01,"type":"number","description":"Valor de Outras Despesas"},"desconto1":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 1"},"desconto2":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 2"},"desconto3":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 3"},"desconto4":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Desconto 4"},"acrescimo1":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 1"},"acrescimo2":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 2"},"acrescimo3":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 3"},"acrescimo4":{"multipleOf":0.01,"maximum":99.99,"minimum":0.01,"type":"number","description":"Porcentagem de Acréscimo 4"},"valorAntecipado":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.01,"type":"number","description":"Valor Antecipado"},"valorDesconto":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.01,"type":"number","description":"Valor Desconto"},"pedidoCliente":{"maxLength":15,"type":"string","description":"Código do Pedido do Cliente"},"pedidoRepresentante":{"maxLength":10,"type":"string","description":"Código do Pedido do Representante"},"atendimentoPresencial":{"type":"integer","description":"Atendimento Presencial (0-Não se Aplica, 1-Operação Presencial, 2-Operação Não Presencial - Pela Internet, 3-Operação Não Presencial - Teleatendimento, 9-Operação Não Presencial - Outros) (0 - NAO SE APLICA, 1 - OPERACAO PRESENCIAL, 2 - OPERACAO NAO PRESENCIAL PELA INTERNET, 3 - OPERACAO NAO PRESENCIAL TELEATENDIMENTO, 5 - OPERAÇÃO PRESENCIAL FORA DO ESTABELECIMENTO, 9 - OPERACAO NAO PRESENCIAL OUTROS)","enum":[0,1,2,3,9]},"intermediadorTransacao":{"maximum":999,"type":"integer","description":"Intermediador da Transação"},"retiraICMSbasePisCofins":{"type":"integer","description":"Retirar Icms da Base Pis/cofins (0 - Não, 1 - Sim)","enum":[0,1]},"processoRegimeEspecial":{"maxLength":60,"type":"string","description":"Processo/ato Concessório Regime Especial"},"origemProcesso":{"type":"integer","description":"Origem do Processo (0 - SEFAZ, 1 - Justiça Federal, 2 - Justiça Estadual, 3 - Secex/RFB, 9 - Outros)","enum":[0,1,2,3,9]},"tipoAto":{"type":"integer","description":"Tipo do Ato Concessório (8 - Termo de Acordo, 10 - Regime Especial, 12 - Autorização específica)","enum":[8,10,12]},"obsRegimeEspecial":{"maximum":9999,"type":"integer","description":"Observação Regime Especial"},"seguroSocial":{"type":"integer","description":"Seguro Social (0 - Não, 1 - Sim)","enum":[0,1]},"estruturaComercial":{"type":"integer","description":"Estrutura Comercial"},"codRedespacho":{"type":"integer","description":"Transportadora de Redespacho"},"tipoFreteRedespacho":{"maximum":99,"type":"integer","description":"Tipo de Frete de Redespacho"},"valorFrete":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Frete"},"valorSeguro":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Seguro"},"calcPeso":{"type":"integer","description":"Calcular Peso Automaticamente (0 - Não, 1 - Sim)","enum":[0,1]},"pesoLiquido":{"multipleOf":0.001,"maximum":99999999.999,"type":"number","description":"Peso Líquido"},"pesoBruto":{"multipleOf":0.001,"maximum":99999999.999,"type":"number","description":"Peso Bruto"},"qtdVolumes":{"maximum":9999999999,"type":"integer","description":"Quantidade de Volumes"},"especieVolumes":{"maxLength":60,"type":"string","description":"Espécie de Volume"},"qtdPecas":{"maximum":999,"type":"integer","description":"Quantidade de Peças da Seleção Especial"},"dataSaida":{"type":"string","description":"Data de Saída (YYYY-MM-DD)","format":"date"},"horaSaida":{"maxLength":5,"minLength":5,"pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string","description":"Hora do Cálculo (HH:MM)"},"placa":{"maxLength":7,"type":"string","description":"Placa do Veículo"},"ufPlaca":{"maxLength":2,"type":"string","description":"uf da Placa"},"cpfMotorista":{"maxLength":14,"minLength":1,"type":"string","description":"Cpf do Motorista (sem formatação"},"nomeMotorista":{"maxLength":20,"type":"string","description":"Nome do Motorista"},"vencimentoEsp":{"maxItems":18,"type":"array","description":"Dias de Vencimento Especial (Obrigatório para condição de venda 99)","items":{"type":"string","format":"date"}},"codPortador":{"maximum":9999,"type":"integer","description":"Código do Portador"},"tipoCobranca":{"maximum":9999,"type":"integer","description":"Código do Tipo de Cobrança"},"percDescDuplicata":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Porcentagem de Desconto da Duplicata"},"diasDescDuplicata":{"maximum":99,"type":"integer","description":"Dias de Desconto da Duplicata"},"ajustaValorManual":{"type":"integer","description":"Ajustar Valor/Vencimento Manualmente (0 - Não, 1 - Sim)","enum":[0,1]},"formaPagamento":{"type":"string","description":" Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 15 - Boleto Bancário, 16 - Depósito Bancário, 17 - Pagamento Instantâneo (Pix) QR-Code - Estático, 18 - Transferência bancária, 19 - Carteira Digital, 20 - Pagamento Instantâneo (Pix) - Estático, 21 - Crédito em Loja, 22 - Pagamento Eletrônico não Informado - falha de hardware do sistema emissor, 90 - Sem pagamento, 99 - Outros)","enum":["01","02","03","04","05","10","11","12","13","15","16","17","18","19","20","21","22","90","99"]},"dataPagamento":{"type":"string","description":"Data de Saída (YYYY-MM-DD)","format":"date"},"cnpjLocalPagamento":{"type":"string","description":"CNPJ Local do Pagamento","format":"@'?.12AN2N"},"ufLocalPagamento":{"maxLength":2,"type":"string","description":"UF do Local do Pagamento"},"tipoIntegracao":{"type":"integer","description":"Tipo de Integração com a Máquina de Cartão (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Pagamento não integrado com o sistema de automação da empresa)","enum":[1,2]},"cnpjCredenciadora":{"type":"string","description":"CNPJ da Credenciadora","format":"@'?.12AN2N"},"bandeiraOperadora":{"type":"integer","description":"Bandeira da Operadora (1 - Visa, 2 - Mastercard, 3 - American Express, 4 - Sorocred, 5 - Diners Club, 6 - Elo, 7 - Hipercard, 8 - Aura, 9 - Cabal, 99 - Outros)","enum":[1,2,3,4,5,6,7,8,9]},"autorizacaoOpCartao":{"maxLength":20,"type":"string","description":"Código da Autorização da Operação"},"cnpjBeneficiarioPagamento":{"type":"string","description":"CNPJ Beneficiário do Pagamento","format":"@'?.12AN2N"},"terminalPagamento":{"maxLength":40,"type":"string","description":"Terminal de Pagamento"},"codMensagemNota":{"maximum":999,"type":"integer","description":"Código da Mensagem"},"obsNota":{"maxLength":1000,"type":"string","description":"Observações Para Nota"},"nomeTag":{"maxLength":20,"type":"string","description":"Nome da Tag"},"conteudoTag":{"maxLength":60,"type":"string","description":"Conteúdo da TAG"},"motivoEstorno":{"maxLength":55,"type":"string","description":"Motivo do estorno - nota fiscal de ajuste"},"outraIECliente":{"maxLength":15,"type":"string","description":"Cliente Inscrição Estadual"},"outraIETransportadora":{"maxLength":15,"type":"string","description":"Transportadora Inscrição Estadual"},"localEntrega":{"maxLength":40,"type":"string","description":"Nome do Local de Entrega"},"enderecoEntrega":{"maxLength":40,"type":"string","description":"Endereco do Local de Entrega"},"numeroCasa":{"maxLength":10,"type":"string","description":"Número do Endereço"},"complementoEntrega":{"maxLength":60,"type":"string","description":"Complemento do Endereço"},"bairroEntrega":{"maxLength":60,"type":"string","description":"Bairro de Entrega"},"cepEntrega":{"maximum":99999999,"type":"integer","description":"Cep do Local de Entrega"},"cnpjcpfEntrega":{"maximum":99999999999999,"type":"integer","description":"Cgc do Local de Entrega"},"ieEntrega":{"maxLength":18,"type":"string","description":"Incricao Estadual do Local de Entrega"},"foneEntrega":{"maxLength":20,"type":"string","description":"Telefone de Entrega"},"horaEntrega":{"maxLength":5,"minLength":5,"pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string","description":"Horario de Entrega (HH:MM)"},"codLocalColeta":{"maximum":99999,"type":"integer","description":"Código do Local de Coleta"},"ufEmbarque":{"maxLength":2,"type":"string","description":"UF de Embarque"},"localEmbarque":{"maxLength":50,"type":"string","description":"Local de Embarque"},"recintoAlfandegado":{"maxLength":50,"type":"string","description":"Recinto Alfandegado"},"docReferenciados":{"type":"array","description":"Chave NFe Referenciada","items":{"$ref":"#/components/schemas/NFeReferenciados"}},"ItensSelecaoEspecial":{"type":"array","description":"Itens Seleção Especial","items":{"$ref":"#/components/schemas/ItensSelecaoEspecial"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NFeReferenciados":{"type":"object","properties":{"chaveNFeReferenciada":{"maxLength":44,"minLength":44,"pattern":"^[0-9]{44}$","type":"string","description":"Chave de acesso da Nota Fiscal Eletrônica (NFe). Composta por 44 dígitos numéricos."}}},"ItensSelecaoEspecial":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto (aceita até 30 dígitos numéricos)"},"descricaoProduto":{"maxLength":140,"type":"string","description":"Descrição do Produto"},"unidade":{"maxLength":6,"type":"string","description":"Unidade de Medida do Item"},"quantidade":{"multipleOf":0.001,"maximum":99999999.999,"minimum":0.001,"type":"number","description":"Quantidade do Item (gravado Float)"},"precoUnitario":{"multipleOf":0.00001,"maximum":999999999.99999,"minimum":0.00001,"type":"number","description":"Preço Unitário do Item (gravado Float)"},"percentualIPI":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Ipi do Item"},"ncm":{"maximum":99999999,"type":"integer","description":"Ncm do Item"},"percentualICMS":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Icms do Item"},"percentualComissaoRepresentante":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Comissão do Representante"},"percentualComissaoAtendente":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Comissão do Atendente"},"origemMercadoria":{"type":"integer","description":"Código da Origem da Mercadoria (0 - Nacional, 1 - Estrangeira - Importação direta, 2 - Estrangeira - Adquirida no mercado interno, 3 - Nacional, com conteúdo importacao superior a 40% e inferior a 70%, 4 - Nacional, de acordo com processos produtivos básicos, 5 - Nacional, com conteúdo importação inferior a 40%, 6 - Estrangeira - Importação direta, sem similar nacional. (Camex), 7 - Estrangeira - Adquirida mercado interno, sem similar nacional. (Camex), 8 - Nacional, com conteúdo importação superior a 70%)","enum":[0,1,2,3,4,5,6,7,8]},"classificacaoFinalidade":{"type":"integer","description":"Código da Classificação Finalidade (1 - Item Venda, 2 - Item de Revenda, 3 - Item Consumo, 4 - Item Consumo/Revenda, 5 - Consumo/Venda)","enum":[1,2,3,4,5]},"percentualReducaoIcms":{"multipleOf":0.00001,"maximum":99.99999,"minimum":0.00001,"type":"number","description":"Porcentagem de Redução do Icms"},"codMsgRedIcms":{"maximum":999,"type":"integer","description":"Código da Mensagem de Redução de Icms"},"baseST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Base do Icms st"},"valorST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Icms st"},"aliquotaST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Alíquota do Icms st"},"percentualMVAST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem Mva do Icms"},"percentualFCPST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem Fcp do Icms st"},"valorFCPST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor Fcp Icms st"},"itemPedidoCliente":{"maximum":9999,"type":"integer","description":"Código do Item do Pedido do Cliente"},"valorIPIDevolvido":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Ipi Devolvido"},"cBenef":{"maxLength":12,"type":"string","description":"Código do Benefício Fiscal"},"transacaoEstoque":{"maximum":9999,"type":"integer","description":"Código de Transação do Estoque"},"codCest":{"maximum":99999999,"type":"integer","description":"Código Cest"},"codFinalidade":{"maximum":999999,"type":"integer","description":"Código de Finalidade do Produto"},"codigoANP":{"maximum":999999999,"type":"integer","description":"Código Anp do Produto"},"percentualDifalDevolucao":{"multipleOf":0.01,"maximum":99.99,"minimum":0,"type":"number","description":"Aliquota do Difal Para Nota de Devolução"},"qtdTributadaRetida":{"multipleOf":0.0001,"maximum":99999999999.9999,"minimum":0,"type":"number","description":"Quantidade Tributada Retida"},"aliquotaADRemRetido":{"multipleOf":0.0001,"maximum":999.9999,"minimum":0,"type":"number","description":"Alíquota ad Rem Retido"},"valorIcmsRetido":{"multipleOf":0.01,"maximum":9999999999999.99,"minimum":0,"type":"number","description":"Valor Icms Retido"},"percentualBiodiesel":{"multipleOf":0.0001,"maximum":999.9999,"minimum":0,"type":"number","description":"Percentual Mistura Biodiesel"},"ExportacaoIndireta":{"type":"array","description":"Item Dados Exportação Indireta","items":{"$ref":"#/components/schemas/ExportacaoIndireta"}},"Drawback":{"type":"array","description":"Ato Consessório Drawback","items":{"$ref":"#/components/schemas/Drawback"}}}},"ExportacaoIndireta":{"type":"object","properties":{"registroExportacao":{"maximum":999999999999,"type":"integer","description":"Valor Registro Exportação"},"chaveNFe":{"maxLength":44,"minLength":44,"pattern":"^[0-9]{44}$","type":"string","description":"Chave de acesso da Nota Fiscal Eletrônica (NFe). Composta por 44 dígitos numéricos."},"qtdExportada":{"multipleOf":0.001,"maximum":99999999.999,"minimum":0.001,"type":"number","description":"Quantidade Realmente Exportada"}}},"Drawback":{"type":"object","properties":{"atoConsessorioDrawback":{"maximum":99999999999,"type":"integer","description":"Número Ato Consessório"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NFeReferenciados object ```json {"openapi":"3.0.1","info":{"title":"Comercial Seleção Especial","version":"1.0"},"components":{"schemas":{"NFeReferenciados":{"type":"object","properties":{"chaveNFeReferenciada":{"maxLength":44,"minLength":44,"pattern":"^[0-9]{44}$","type":"string","description":"Chave de acesso da Nota Fiscal Eletrônica (NFe). Composta por 44 dígitos numéricos."}}}}}} ``` ## The ItensSelecaoEspecial object ```json {"openapi":"3.0.1","info":{"title":"Comercial Seleção Especial","version":"1.0"},"components":{"schemas":{"ItensSelecaoEspecial":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto (aceita até 30 dígitos numéricos)"},"descricaoProduto":{"maxLength":140,"type":"string","description":"Descrição do Produto"},"unidade":{"maxLength":6,"type":"string","description":"Unidade de Medida do Item"},"quantidade":{"multipleOf":0.001,"maximum":99999999.999,"minimum":0.001,"type":"number","description":"Quantidade do Item (gravado Float)"},"precoUnitario":{"multipleOf":0.00001,"maximum":999999999.99999,"minimum":0.00001,"type":"number","description":"Preço Unitário do Item (gravado Float)"},"percentualIPI":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Ipi do Item"},"ncm":{"maximum":99999999,"type":"integer","description":"Ncm do Item"},"percentualICMS":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Icms do Item"},"percentualComissaoRepresentante":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Comissão do Representante"},"percentualComissaoAtendente":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem de Comissão do Atendente"},"origemMercadoria":{"type":"integer","description":"Código da Origem da Mercadoria (0 - Nacional, 1 - Estrangeira - Importação direta, 2 - Estrangeira - Adquirida no mercado interno, 3 - Nacional, com conteúdo importacao superior a 40% e inferior a 70%, 4 - Nacional, de acordo com processos produtivos básicos, 5 - Nacional, com conteúdo importação inferior a 40%, 6 - Estrangeira - Importação direta, sem similar nacional. (Camex), 7 - Estrangeira - Adquirida mercado interno, sem similar nacional. (Camex), 8 - Nacional, com conteúdo importação superior a 70%)","enum":[0,1,2,3,4,5,6,7,8]},"classificacaoFinalidade":{"type":"integer","description":"Código da Classificação Finalidade (1 - Item Venda, 2 - Item de Revenda, 3 - Item Consumo, 4 - Item Consumo/Revenda, 5 - Consumo/Venda)","enum":[1,2,3,4,5]},"percentualReducaoIcms":{"multipleOf":0.00001,"maximum":99.99999,"minimum":0.00001,"type":"number","description":"Porcentagem de Redução do Icms"},"codMsgRedIcms":{"maximum":999,"type":"integer","description":"Código da Mensagem de Redução de Icms"},"baseST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Base do Icms st"},"valorST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Icms st"},"aliquotaST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Alíquota do Icms st"},"percentualMVAST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem Mva do Icms"},"percentualFCPST":{"multipleOf":0.01,"maximum":99.99,"minimum":0.001,"type":"number","description":"Porcentagem Fcp do Icms st"},"valorFCPST":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor Fcp Icms st"},"itemPedidoCliente":{"maximum":9999,"type":"integer","description":"Código do Item do Pedido do Cliente"},"valorIPIDevolvido":{"multipleOf":0.01,"maximum":999999999999.99,"minimum":0.001,"type":"number","description":"Valor do Ipi Devolvido"},"cBenef":{"maxLength":12,"type":"string","description":"Código do Benefício Fiscal"},"transacaoEstoque":{"maximum":9999,"type":"integer","description":"Código de Transação do Estoque"},"codCest":{"maximum":99999999,"type":"integer","description":"Código Cest"},"codFinalidade":{"maximum":999999,"type":"integer","description":"Código de Finalidade do Produto"},"codigoANP":{"maximum":999999999,"type":"integer","description":"Código Anp do Produto"},"percentualDifalDevolucao":{"multipleOf":0.01,"maximum":99.99,"minimum":0,"type":"number","description":"Aliquota do Difal Para Nota de Devolução"},"qtdTributadaRetida":{"multipleOf":0.0001,"maximum":99999999999.9999,"minimum":0,"type":"number","description":"Quantidade Tributada Retida"},"aliquotaADRemRetido":{"multipleOf":0.0001,"maximum":999.9999,"minimum":0,"type":"number","description":"Alíquota ad Rem Retido"},"valorIcmsRetido":{"multipleOf":0.01,"maximum":9999999999999.99,"minimum":0,"type":"number","description":"Valor Icms Retido"},"percentualBiodiesel":{"multipleOf":0.0001,"maximum":999.9999,"minimum":0,"type":"number","description":"Percentual Mistura Biodiesel"},"ExportacaoIndireta":{"type":"array","description":"Item Dados Exportação Indireta","items":{"$ref":"#/components/schemas/ExportacaoIndireta"}},"Drawback":{"type":"array","description":"Ato Consessório Drawback","items":{"$ref":"#/components/schemas/Drawback"}}}},"ExportacaoIndireta":{"type":"object","properties":{"registroExportacao":{"maximum":999999999999,"type":"integer","description":"Valor Registro Exportação"},"chaveNFe":{"maxLength":44,"minLength":44,"pattern":"^[0-9]{44}$","type":"string","description":"Chave de acesso da Nota Fiscal Eletrônica (NFe). Composta por 44 dígitos numéricos."},"qtdExportada":{"multipleOf":0.001,"maximum":99999999.999,"minimum":0.001,"type":"number","description":"Quantidade Realmente Exportada"}}},"Drawback":{"type":"object","properties":{"atoConsessorioDrawback":{"maximum":99999999999,"type":"integer","description":"Número Ato Consessório"}}}}}} ``` ## The ExportacaoIndireta object ```json {"openapi":"3.0.1","info":{"title":"Comercial Seleção Especial","version":"1.0"},"components":{"schemas":{"ExportacaoIndireta":{"type":"object","properties":{"registroExportacao":{"maximum":999999999999,"type":"integer","description":"Valor Registro Exportação"},"chaveNFe":{"maxLength":44,"minLength":44,"pattern":"^[0-9]{44}$","type":"string","description":"Chave de acesso da Nota Fiscal Eletrônica (NFe). Composta por 44 dígitos numéricos."},"qtdExportada":{"multipleOf":0.001,"maximum":99999999.999,"minimum":0.001,"type":"number","description":"Quantidade Realmente Exportada"}}}}}} ``` ## The Drawback object ```json {"openapi":"3.0.1","info":{"title":"Comercial Seleção Especial","version":"1.0"},"components":{"schemas":{"Drawback":{"type":"object","properties":{"atoConsessorioDrawback":{"maximum":99999999999,"type":"integer","description":"Número Ato Consessório"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Comercial Seleção Especial","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Comercial Seleção Especial","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Pedido De Compra pedidoCompra ## PUT /pedidoCompra > Cadastrar um Pedido de Compra ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"tags":[{"name":"Pedido de Compra","description":"pedidoCompra"}],"servers":[{"url":"https://localhost/compras/v20"},{"url":"http://localhost/compras/v20"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PedidoCompraPut":{"required":["itemPedidoCompra"],"type":"object","properties":{"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codLocalEntrega":{"type":"integer","description":"Código do Local de Entrega"},"condicaoPagamento":{"type":"integer","description":"Código da Condição de Pagamento"},"codLocalCobranca":{"type":"integer","description":"Código do Local de Cobrança"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"observacoesPadrao":{"type":"array","description":"Observações padrão","items":{"$ref":"#/components/schemas/ObservacaoPadrao"}},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)","enum":[1,2,3,4,5,6,7]},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"codMoeda":{"type":"integer","description":"Código da Moeda"},"cotacaoMoeda":{"multipleOf":0.0001,"type":"number","description":"Valor da Cotação"},"opcaoTipoFrete":{"type":"integer","description":"Opção de Tipo de Frete"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"percSeguro":{"multipleOf":0.01,"type":"number","description":"Percentual do Seguro Sobre o Valor das Mercadorias"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro Sobre o Valor das Mercadorias"},"percDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesas Acessórias"},"valorDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias"},"codPerfilComprador":{"type":"integer","description":"Código do Perfil do Comprador"},"finalidade":{"type":"number","description":"Finalidade da compra"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"condicaoPagtoInfo":{"type":"array","description":"Condição de pagamento","items":{"$ref":"#/components/schemas/CondicaoPagtoInfo"}},"diaEntgPosFatura":{"type":"integer","description":"Dias Entrega pós Faturamento"},"codPolFluxoApr":{"type":"integer","description":"Política do Fluxo de Aprovação"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompraPut"}},"observacoes":{"type":"array","description":"Observações","items":{"$ref":"#/components/schemas/Observacao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"},"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}},"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoCompra":{"put":{"tags":["Pedido de Compra"],"summary":"Cadastrar um Pedido de Compra","operationId":"GerarPedidoAPI","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Pedido de Compra","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoCompraPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /pedidoCompra/{id} > Alterar um Pedido de Compra ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"tags":[{"name":"Pedido de Compra","description":"pedidoCompra"}],"servers":[{"url":"https://localhost/compras/v20"},{"url":"http://localhost/compras/v20"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PedidoCompraPut":{"required":["itemPedidoCompra"],"type":"object","properties":{"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codLocalEntrega":{"type":"integer","description":"Código do Local de Entrega"},"condicaoPagamento":{"type":"integer","description":"Código da Condição de Pagamento"},"codLocalCobranca":{"type":"integer","description":"Código do Local de Cobrança"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"observacoesPadrao":{"type":"array","description":"Observações padrão","items":{"$ref":"#/components/schemas/ObservacaoPadrao"}},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)","enum":[1,2,3,4,5,6,7]},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"codMoeda":{"type":"integer","description":"Código da Moeda"},"cotacaoMoeda":{"multipleOf":0.0001,"type":"number","description":"Valor da Cotação"},"opcaoTipoFrete":{"type":"integer","description":"Opção de Tipo de Frete"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"percSeguro":{"multipleOf":0.01,"type":"number","description":"Percentual do Seguro Sobre o Valor das Mercadorias"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro Sobre o Valor das Mercadorias"},"percDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesas Acessórias"},"valorDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias"},"codPerfilComprador":{"type":"integer","description":"Código do Perfil do Comprador"},"finalidade":{"type":"number","description":"Finalidade da compra"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"condicaoPagtoInfo":{"type":"array","description":"Condição de pagamento","items":{"$ref":"#/components/schemas/CondicaoPagtoInfo"}},"diaEntgPosFatura":{"type":"integer","description":"Dias Entrega pós Faturamento"},"codPolFluxoApr":{"type":"integer","description":"Política do Fluxo de Aprovação"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompraPut"}},"observacoes":{"type":"array","description":"Observações","items":{"$ref":"#/components/schemas/Observacao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"},"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}},"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoCompra/{id}":{"post":{"tags":["Pedido de Compra"],"summary":"Alterar um Pedido de Compra","operationId":"AtualizarPedidoAPI","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Compra","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Pedido de Compra","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoCompraPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoCompraPut"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /pedidoCompraSolicitarLiberacao/{id} > Solicitar Liberação de um Pedido de Compra ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"tags":[{"name":"Pedido de Compra","description":"pedidoCompra"}],"servers":[{"url":"https://localhost/compras/v20"},{"url":"http://localhost/compras/v20"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PedidoCompraPut":{"required":["itemPedidoCompra"],"type":"object","properties":{"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codLocalEntrega":{"type":"integer","description":"Código do Local de Entrega"},"condicaoPagamento":{"type":"integer","description":"Código da Condição de Pagamento"},"codLocalCobranca":{"type":"integer","description":"Código do Local de Cobrança"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"observacoesPadrao":{"type":"array","description":"Observações padrão","items":{"$ref":"#/components/schemas/ObservacaoPadrao"}},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)","enum":[1,2,3,4,5,6,7]},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"codMoeda":{"type":"integer","description":"Código da Moeda"},"cotacaoMoeda":{"multipleOf":0.0001,"type":"number","description":"Valor da Cotação"},"opcaoTipoFrete":{"type":"integer","description":"Opção de Tipo de Frete"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"percSeguro":{"multipleOf":0.01,"type":"number","description":"Percentual do Seguro Sobre o Valor das Mercadorias"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro Sobre o Valor das Mercadorias"},"percDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesas Acessórias"},"valorDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias"},"codPerfilComprador":{"type":"integer","description":"Código do Perfil do Comprador"},"finalidade":{"type":"number","description":"Finalidade da compra"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"condicaoPagtoInfo":{"type":"array","description":"Condição de pagamento","items":{"$ref":"#/components/schemas/CondicaoPagtoInfo"}},"diaEntgPosFatura":{"type":"integer","description":"Dias Entrega pós Faturamento"},"codPolFluxoApr":{"type":"integer","description":"Política do Fluxo de Aprovação"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompraPut"}},"observacoes":{"type":"array","description":"Observações","items":{"$ref":"#/components/schemas/Observacao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"},"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}},"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoCompraSolicitarLiberacao/{id}":{"post":{"tags":["Pedido de Compra"],"summary":"Solicitar Liberação de um Pedido de Compra","operationId":"SolicitarLiberarPedidoCompraAPI","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Compra","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoCompraPut"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The PedidoCompraPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"PedidoCompraPut":{"required":["itemPedidoCompra"],"type":"object","properties":{"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codLocalEntrega":{"type":"integer","description":"Código do Local de Entrega"},"condicaoPagamento":{"type":"integer","description":"Código da Condição de Pagamento"},"codLocalCobranca":{"type":"integer","description":"Código do Local de Cobrança"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"observacoesPadrao":{"type":"array","description":"Observações padrão","items":{"$ref":"#/components/schemas/ObservacaoPadrao"}},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)","enum":[1,2,3,4,5,6,7]},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"codMoeda":{"type":"integer","description":"Código da Moeda"},"cotacaoMoeda":{"multipleOf":0.0001,"type":"number","description":"Valor da Cotação"},"opcaoTipoFrete":{"type":"integer","description":"Opção de Tipo de Frete"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"percSeguro":{"multipleOf":0.01,"type":"number","description":"Percentual do Seguro Sobre o Valor das Mercadorias"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro Sobre o Valor das Mercadorias"},"percDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesas Acessórias"},"valorDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias"},"codPerfilComprador":{"type":"integer","description":"Código do Perfil do Comprador"},"finalidade":{"type":"number","description":"Finalidade da compra"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"condicaoPagtoInfo":{"type":"array","description":"Condição de pagamento","items":{"$ref":"#/components/schemas/CondicaoPagtoInfo"}},"diaEntgPosFatura":{"type":"integer","description":"Dias Entrega pós Faturamento"},"codPolFluxoApr":{"type":"integer","description":"Política do Fluxo de Aprovação"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompraPut"}},"observacoes":{"type":"array","description":"Observações","items":{"$ref":"#/components/schemas/Observacao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"},"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}},"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"}}}} ``` ## The itemPedidoCompraPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The RateioCusto object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}}}}} ``` ## The CondicaoPagtoInfo object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}}}}} ``` ## The Observacao object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"}}}} ``` ## The ObservacaoItem object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"}}}} ``` ## The ObservacaoPadrao object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"}}}} ``` ## The NumeroControle object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"NumeroControle":{"required":["numControle"],"type":"object","properties":{"numControle":{"type":"number","description":"Número de Controle"}}}}}} ``` ## The MsgStatusRequisicao object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"MsgStatusRequisicao":{"type":"object","properties":{"mensagem":{"type":"string","description":"Status Retorno da Requisição"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Separação de Pedidos v1.0 # Separação Romaneio Etiqueta WMS separacaoromaneioetiquetawms ## GET /romaneiosEtiquetaWMS > Obter Listagem de Romaneios para Coletas ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaRomaneiosWMS":{"type":"object","properties":{"continuationToken":{"maxLength":50,"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListaRomaneioWMS"}}}},"ListaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Pedido"},"codSituacao":{"type":"integer","description":"Situação da Coleta (1 - Gerado, 2 - Em Separação, 3 - Encerrado, 4 - Faturado, 5 - Cancelado)","enum":[1,2,3,4,5]},"dataGeracao":{"type":"string","description":"Data Geração Romaneio"},"codOperador":{"type":"string","description":"Código do Operador do Sistema"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora"},"codNaturezaEstoque":{"type":"integer","description":"Código da Natureza do Estoque"},"priorizado":{"type":"integer","description":"Romaneio Priorizado (0 - Não, 1 - Sim)","enum":[0,1]}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/romaneiosEtiquetaWMS":{"get":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Obter Listagem de Romaneios para Coletas","operationId":"ObterListaRomaneiosEtiquetaWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaRomaneiosWMS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /romaneioEtiquetaLocalWMS/{id} > Obter Romaneio de Coleta com Localização dos Itens ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RomaneioLocalWMS":{"type":"object","properties":{"qtdDecQuantidade":{"type":"integer","description":"Número de Casas Decimais na Quantidade (0-3)"},"qtdDecPrecoUnitario":{"type":"integer","description":"Quantidade Decimais Preço Unitário (0-5)"},"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codTransportadora":{"type":"string","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Código da Transportadora"},"listaPedidos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaPedidosRomaneioWMS"}},"listaResumoProdutos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaResumoProdutos"}}}},"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/romaneioEtiquetaLocalWMS/{id}":{"get":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Obter Romaneio de Coleta com Localização dos Itens","operationId":"ObterRomaneioEtiquetaLocalWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Romaneio","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RomaneioLocalWMS"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /coletarEtiquetaWMS > Coleta de Etiqueta ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"EtiquetaColetaWMS":{"required":["codEtiqueta","codRomaneio"],"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Romaneio"},"codEtiqueta":{"maxLength":30,"type":"string","description":"Código da Etiqueta"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"PosicaoColetaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"type":"integer","description":"Código do Romaneio"},"itensRomaneioWMS":{"type":"array","description":"Itens do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/PosicaoItensRomaneioWMS"}}}},"PosicaoItensRomaneioWMS":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Produto"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Produto (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/coletarEtiquetaWMS":{"put":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Coleta de Etiqueta","operationId":"ColetaEtiquetaWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}}],"requestBody":{"description":"Dados da Contagem da Etiqueta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EtiquetaColetaWMS"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosicaoColetaRomaneioWMS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /encerrarColetaRomaneioEtiquetaWMS > Encerrar a Coleta de um Romaneio ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"EncerrarColetaRomaneioPost":{"type":"object","properties":{"codRomaneio":{"maxLength":30,"type":"string","description":"Código do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"RomaneioLocalWMS":{"type":"object","properties":{"qtdDecQuantidade":{"type":"integer","description":"Número de Casas Decimais na Quantidade (0-3)"},"qtdDecPrecoUnitario":{"type":"integer","description":"Quantidade Decimais Preço Unitário (0-5)"},"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codTransportadora":{"type":"string","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Código da Transportadora"},"listaPedidos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaPedidosRomaneioWMS"}},"listaResumoProdutos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaResumoProdutos"}}}},"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/encerrarColetaRomaneioEtiquetaWMS":{"post":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Encerrar a Coleta de um Romaneio","operationId":"EncerrarColetaRomaneioEtiquetaWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}}],"requestBody":{"description":"Dados do Romaneio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EncerrarColetaRomaneioPost"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RomaneioLocalWMS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The ListaRomaneiosWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaRomaneiosWMS":{"type":"object","properties":{"continuationToken":{"maxLength":50,"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListaRomaneioWMS"}}}},"ListaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Pedido"},"codSituacao":{"type":"integer","description":"Situação da Coleta (1 - Gerado, 2 - Em Separação, 3 - Encerrado, 4 - Faturado, 5 - Cancelado)","enum":[1,2,3,4,5]},"dataGeracao":{"type":"string","description":"Data Geração Romaneio"},"codOperador":{"type":"string","description":"Código do Operador do Sistema"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora"},"codNaturezaEstoque":{"type":"integer","description":"Código da Natureza do Estoque"},"priorizado":{"type":"integer","description":"Romaneio Priorizado (0 - Não, 1 - Sim)","enum":[0,1]}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Pedido"},"codSituacao":{"type":"integer","description":"Situação da Coleta (1 - Gerado, 2 - Em Separação, 3 - Encerrado, 4 - Faturado, 5 - Cancelado)","enum":[1,2,3,4,5]},"dataGeracao":{"type":"string","description":"Data Geração Romaneio"},"codOperador":{"type":"string","description":"Código do Operador do Sistema"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora"},"codNaturezaEstoque":{"type":"integer","description":"Código da Natureza do Estoque"},"priorizado":{"type":"integer","description":"Romaneio Priorizado (0 - Não, 1 - Sim)","enum":[0,1]}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The RomaneioLocalWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"RomaneioLocalWMS":{"type":"object","properties":{"qtdDecQuantidade":{"type":"integer","description":"Número de Casas Decimais na Quantidade (0-3)"},"qtdDecPrecoUnitario":{"type":"integer","description":"Quantidade Decimais Preço Unitário (0-5)"},"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codTransportadora":{"type":"string","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Código da Transportadora"},"listaPedidos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaPedidosRomaneioWMS"}},"listaResumoProdutos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaResumoProdutos"}}}},"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The ListaResumoProdutos object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The ListaPedidosRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The ItensRomaneioLocalWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The PosicaoColetaRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"PosicaoColetaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"type":"integer","description":"Código do Romaneio"},"itensRomaneioWMS":{"type":"array","description":"Itens do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/PosicaoItensRomaneioWMS"}}}},"PosicaoItensRomaneioWMS":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Produto"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Produto (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The PosicaoItensRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"PosicaoItensRomaneioWMS":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Produto"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Produto (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The EtiquetaColetaWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"EtiquetaColetaWMS":{"required":["codEtiqueta","codRomaneio"],"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Romaneio"},"codEtiqueta":{"maxLength":30,"type":"string","description":"Código da Etiqueta"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The EncerrarColetaRomaneioPost object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"EncerrarColetaRomaneioPost":{"type":"object","properties":{"codRomaneio":{"maxLength":30,"type":"string","description":"Código do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Separação Romaneio Etiqueta WMS separacaoromaneioetiquetawms ## GET /romaneiosEtiquetaWMS > Obter Listagem de Romaneios para Coletas ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaRomaneiosWMS":{"type":"object","properties":{"continuationToken":{"maxLength":50,"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListaRomaneioWMS"}}}},"ListaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Pedido"},"codSituacao":{"type":"integer","description":"Situação da Coleta (1 - Gerado, 2 - Em Separação, 3 - Encerrado, 4 - Faturado, 5 - Cancelado)","enum":[1,2,3,4,5]},"dataGeracao":{"type":"string","description":"Data Geração Romaneio"},"codOperador":{"type":"string","description":"Código do Operador do Sistema"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora"},"codNaturezaEstoque":{"type":"integer","description":"Código da Natureza do Estoque"},"priorizado":{"type":"integer","description":"Romaneio Priorizado (0 - Não, 1 - Sim)","enum":[0,1]}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/romaneiosEtiquetaWMS":{"get":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Obter Listagem de Romaneios para Coletas","operationId":"ObterListaRomaneiosEtiquetaWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaRomaneiosWMS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /romaneioEtiquetaLocalWMS/{id} > Obter Romaneio de Coleta com Localização dos Itens ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RomaneioLocalWMS":{"type":"object","properties":{"qtdDecQuantidade":{"type":"integer","description":"Número de Casas Decimais na Quantidade (0-3)"},"qtdDecPrecoUnitario":{"type":"integer","description":"Quantidade Decimais Preço Unitário (0-5)"},"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codTransportadora":{"type":"string","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Código da Transportadora"},"listaPedidos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaPedidosRomaneioWMS"}},"listaResumoProdutos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaResumoProdutos"}}}},"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/romaneioEtiquetaLocalWMS/{id}":{"get":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Obter Romaneio de Coleta com Localização dos Itens","operationId":"ObterRomaneioEtiquetaLocalWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Romaneio","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RomaneioLocalWMS"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /coletarEtiquetaWMS > Coleta de Etiqueta ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"EtiquetaColetaWMS":{"required":["codEtiqueta","codRomaneio"],"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Romaneio"},"codEtiqueta":{"maxLength":30,"type":"string","description":"Código da Etiqueta"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"PosicaoColetaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"type":"integer","description":"Código do Romaneio"},"itensRomaneioWMS":{"type":"array","description":"Itens do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/PosicaoItensRomaneioWMS"}}}},"PosicaoItensRomaneioWMS":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Produto"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Produto (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/coletarEtiquetaWMS":{"put":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Coleta de Etiqueta","operationId":"ColetaEtiquetaWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}}],"requestBody":{"description":"Dados da Contagem da Etiqueta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EtiquetaColetaWMS"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosicaoColetaRomaneioWMS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /encerrarColetaRomaneioEtiquetaWMS > Encerrar a Coleta de um Romaneio ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"EncerrarColetaRomaneioPost":{"type":"object","properties":{"codRomaneio":{"maxLength":30,"type":"string","description":"Código do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"RomaneioLocalWMS":{"type":"object","properties":{"qtdDecQuantidade":{"type":"integer","description":"Número de Casas Decimais na Quantidade (0-3)"},"qtdDecPrecoUnitario":{"type":"integer","description":"Quantidade Decimais Preço Unitário (0-5)"},"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codTransportadora":{"type":"string","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Código da Transportadora"},"listaPedidos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaPedidosRomaneioWMS"}},"listaResumoProdutos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaResumoProdutos"}}}},"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/encerrarColetaRomaneioEtiquetaWMS":{"post":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Encerrar a Coleta de um Romaneio","operationId":"EncerrarColetaRomaneioEtiquetaWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}}],"requestBody":{"description":"Dados do Romaneio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EncerrarColetaRomaneioPost"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RomaneioLocalWMS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The ListaRomaneiosWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaRomaneiosWMS":{"type":"object","properties":{"continuationToken":{"maxLength":50,"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListaRomaneioWMS"}}}},"ListaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Pedido"},"codSituacao":{"type":"integer","description":"Situação da Coleta (1 - Gerado, 2 - Em Separação, 3 - Encerrado, 4 - Faturado, 5 - Cancelado)","enum":[1,2,3,4,5]},"dataGeracao":{"type":"string","description":"Data Geração Romaneio"},"codOperador":{"type":"string","description":"Código do Operador do Sistema"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora"},"codNaturezaEstoque":{"type":"integer","description":"Código da Natureza do Estoque"},"priorizado":{"type":"integer","description":"Romaneio Priorizado (0 - Não, 1 - Sim)","enum":[0,1]}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Pedido"},"codSituacao":{"type":"integer","description":"Situação da Coleta (1 - Gerado, 2 - Em Separação, 3 - Encerrado, 4 - Faturado, 5 - Cancelado)","enum":[1,2,3,4,5]},"dataGeracao":{"type":"string","description":"Data Geração Romaneio"},"codOperador":{"type":"string","description":"Código do Operador do Sistema"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora"},"codNaturezaEstoque":{"type":"integer","description":"Código da Natureza do Estoque"},"priorizado":{"type":"integer","description":"Romaneio Priorizado (0 - Não, 1 - Sim)","enum":[0,1]}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The RomaneioLocalWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"RomaneioLocalWMS":{"type":"object","properties":{"qtdDecQuantidade":{"type":"integer","description":"Número de Casas Decimais na Quantidade (0-3)"},"qtdDecPrecoUnitario":{"type":"integer","description":"Quantidade Decimais Preço Unitário (0-5)"},"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codTransportadora":{"type":"string","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Código da Transportadora"},"listaPedidos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaPedidosRomaneioWMS"}},"listaResumoProdutos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaResumoProdutos"}}}},"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The ListaResumoProdutos object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The ListaPedidosRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The ItensRomaneioLocalWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The PosicaoColetaRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"PosicaoColetaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"type":"integer","description":"Código do Romaneio"},"itensRomaneioWMS":{"type":"array","description":"Itens do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/PosicaoItensRomaneioWMS"}}}},"PosicaoItensRomaneioWMS":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Produto"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Produto (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The PosicaoItensRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"PosicaoItensRomaneioWMS":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Produto"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Produto (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The EtiquetaColetaWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"EtiquetaColetaWMS":{"required":["codEtiqueta","codRomaneio"],"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Romaneio"},"codEtiqueta":{"maxLength":30,"type":"string","description":"Código da Etiqueta"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The EncerrarColetaRomaneioPost object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"EncerrarColetaRomaneioPost":{"type":"object","properties":{"codRomaneio":{"maxLength":30,"type":"string","description":"Código do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Separação Romaneio Etiqueta WMS separacaoromaneioetiquetawms ## GET /romaneiosEtiquetaWMS > Obter Listagem de Romaneios para Coletas ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaRomaneiosWMS":{"type":"object","properties":{"continuationToken":{"maxLength":50,"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListaRomaneioWMS"}}}},"ListaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Pedido"},"codSituacao":{"type":"integer","description":"Situação da Coleta (1 - Gerado, 2 - Em Separação, 3 - Encerrado, 4 - Faturado, 5 - Cancelado)","enum":[1,2,3,4,5]},"dataGeracao":{"type":"string","description":"Data Geração Romaneio"},"codOperador":{"type":"string","description":"Código do Operador do Sistema"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora"},"codNaturezaEstoque":{"type":"integer","description":"Código da Natureza do Estoque"},"priorizado":{"type":"integer","description":"Romaneio Priorizado (0 - Não, 1 - Sim)","enum":[0,1]}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/romaneiosEtiquetaWMS":{"get":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Obter Listagem de Romaneios para Coletas","operationId":"ObterListaRomaneiosEtiquetaWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaRomaneiosWMS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /romaneioEtiquetaLocalWMS/{id} > Obter Romaneio de Coleta com Localização dos Itens ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RomaneioLocalWMS":{"type":"object","properties":{"qtdDecQuantidade":{"type":"integer","description":"Número de Casas Decimais na Quantidade (0-3)"},"qtdDecPrecoUnitario":{"type":"integer","description":"Quantidade Decimais Preço Unitário (0-5)"},"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codTransportadora":{"type":"string","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Código da Transportadora"},"listaPedidos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaPedidosRomaneioWMS"}},"listaResumoProdutos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaResumoProdutos"}}}},"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/romaneioEtiquetaLocalWMS/{id}":{"get":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Obter Romaneio de Coleta com Localização dos Itens","operationId":"ObterRomaneioEtiquetaLocalWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Romaneio","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RomaneioLocalWMS"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /coletarEtiquetaWMS > Coleta de Etiqueta ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"EtiquetaColetaWMS":{"required":["codEtiqueta","codRomaneio"],"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Romaneio"},"codEtiqueta":{"maxLength":30,"type":"string","description":"Código da Etiqueta"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"PosicaoColetaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"type":"integer","description":"Código do Romaneio"},"itensRomaneioWMS":{"type":"array","description":"Itens do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/PosicaoItensRomaneioWMS"}}}},"PosicaoItensRomaneioWMS":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Produto"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Produto (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/coletarEtiquetaWMS":{"put":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Coleta de Etiqueta","operationId":"ColetaEtiquetaWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}}],"requestBody":{"description":"Dados da Contagem da Etiqueta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EtiquetaColetaWMS"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosicaoColetaRomaneioWMS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /encerrarColetaRomaneioEtiquetaWMS > Encerrar a Coleta de um Romaneio ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"tags":[{"name":"Separação Romaneio Etiqueta WMS","description":"separacaoromaneioetiquetawms"}],"servers":[{"url":"https://localhost/comercialseparacaopedido/v10"},{"url":"http://localhost/comercialseparacaopedido/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"EncerrarColetaRomaneioPost":{"type":"object","properties":{"codRomaneio":{"maxLength":30,"type":"string","description":"Código do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"RomaneioLocalWMS":{"type":"object","properties":{"qtdDecQuantidade":{"type":"integer","description":"Número de Casas Decimais na Quantidade (0-3)"},"qtdDecPrecoUnitario":{"type":"integer","description":"Quantidade Decimais Preço Unitário (0-5)"},"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codTransportadora":{"type":"string","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Código da Transportadora"},"listaPedidos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaPedidosRomaneioWMS"}},"listaResumoProdutos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaResumoProdutos"}}}},"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/encerrarColetaRomaneioEtiquetaWMS":{"post":{"tags":["Separação Romaneio Etiqueta WMS"],"summary":"Encerrar a Coleta de um Romaneio","operationId":"EncerrarColetaRomaneioEtiquetaWMS","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"string"}},{"name":"usuario","in":"header","description":"Código do Usuário no ERP Consistem","schema":{"type":"string"}}],"requestBody":{"description":"Dados do Romaneio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EncerrarColetaRomaneioPost"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RomaneioLocalWMS"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The ListaRomaneiosWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaRomaneiosWMS":{"type":"object","properties":{"continuationToken":{"maxLength":50,"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ListaRomaneioWMS"}}}},"ListaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Pedido"},"codSituacao":{"type":"integer","description":"Situação da Coleta (1 - Gerado, 2 - Em Separação, 3 - Encerrado, 4 - Faturado, 5 - Cancelado)","enum":[1,2,3,4,5]},"dataGeracao":{"type":"string","description":"Data Geração Romaneio"},"codOperador":{"type":"string","description":"Código do Operador do Sistema"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora"},"codNaturezaEstoque":{"type":"integer","description":"Código da Natureza do Estoque"},"priorizado":{"type":"integer","description":"Romaneio Priorizado (0 - Não, 1 - Sim)","enum":[0,1]}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Pedido"},"codSituacao":{"type":"integer","description":"Situação da Coleta (1 - Gerado, 2 - Em Separação, 3 - Encerrado, 4 - Faturado, 5 - Cancelado)","enum":[1,2,3,4,5]},"dataGeracao":{"type":"string","description":"Data Geração Romaneio"},"codOperador":{"type":"string","description":"Código do Operador do Sistema"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Descrição da Transportadora"},"codNaturezaEstoque":{"type":"integer","description":"Código da Natureza do Estoque"},"priorizado":{"type":"integer","description":"Romaneio Priorizado (0 - Não, 1 - Sim)","enum":[0,1]}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The RomaneioLocalWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"RomaneioLocalWMS":{"type":"object","properties":{"qtdDecQuantidade":{"type":"integer","description":"Número de Casas Decimais na Quantidade (0-3)"},"qtdDecPrecoUnitario":{"type":"integer","description":"Quantidade Decimais Preço Unitário (0-5)"},"codRomaneio":{"type":"string","description":"Código do Romaneio"},"codTransportadora":{"type":"string","description":"Código da Transportadora"},"descTransportadora":{"type":"string","description":"Código da Transportadora"},"listaPedidos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaPedidosRomaneioWMS"}},"listaResumoProdutos":{"type":"array","description":"Lista de Pedidos do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/ListaResumoProdutos"}}}},"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}},"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The ListaResumoProdutos object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaResumoProdutos":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"unidadeMedida":{"type":"string","description":"Unidade de Medida do Produto"},"localizacaoWMS":{"type":"string","description":"Localização do Produto"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"qtdRomanear":{"type":"number","description":"Quantidade para Coletar"},"qtdRomanearEdt":{"type":"string","description":"Quantidade para Coletar (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The ListaPedidosRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ListaPedidosRomaneioWMS":{"type":"object","properties":{"codCliente":{"type":"integer","description":"Código do Cliente"},"codPedido":{"type":"string","description":"Código do Pedido"},"codTipoNota":{"type":"string","description":"Código do Tipo de Nota do Pedido"},"dataEmissao":{"type":"string","description":"Data de Emissão do Pedido (YYYY-MM-DD)","format":"date"},"descCliente":{"type":"string","description":"Razão Social do Cliente"},"descTipoNota":{"type":"string","description":"Descrição do Tipo de Nota do Pedido"},"observacaoPedido":{"type":"string","description":"Observação do Pedido"},"qtdTotalPedidoRomanear":{"type":"number","description":"Quantidade Total a Romanear do Pedido"},"qtdTotalPedidoRomanearEdt":{"type":"string","description":"Quantidade Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"tipoGeracaoRomPedido":{"type":"string","description":"Tipo de Geração do Romaneio do Pedido"},"valorPedido":{"type":"number","description":"Valor Total do Pedido"},"valorPedidoEdt":{"type":"string","description":"Valor Total do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"valorTotalPedidoRomanear":{"type":"number","description":"Valor Total a Romanear do Pedido"},"valorTotalPedidoRomanearEdt":{"type":"string","description":"Valor Total a Romanear do Pedido (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"itens":{"type":"array","description":"Itens do Pedido","items":{"$ref":"#/components/schemas/ItensRomaneioLocalWMS"}}}},"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The ItensRomaneioLocalWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"ItensRomaneioLocalWMS":{"type":"object","properties":{"codProduto":{"type":"integer","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Pedido"},"localNatureza":{"type":"string","description":"Natureza de Estoque"},"localizacaoWMS":{"type":"string","description":"Localização do Produto no WMS"},"qtdItem":{"type":"number","description":"Quantidade a Romanear do Item"},"qtdItemEdt":{"type":"string","description":"Quantidade a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Item"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"},"uniMedida":{"type":"string","description":"Unidade de Medida do Item"},"valorRomanearItem":{"type":"number","description":"Valor a Romanear do Item"},"valorRomanearItemEdt":{"type":"string","description":"Valor a Romanear do Item (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The PosicaoColetaRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"PosicaoColetaRomaneioWMS":{"type":"object","properties":{"codRomaneio":{"type":"integer","description":"Código do Romaneio"},"itensRomaneioWMS":{"type":"array","description":"Itens do Romaneio Coleta WMS","items":{"$ref":"#/components/schemas/PosicaoItensRomaneioWMS"}}}},"PosicaoItensRomaneioWMS":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Produto"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Produto (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The PosicaoItensRomaneioWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"PosicaoItensRomaneioWMS":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdColetada":{"type":"number","description":"Quantidade Coletada do Produto"},"qtdColetadaEdt":{"type":"string","description":"Quantidade Coletada do Produto (Editado Conforme Decimais Configuradas no ERP-Consistem)"}}}}}} ``` ## The EtiquetaColetaWMS object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"EtiquetaColetaWMS":{"required":["codEtiqueta","codRomaneio"],"type":"object","properties":{"codRomaneio":{"maximum":999999,"type":"integer","description":"Código do Romaneio"},"codEtiqueta":{"maxLength":30,"type":"string","description":"Código da Etiqueta"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The EncerrarColetaRomaneioPost object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"EncerrarColetaRomaneioPost":{"type":"object","properties":{"codRomaneio":{"maxLength":30,"type":"string","description":"Código do Romaneio"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Comercial Separação de Pedidos","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Televendas - CRM v1.0 # Televendas Contato contato ## GET /contato > Obter Listagem de Contatos ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Contato","description":"contato"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaContato":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Contato"}}}},"Contato":{"type":"object","properties":{"empresa":{"type":"integer","description":"Código da Empresa"},"codContato":{"type":"integer","description":"Código do Contato"},"atendente":{"type":"integer","description":"Código do Atendente"},"cnpj":{"type":"string","description":"Código do CNPJ"},"cidade":{"type":"string","description":"Código da Cidade"},"cliente":{"type":"integer","description":"Código do Cliente"},"consignatario":{"type":"integer","description":"Código do Consignatário"},"transportadora":{"type":"integer","description":"Código da Transportadora"},"formaContato":{"type":"integer","description":"Código da Forma de Contato"},"ocupacaoPesFisica":{"type":"integer","description":"Código da Ocupação para Pessoa Física"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade"},"subRamoAtividade":{"type":"string","description":"Código do Sub-Ramo de Atividade"},"representante":{"type":"integer","description":"Código do Representante"},"setorVenda":{"type":"string","description":"Código do Setor de Venda"},"nivelServico":{"type":"string","description":"Nível de Serviço"},"orcamentoContato":{"type":"string","description":"Contato Orçamento"},"codLead":{"type":"integer","description":"Código do Lead"},"bairro":{"type":"string","description":"Bairro"},"cepCompleto":{"type":"string","description":"CEP Completo"},"codEstruturaComl":{"type":"string","description":"Código da Estrutura Comercial"},"consumidorFinal":{"type":"integer","description":"É Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"contatoPadrao":{"type":"string","description":"Contato Padrão"},"cxPostal":{"type":"string","description":"Caixa Postal"},"dataCadastro":{"type":"string","description":"Data do Cadastro (YYYY-MM-DD)","format":"date"},"email":{"type":"string","description":"E-mail Principal do Contato"},"emailNfe":{"type":"string","description":"E-mail para NF-e"},"emailSecundarioNfe":{"type":"string","description":"E-mail Secundário do Contato"},"endComplementar":{"type":"string","description":"Endereço Complementar"},"endereco":{"type":"string","description":"Endereço Padrão"},"enderecoNumero":{"type":"string","description":"Número do Endereço"},"fantasia":{"type":"string","description":"Nome Fantasia"},"fax":{"type":"string","description":"Número de Fax"},"frequenciaContato":{"type":"integer","description":"Número de Dias em que Deve-se Entrar em Contato com o Cliente"},"frequenciaNF":{"type":"integer","description":"Frequência da Nota Fiscal"},"homepage":{"type":"string","description":"Home Page do Contato"},"inscricaoEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"uf":{"type":"string","description":"Código do Estado"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","description":"País do Contato"},"proximidade":{"type":"string","description":"Proximidade"},"razaoSocial":{"type":"string","description":"Razão Social"},"rzSocCobEscritural":{"type":"string","description":"Razão Social - Cobrança Escritural"},"situacao":{"type":"integer","description":"Situação (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"type":"string","description":"Número de Telefone"},"tipo":{"type":"integer","description":"Tipo do Contato (1-Prospect, 2-Cliente)","enum":[1,2]},"recMalaDireta":{"type":"integer","description":"Recebe Mala Direta? (0-Não, 1-Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Contaot é Simples Nacional? (0-Não, 1-Sim)","enum":[0,1]},"irpjLucroPresumido":{"type":"integer","description":"IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)","enum":[0,1]},"dataAssociacao":{"type":"string","description":"Data da Associação (YYYY-MM-DD)","format":"date"},"tipoReferencia":{"type":"integer","description":"Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)","enum":[1,2,3,4,5]},"enderecoEntrega":{"type":"array","description":"Endereços de Entrega","items":{"$ref":"#/components/schemas/ContatoEnderecoEntrega"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ContatoEnderecoEntrega":{"required":["bairro","cep","endereco","numero","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço"},"localEntrega":{"maxLength":35,"type":"string","description":"Local de Entrega"},"endereco":{"maxLength":40,"minLength":1,"type":"string","description":"Endereço"},"numero":{"maxLength":4,"minLength":1,"type":"string","description":"Número do Endereço"},"complemento":{"maxLength":60,"type":"string","description":"Complemento"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP"},"cpfCnpj":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ"},"inscEstadual":{"maxLength":18,"type":"string","description":"Código da Inscrição Estadual"},"telefone":{"maxLength":20,"type":"string","description":"Número do Telefone"},"horario":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contato":{"get":{"tags":["Televendas - Contato"],"summary":"Obter Listagem de Contatos","operationId":"ObterContatos","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaContato"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /contato > Cadastrar um Contato ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Contato","description":"contato"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ContatoPut":{"required":["atendente","bairro","cepCompleto","consumidorFinal","endereco","enderecoNumero","frequenciaContato","frequenciaNF","irpjLucroPresumido","razaoSocial","recMalaDireta","representante","simplesNacional","situacao","telefone","tipo"],"type":"object","properties":{"atendente":{"maximum":9999,"minimum":1,"type":"integer","description":"Código do Atendente"},"cnpj":{"maxLength":14,"type":"string","description":"Código do CNPJ"},"cidade":{"maxLength":60,"type":"string","description":"Código da Cidade"},"cliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"consignatario":{"maximum":9999,"type":"integer","description":"Código do Consignatário"},"transportadora":{"maximum":9999,"type":"integer","description":"Código da Transportadora"},"formaContato":{"maximum":999,"type":"integer","description":"Código da Forma de Contato"},"ocupacaoPesFisica":{"maximum":999,"type":"integer","description":"Código da Ocupação para Pessoa Física"},"ramoAtividade":{"maximum":99,"type":"integer","description":"Código do Ramo de Atividade"},"subRamoAtividade":{"maxLength":3,"type":"string","description":"Código do Sub-Ramo de Atividade"},"representante":{"maximum":9999,"minimum":1,"type":"integer","description":"Código do Representante"},"setorVenda":{"maxLength":3,"type":"string","description":"Código do Setor de Venda"},"nivelServico":{"maxLength":4,"type":"string","description":"Nível de Serviço"},"codLead":{"maximum":9999,"type":"integer","description":"Código do Lead"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cepCompleto":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP Completo"},"codEstruturaComl":{"maxLength":50,"type":"string","description":"Código da Estrutura Comercial"},"consumidorFinal":{"type":"integer","description":"É Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"contatoPadrao":{"maxLength":50,"type":"string","description":"Contato Padrão"},"cxPostal":{"maxLength":10,"type":"string","description":"Caixa Postal"},"dataCadastro":{"type":"string","description":"Data do Cadastro (YYYY-MM-DD)","format":"date"},"email":{"maxLength":50,"type":"string","description":"E-mail Principal do Contato"},"emailNfe":{"maxLength":50,"type":"string","description":"E-mail para NF-e"},"emailSecundarioNfe":{"maxLength":999,"type":"string","description":"E-mail Secundário do Contato"},"endComplementar":{"maxLength":30,"type":"string","description":"Endereço Complementar"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço Padrão"},"enderecoNumero":{"maxLength":10,"minLength":1,"type":"string","description":"Número do Endereço"},"fantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia"},"fax":{"maxLength":15,"type":"string","description":"Número de Fax"},"frequenciaContato":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Dias em que Deve-se Entrar em Contato com o Cliente"},"frequenciaNF":{"maximum":9999,"minimum":1,"type":"integer","description":"Frequência da Nota Fiscal"},"homepage":{"maxLength":100,"type":"string","description":"Home Page do Contato"},"inscricaoEstadual":{"maxLength":15,"type":"string","description":"Código da Inscrição Estadual"},"uf":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"},"observacao":{"maxLength":50,"type":"string","description":"Observação"},"pais":{"maxLength":50,"type":"string","description":"País do Contato"},"proximidade":{"maxLength":25,"type":"string","description":"Proximidade"},"razaoSocial":{"maxLength":60,"minLength":1,"type":"string","description":"Razão Social"},"rzSocCobEscritural":{"maxLength":40,"type":"string","description":"Razão Social - Cobrança Escritural"},"situacao":{"type":"integer","description":"Situação (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"minLength":1,"type":"string","description":"Número de Telefone"},"tipo":{"type":"integer","description":"Tipo do Contato (1-Prospect, 2-Cliente)","enum":[1,2]},"recMalaDireta":{"type":"integer","description":"Recebe Mala Direta? (0-Não, 1-Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Contaot é Simples Nacional? (0-Não, 1-Sim)","enum":[0,1]},"irpjLucroPresumido":{"type":"integer","description":"IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)","enum":[0,1]},"dataAssociacao":{"type":"string","description":"Data da Associação (YYYY-MM-DD)","format":"date"},"tipoReferencia":{"type":"integer","description":"Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)","enum":[1,2,3,4,5]},"enderecoEntrega":{"type":"array","description":"Endereços de Entrega","items":{"$ref":"#/components/schemas/ContatoEnderecoEntrega"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ContatoEnderecoEntrega":{"required":["bairro","cep","endereco","numero","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço"},"localEntrega":{"maxLength":35,"type":"string","description":"Local de Entrega"},"endereco":{"maxLength":40,"minLength":1,"type":"string","description":"Endereço"},"numero":{"maxLength":4,"minLength":1,"type":"string","description":"Número do Endereço"},"complemento":{"maxLength":60,"type":"string","description":"Complemento"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP"},"cpfCnpj":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ"},"inscEstadual":{"maxLength":18,"type":"string","description":"Código da Inscrição Estadual"},"telefone":{"maxLength":20,"type":"string","description":"Número do Telefone"},"horario":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Contato":{"type":"object","properties":{"empresa":{"type":"integer","description":"Código da Empresa"},"codContato":{"type":"integer","description":"Código do Contato"},"atendente":{"type":"integer","description":"Código do Atendente"},"cnpj":{"type":"string","description":"Código do CNPJ"},"cidade":{"type":"string","description":"Código da Cidade"},"cliente":{"type":"integer","description":"Código do Cliente"},"consignatario":{"type":"integer","description":"Código do Consignatário"},"transportadora":{"type":"integer","description":"Código da Transportadora"},"formaContato":{"type":"integer","description":"Código da Forma de Contato"},"ocupacaoPesFisica":{"type":"integer","description":"Código da Ocupação para Pessoa Física"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade"},"subRamoAtividade":{"type":"string","description":"Código do Sub-Ramo de Atividade"},"representante":{"type":"integer","description":"Código do Representante"},"setorVenda":{"type":"string","description":"Código do Setor de Venda"},"nivelServico":{"type":"string","description":"Nível de Serviço"},"orcamentoContato":{"type":"string","description":"Contato Orçamento"},"codLead":{"type":"integer","description":"Código do Lead"},"bairro":{"type":"string","description":"Bairro"},"cepCompleto":{"type":"string","description":"CEP Completo"},"codEstruturaComl":{"type":"string","description":"Código da Estrutura Comercial"},"consumidorFinal":{"type":"integer","description":"É Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"contatoPadrao":{"type":"string","description":"Contato Padrão"},"cxPostal":{"type":"string","description":"Caixa Postal"},"dataCadastro":{"type":"string","description":"Data do Cadastro (YYYY-MM-DD)","format":"date"},"email":{"type":"string","description":"E-mail Principal do Contato"},"emailNfe":{"type":"string","description":"E-mail para NF-e"},"emailSecundarioNfe":{"type":"string","description":"E-mail Secundário do Contato"},"endComplementar":{"type":"string","description":"Endereço Complementar"},"endereco":{"type":"string","description":"Endereço Padrão"},"enderecoNumero":{"type":"string","description":"Número do Endereço"},"fantasia":{"type":"string","description":"Nome Fantasia"},"fax":{"type":"string","description":"Número de Fax"},"frequenciaContato":{"type":"integer","description":"Número de Dias em que Deve-se Entrar em Contato com o Cliente"},"frequenciaNF":{"type":"integer","description":"Frequência da Nota Fiscal"},"homepage":{"type":"string","description":"Home Page do Contato"},"inscricaoEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"uf":{"type":"string","description":"Código do Estado"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","description":"País do Contato"},"proximidade":{"type":"string","description":"Proximidade"},"razaoSocial":{"type":"string","description":"Razão Social"},"rzSocCobEscritural":{"type":"string","description":"Razão Social - Cobrança Escritural"},"situacao":{"type":"integer","description":"Situação (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"type":"string","description":"Número de Telefone"},"tipo":{"type":"integer","description":"Tipo do Contato (1-Prospect, 2-Cliente)","enum":[1,2]},"recMalaDireta":{"type":"integer","description":"Recebe Mala Direta? (0-Não, 1-Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Contaot é Simples Nacional? (0-Não, 1-Sim)","enum":[0,1]},"irpjLucroPresumido":{"type":"integer","description":"IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)","enum":[0,1]},"dataAssociacao":{"type":"string","description":"Data da Associação (YYYY-MM-DD)","format":"date"},"tipoReferencia":{"type":"integer","description":"Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)","enum":[1,2,3,4,5]},"enderecoEntrega":{"type":"array","description":"Endereços de Entrega","items":{"$ref":"#/components/schemas/ContatoEnderecoEntrega"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contato":{"put":{"tags":["Televendas - Contato"],"summary":"Cadastrar um Contato","operationId":"CadastrarContato","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Contato","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContatoPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contato"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /contato/{id} > Obter um Contato ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Contato","description":"contato"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Contato":{"type":"object","properties":{"empresa":{"type":"integer","description":"Código da Empresa"},"codContato":{"type":"integer","description":"Código do Contato"},"atendente":{"type":"integer","description":"Código do Atendente"},"cnpj":{"type":"string","description":"Código do CNPJ"},"cidade":{"type":"string","description":"Código da Cidade"},"cliente":{"type":"integer","description":"Código do Cliente"},"consignatario":{"type":"integer","description":"Código do Consignatário"},"transportadora":{"type":"integer","description":"Código da Transportadora"},"formaContato":{"type":"integer","description":"Código da Forma de Contato"},"ocupacaoPesFisica":{"type":"integer","description":"Código da Ocupação para Pessoa Física"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade"},"subRamoAtividade":{"type":"string","description":"Código do Sub-Ramo de Atividade"},"representante":{"type":"integer","description":"Código do Representante"},"setorVenda":{"type":"string","description":"Código do Setor de Venda"},"nivelServico":{"type":"string","description":"Nível de Serviço"},"orcamentoContato":{"type":"string","description":"Contato Orçamento"},"codLead":{"type":"integer","description":"Código do Lead"},"bairro":{"type":"string","description":"Bairro"},"cepCompleto":{"type":"string","description":"CEP Completo"},"codEstruturaComl":{"type":"string","description":"Código da Estrutura Comercial"},"consumidorFinal":{"type":"integer","description":"É Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"contatoPadrao":{"type":"string","description":"Contato Padrão"},"cxPostal":{"type":"string","description":"Caixa Postal"},"dataCadastro":{"type":"string","description":"Data do Cadastro (YYYY-MM-DD)","format":"date"},"email":{"type":"string","description":"E-mail Principal do Contato"},"emailNfe":{"type":"string","description":"E-mail para NF-e"},"emailSecundarioNfe":{"type":"string","description":"E-mail Secundário do Contato"},"endComplementar":{"type":"string","description":"Endereço Complementar"},"endereco":{"type":"string","description":"Endereço Padrão"},"enderecoNumero":{"type":"string","description":"Número do Endereço"},"fantasia":{"type":"string","description":"Nome Fantasia"},"fax":{"type":"string","description":"Número de Fax"},"frequenciaContato":{"type":"integer","description":"Número de Dias em que Deve-se Entrar em Contato com o Cliente"},"frequenciaNF":{"type":"integer","description":"Frequência da Nota Fiscal"},"homepage":{"type":"string","description":"Home Page do Contato"},"inscricaoEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"uf":{"type":"string","description":"Código do Estado"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","description":"País do Contato"},"proximidade":{"type":"string","description":"Proximidade"},"razaoSocial":{"type":"string","description":"Razão Social"},"rzSocCobEscritural":{"type":"string","description":"Razão Social - Cobrança Escritural"},"situacao":{"type":"integer","description":"Situação (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"type":"string","description":"Número de Telefone"},"tipo":{"type":"integer","description":"Tipo do Contato (1-Prospect, 2-Cliente)","enum":[1,2]},"recMalaDireta":{"type":"integer","description":"Recebe Mala Direta? (0-Não, 1-Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Contaot é Simples Nacional? (0-Não, 1-Sim)","enum":[0,1]},"irpjLucroPresumido":{"type":"integer","description":"IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)","enum":[0,1]},"dataAssociacao":{"type":"string","description":"Data da Associação (YYYY-MM-DD)","format":"date"},"tipoReferencia":{"type":"integer","description":"Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)","enum":[1,2,3,4,5]},"enderecoEntrega":{"type":"array","description":"Endereços de Entrega","items":{"$ref":"#/components/schemas/ContatoEnderecoEntrega"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ContatoEnderecoEntrega":{"required":["bairro","cep","endereco","numero","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço"},"localEntrega":{"maxLength":35,"type":"string","description":"Local de Entrega"},"endereco":{"maxLength":40,"minLength":1,"type":"string","description":"Endereço"},"numero":{"maxLength":4,"minLength":1,"type":"string","description":"Número do Endereço"},"complemento":{"maxLength":60,"type":"string","description":"Complemento"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP"},"cpfCnpj":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ"},"inscEstadual":{"maxLength":18,"type":"string","description":"Código da Inscrição Estadual"},"telefone":{"maxLength":20,"type":"string","description":"Número do Telefone"},"horario":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contato/{id}":{"get":{"tags":["Televendas - Contato"],"summary":"Obter um Contato","operationId":"ObterContato","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Contato","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Contato"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /contato/{id} > Atualizar um Contato ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Contato","description":"contato"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ContatoPut":{"required":["atendente","bairro","cepCompleto","consumidorFinal","endereco","enderecoNumero","frequenciaContato","frequenciaNF","irpjLucroPresumido","razaoSocial","recMalaDireta","representante","simplesNacional","situacao","telefone","tipo"],"type":"object","properties":{"atendente":{"maximum":9999,"minimum":1,"type":"integer","description":"Código do Atendente"},"cnpj":{"maxLength":14,"type":"string","description":"Código do CNPJ"},"cidade":{"maxLength":60,"type":"string","description":"Código da Cidade"},"cliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"consignatario":{"maximum":9999,"type":"integer","description":"Código do Consignatário"},"transportadora":{"maximum":9999,"type":"integer","description":"Código da Transportadora"},"formaContato":{"maximum":999,"type":"integer","description":"Código da Forma de Contato"},"ocupacaoPesFisica":{"maximum":999,"type":"integer","description":"Código da Ocupação para Pessoa Física"},"ramoAtividade":{"maximum":99,"type":"integer","description":"Código do Ramo de Atividade"},"subRamoAtividade":{"maxLength":3,"type":"string","description":"Código do Sub-Ramo de Atividade"},"representante":{"maximum":9999,"minimum":1,"type":"integer","description":"Código do Representante"},"setorVenda":{"maxLength":3,"type":"string","description":"Código do Setor de Venda"},"nivelServico":{"maxLength":4,"type":"string","description":"Nível de Serviço"},"codLead":{"maximum":9999,"type":"integer","description":"Código do Lead"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cepCompleto":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP Completo"},"codEstruturaComl":{"maxLength":50,"type":"string","description":"Código da Estrutura Comercial"},"consumidorFinal":{"type":"integer","description":"É Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"contatoPadrao":{"maxLength":50,"type":"string","description":"Contato Padrão"},"cxPostal":{"maxLength":10,"type":"string","description":"Caixa Postal"},"dataCadastro":{"type":"string","description":"Data do Cadastro (YYYY-MM-DD)","format":"date"},"email":{"maxLength":50,"type":"string","description":"E-mail Principal do Contato"},"emailNfe":{"maxLength":50,"type":"string","description":"E-mail para NF-e"},"emailSecundarioNfe":{"maxLength":999,"type":"string","description":"E-mail Secundário do Contato"},"endComplementar":{"maxLength":30,"type":"string","description":"Endereço Complementar"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço Padrão"},"enderecoNumero":{"maxLength":10,"minLength":1,"type":"string","description":"Número do Endereço"},"fantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia"},"fax":{"maxLength":15,"type":"string","description":"Número de Fax"},"frequenciaContato":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Dias em que Deve-se Entrar em Contato com o Cliente"},"frequenciaNF":{"maximum":9999,"minimum":1,"type":"integer","description":"Frequência da Nota Fiscal"},"homepage":{"maxLength":100,"type":"string","description":"Home Page do Contato"},"inscricaoEstadual":{"maxLength":15,"type":"string","description":"Código da Inscrição Estadual"},"uf":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"},"observacao":{"maxLength":50,"type":"string","description":"Observação"},"pais":{"maxLength":50,"type":"string","description":"País do Contato"},"proximidade":{"maxLength":25,"type":"string","description":"Proximidade"},"razaoSocial":{"maxLength":60,"minLength":1,"type":"string","description":"Razão Social"},"rzSocCobEscritural":{"maxLength":40,"type":"string","description":"Razão Social - Cobrança Escritural"},"situacao":{"type":"integer","description":"Situação (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"minLength":1,"type":"string","description":"Número de Telefone"},"tipo":{"type":"integer","description":"Tipo do Contato (1-Prospect, 2-Cliente)","enum":[1,2]},"recMalaDireta":{"type":"integer","description":"Recebe Mala Direta? (0-Não, 1-Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Contaot é Simples Nacional? (0-Não, 1-Sim)","enum":[0,1]},"irpjLucroPresumido":{"type":"integer","description":"IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)","enum":[0,1]},"dataAssociacao":{"type":"string","description":"Data da Associação (YYYY-MM-DD)","format":"date"},"tipoReferencia":{"type":"integer","description":"Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)","enum":[1,2,3,4,5]},"enderecoEntrega":{"type":"array","description":"Endereços de Entrega","items":{"$ref":"#/components/schemas/ContatoEnderecoEntrega"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ContatoEnderecoEntrega":{"required":["bairro","cep","endereco","numero","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço"},"localEntrega":{"maxLength":35,"type":"string","description":"Local de Entrega"},"endereco":{"maxLength":40,"minLength":1,"type":"string","description":"Endereço"},"numero":{"maxLength":4,"minLength":1,"type":"string","description":"Número do Endereço"},"complemento":{"maxLength":60,"type":"string","description":"Complemento"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP"},"cpfCnpj":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ"},"inscEstadual":{"maxLength":18,"type":"string","description":"Código da Inscrição Estadual"},"telefone":{"maxLength":20,"type":"string","description":"Número do Telefone"},"horario":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Contato":{"type":"object","properties":{"empresa":{"type":"integer","description":"Código da Empresa"},"codContato":{"type":"integer","description":"Código do Contato"},"atendente":{"type":"integer","description":"Código do Atendente"},"cnpj":{"type":"string","description":"Código do CNPJ"},"cidade":{"type":"string","description":"Código da Cidade"},"cliente":{"type":"integer","description":"Código do Cliente"},"consignatario":{"type":"integer","description":"Código do Consignatário"},"transportadora":{"type":"integer","description":"Código da Transportadora"},"formaContato":{"type":"integer","description":"Código da Forma de Contato"},"ocupacaoPesFisica":{"type":"integer","description":"Código da Ocupação para Pessoa Física"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade"},"subRamoAtividade":{"type":"string","description":"Código do Sub-Ramo de Atividade"},"representante":{"type":"integer","description":"Código do Representante"},"setorVenda":{"type":"string","description":"Código do Setor de Venda"},"nivelServico":{"type":"string","description":"Nível de Serviço"},"orcamentoContato":{"type":"string","description":"Contato Orçamento"},"codLead":{"type":"integer","description":"Código do Lead"},"bairro":{"type":"string","description":"Bairro"},"cepCompleto":{"type":"string","description":"CEP Completo"},"codEstruturaComl":{"type":"string","description":"Código da Estrutura Comercial"},"consumidorFinal":{"type":"integer","description":"É Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"contatoPadrao":{"type":"string","description":"Contato Padrão"},"cxPostal":{"type":"string","description":"Caixa Postal"},"dataCadastro":{"type":"string","description":"Data do Cadastro (YYYY-MM-DD)","format":"date"},"email":{"type":"string","description":"E-mail Principal do Contato"},"emailNfe":{"type":"string","description":"E-mail para NF-e"},"emailSecundarioNfe":{"type":"string","description":"E-mail Secundário do Contato"},"endComplementar":{"type":"string","description":"Endereço Complementar"},"endereco":{"type":"string","description":"Endereço Padrão"},"enderecoNumero":{"type":"string","description":"Número do Endereço"},"fantasia":{"type":"string","description":"Nome Fantasia"},"fax":{"type":"string","description":"Número de Fax"},"frequenciaContato":{"type":"integer","description":"Número de Dias em que Deve-se Entrar em Contato com o Cliente"},"frequenciaNF":{"type":"integer","description":"Frequência da Nota Fiscal"},"homepage":{"type":"string","description":"Home Page do Contato"},"inscricaoEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"uf":{"type":"string","description":"Código do Estado"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","description":"País do Contato"},"proximidade":{"type":"string","description":"Proximidade"},"razaoSocial":{"type":"string","description":"Razão Social"},"rzSocCobEscritural":{"type":"string","description":"Razão Social - Cobrança Escritural"},"situacao":{"type":"integer","description":"Situação (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"type":"string","description":"Número de Telefone"},"tipo":{"type":"integer","description":"Tipo do Contato (1-Prospect, 2-Cliente)","enum":[1,2]},"recMalaDireta":{"type":"integer","description":"Recebe Mala Direta? (0-Não, 1-Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Contaot é Simples Nacional? (0-Não, 1-Sim)","enum":[0,1]},"irpjLucroPresumido":{"type":"integer","description":"IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)","enum":[0,1]},"dataAssociacao":{"type":"string","description":"Data da Associação (YYYY-MM-DD)","format":"date"},"tipoReferencia":{"type":"integer","description":"Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)","enum":[1,2,3,4,5]},"enderecoEntrega":{"type":"array","description":"Endereços de Entrega","items":{"$ref":"#/components/schemas/ContatoEnderecoEntrega"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contato/{id}":{"put":{"tags":["Televendas - Contato"],"summary":"Atualizar um Contato","operationId":"AtualizarContato","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Contato","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Contato","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContatoPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contato"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /contato/{id} > Excluir um Contato ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Contato","description":"contato"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contato/{id}":{"delete":{"tags":["Televendas - Contato"],"summary":"Excluir um Contato","operationId":"ExcluirContato","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Contato","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Televendas Orçamento orcamento ## GET /orcamento > Obter Listagem de Orçamentos ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Orçamento","description":"orcamento"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaOrcamento":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Orcamento"}}}},"Orcamento":{"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"dataUnidadeMonetaria":{"type":"string","description":"Data da Moeda"},"valorUnidadeMonetaria":{"type":"number","description":"Valor da Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"type":"number","description":"Desconto do Orçamento"},"desconto2":{"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Em percentual, 1 - Em valor)","enum":[0,1]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"type":"number","description":"Valor Antecipado"},"valorDesconto":{"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"type":"number","description":"Valor do Frete"},"valorSeguro":{"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"type":"integer","description":"Voltagem"},"localEmbarque":{"type":"string","description":"Local de Embarque"},"localDescarga":{"type":"string","description":"Local de Descarga"},"incoterm":{"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/orcamento":{"get":{"tags":["Televendas - Orçamento"],"summary":"Obter Listagem de Orçamentos","operationId":"ObterOrcamentos","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"dataEmissaoInicio","in":"query","description":"Data Inicial da Emissão do Orçamento (YYYY-MM-DD)","schema":{"type":"string"}},{"name":"dataEmissaoFim","in":"query","description":"Data Final da Emissão do Orçamento (YYYY-MM-DD)","schema":{"type":"string"}},{"name":"representantes","in":"query","description":"Lista de Código de Representante","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"atendentes","in":"query","description":"Lista de Código de Atendente","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"situacao","in":"query","description":"Situação do Orçamento (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado)","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"campoFiltroDinamico","in":"query","description":"Campo para Filtrar Dinamicamente no SQL","schema":{"type":"string"}},{"name":"valorFiltroDinamico","in":"query","description":"Valor para Filtrar Dinamicamente no SQL","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaOrcamento"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /orcamento > Cadastrar um orçamento ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Orçamento","description":"orcamento"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"OrcamentoPut":{"required":["codRepresentante","codTipodeNota","unidadeMonetaria"],"type":"object","properties":{"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"maxLength":3000,"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"maxLength":1000,"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Desconto do Orçamento"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento/Pedido"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (1 - Em percentual, 2 - Em valor)","enum":[1,2]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"multipleOf":0.01,"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"multipleOf":0.01,"type":"number","description":"Valor Antecipado"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"multipleOf":0.01,"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"maximum":99999,"type":"integer","description":"Voltagem"},"localEmbarque":{"maxLength":50,"type":"string","description":"Local de Embarque"},"localDescarga":{"maxLength":50,"type":"string","description":"Local de Descarga"},"incoterm":{"maxLength":50,"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"maxLength":5000,"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente (0 - Não, 1 - Sim)"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio (0 - Não, 1 - Sim)"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"maxLength":8,"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"maxLength":30,"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"maxLength":20,"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Código da Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Orcamento":{"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"dataUnidadeMonetaria":{"type":"string","description":"Data da Moeda"},"valorUnidadeMonetaria":{"type":"number","description":"Valor da Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"type":"number","description":"Desconto do Orçamento"},"desconto2":{"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Em percentual, 1 - Em valor)","enum":[0,1]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"type":"number","description":"Valor Antecipado"},"valorDesconto":{"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"type":"number","description":"Valor do Frete"},"valorSeguro":{"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"type":"integer","description":"Voltagem"},"localEmbarque":{"type":"string","description":"Local de Embarque"},"localDescarga":{"type":"string","description":"Local de Descarga"},"incoterm":{"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/orcamento":{"put":{"tags":["Televendas - Orçamento"],"summary":"Cadastrar um orçamento","operationId":"CadastrarOrcamento","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Orçamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrcamentoPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orcamento"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /orcamento/{id} > Obter um Orçamento ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Orçamento","description":"orcamento"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Orcamento":{"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"dataUnidadeMonetaria":{"type":"string","description":"Data da Moeda"},"valorUnidadeMonetaria":{"type":"number","description":"Valor da Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"type":"number","description":"Desconto do Orçamento"},"desconto2":{"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Em percentual, 1 - Em valor)","enum":[0,1]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"type":"number","description":"Valor Antecipado"},"valorDesconto":{"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"type":"number","description":"Valor do Frete"},"valorSeguro":{"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"type":"integer","description":"Voltagem"},"localEmbarque":{"type":"string","description":"Local de Embarque"},"localDescarga":{"type":"string","description":"Local de Descarga"},"incoterm":{"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/orcamento/{id}":{"get":{"tags":["Televendas - Orçamento"],"summary":"Obter um Orçamento","operationId":"ObterOrcamento","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Orçamento","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orcamento"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /orcamento/{id} > Atualizar um orçamento ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Orçamento","description":"orcamento"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"OrcamentoPut":{"required":["codRepresentante","codTipodeNota","unidadeMonetaria"],"type":"object","properties":{"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"maxLength":3000,"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"maxLength":1000,"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Desconto do Orçamento"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento/Pedido"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (1 - Em percentual, 2 - Em valor)","enum":[1,2]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"multipleOf":0.01,"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"multipleOf":0.01,"type":"number","description":"Valor Antecipado"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"multipleOf":0.01,"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"maximum":99999,"type":"integer","description":"Voltagem"},"localEmbarque":{"maxLength":50,"type":"string","description":"Local de Embarque"},"localDescarga":{"maxLength":50,"type":"string","description":"Local de Descarga"},"incoterm":{"maxLength":50,"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"maxLength":5000,"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente (0 - Não, 1 - Sim)"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio (0 - Não, 1 - Sim)"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"maxLength":8,"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"maxLength":30,"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"maxLength":20,"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Código da Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Orcamento":{"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"dataUnidadeMonetaria":{"type":"string","description":"Data da Moeda"},"valorUnidadeMonetaria":{"type":"number","description":"Valor da Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"type":"number","description":"Desconto do Orçamento"},"desconto2":{"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Em percentual, 1 - Em valor)","enum":[0,1]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"type":"number","description":"Valor Antecipado"},"valorDesconto":{"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"type":"number","description":"Valor do Frete"},"valorSeguro":{"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"type":"integer","description":"Voltagem"},"localEmbarque":{"type":"string","description":"Local de Embarque"},"localDescarga":{"type":"string","description":"Local de Descarga"},"incoterm":{"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/orcamento/{id}":{"put":{"tags":["Televendas - Orçamento"],"summary":"Atualizar um orçamento","operationId":"AtualizarOrcamento","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Orçamento","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Orçamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrcamentoPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orcamento"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /orcamento/{id} > Excluir um Orçamento ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Orçamento","description":"orcamento"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/orcamento/{id}":{"delete":{"tags":["Televendas - Orçamento"],"summary":"Excluir um Orçamento","operationId":"ExcluirOrcamento","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Orçamento","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /orcamento/{id}/cancelar > Cancelar um Orçamento ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Orçamento","description":"orcamento"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"DadosCancelamentoOrcamento":{"required":["codMotivoNaoVenda"],"type":"object","properties":{"codMotivoNaoVenda":{"type":"integer","description":"Código do Motivo de não Venda"}}},"Orcamento":{"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"dataUnidadeMonetaria":{"type":"string","description":"Data da Moeda"},"valorUnidadeMonetaria":{"type":"number","description":"Valor da Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"type":"number","description":"Desconto do Orçamento"},"desconto2":{"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Em percentual, 1 - Em valor)","enum":[0,1]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"type":"number","description":"Valor Antecipado"},"valorDesconto":{"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"type":"number","description":"Valor do Frete"},"valorSeguro":{"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"type":"integer","description":"Voltagem"},"localEmbarque":{"type":"string","description":"Local de Embarque"},"localDescarga":{"type":"string","description":"Local de Descarga"},"incoterm":{"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/orcamento/{id}/cancelar":{"post":{"tags":["Televendas - Orçamento"],"summary":"Cancelar um Orçamento","operationId":"CancelarOrcamento","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"código do Orçamento","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para cancelamento do Orçamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DadosCancelamentoOrcamento"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orcamento"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /orcamento/{id}/gerarpedido > Gerar Pedido de Venda de um Orçamento ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Orçamento","description":"orcamento"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Orcamento":{"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"dataUnidadeMonetaria":{"type":"string","description":"Data da Moeda"},"valorUnidadeMonetaria":{"type":"number","description":"Valor da Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"type":"number","description":"Desconto do Orçamento"},"desconto2":{"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Em percentual, 1 - Em valor)","enum":[0,1]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"type":"number","description":"Valor Antecipado"},"valorDesconto":{"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"type":"number","description":"Valor do Frete"},"valorSeguro":{"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"type":"integer","description":"Voltagem"},"localEmbarque":{"type":"string","description":"Local de Embarque"},"localDescarga":{"type":"string","description":"Local de Descarga"},"incoterm":{"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/orcamento/{id}/gerarpedido":{"post":{"tags":["Televendas - Orçamento"],"summary":"Gerar Pedido de Venda de um Orçamento","operationId":"GerarPedidoVendaOrcamento","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Orçamento","required":true,"schema":{"type":"string"}},{"name":"codUsuario","in":"query","description":"Código do Usuário no ERP-Consistem","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orcamento"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /icmsOrcamento > Obter o ICMS para Orçamento ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Orçamento","description":"orcamento"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"IcmsOrcamento":{"type":"object","properties":{"percentualIcms":{"type":"number","description":"Percentual do ICMS do Orçamento"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/icmsOrcamento":{"get":{"tags":["Televendas - Orçamento"],"summary":"Obter o ICMS para Orçamento","operationId":"ObterIcmsOrcamento","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"produto","in":"query","description":"Código do Produto","required":true,"schema":{"type":"string"}},{"name":"cliente","in":"query","description":"Código do Cliente","required":true,"schema":{"type":"string"}},{"name":"tipoNota","in":"query","description":"Código do Tipo de Nota","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcmsOrcamento"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /impostosProduto > Calcular Impostos de Produtos ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"tags":[{"name":"Televendas - Orçamento","description":"orcamento"}],"servers":[{"url":"https://localhost/crm/v10"},{"url":"http://localhost/crm/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"DadosImpostos":{"required":["codCliente","codTipoNota","consumoProprio"],"type":"object","properties":{"codTipoNota":{"type":"string","description":"Código do Tipo de Nota"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio? ( 0 - Não / 1 - Sim)"},"codCliente":{"type":"string","description":"Código do Cliente"},"cepEntrega":{"type":"string","description":"Código do CEP do Endereço de Entrega (99999-999) * Se for consumidor final Será aplicada a alíquota de ICMS do Endereço de Entrega caso este seja diferente do Cadastro de Clientes."},"CPFCNPJ":{"type":"string","description":"CPF / CNPJ do cliente * Informar caso cliente não esteja cadastrado"},"inscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Cliente * Informar caso cliente não esteja cadastrado"},"codRamo":{"type":"string","description":"Código do Ramo de Atividade do Cliente * Informar caso cliente não esteja cadastrado"},"consFinal":{"type":"boolean","description":"Consumidor final (0- Não / 1 - Sim) * Informar caso cliente não esteja cadastrado"},"simplesNacional":{"type":"boolean","description":"Simples Nacional (0- Não / 1 - Sim) * Informar caso cliente não esteja cadastrado"},"numeroSuframa":{"type":"string","description":"Número Inscrição Suframa * Informar caso cliente não esteja cadastrado"},"itensDadosImpostos":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItensDadosImpostos"}}}},"ItensDadosImpostos":{"required":["codProduto","qtdPedida","valorAcrescimo","valorDesconto","valorTotalBrutoProduto"],"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"multipleOf":0.001,"type":"number","description":"Quantidade Pedida"},"valorTotalBrutoProduto":{"multipleOf":0.01,"type":"number","description":"Valor Total Bruto do Produto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto Aplicado no Produto"},"valorAcrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo Aplicado no Produto"}}},"DadosImpostosResult":{"type":"object","properties":{"codTipoNota":{"type":"string","description":"Código do Pedido de Venda"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio? ( 0 - Não / 1 - Sim)"},"codCliente":{"type":"string","description":"Código do Cliente"},"cepEntrega":{"type":"string","description":"Código do CEP do Endereço de Entrega (99999-999)"},"itensDadosImpostos":{"type":"array","description":"Dados de Impostos dos Itens","items":{"$ref":"#/components/schemas/ItensDadosImpostosResult"}}}},"ItensDadosImpostosResult":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do produto"},"valorTotalBrutoProduto":{"multipleOf":0.01,"type":"number","description":"Valor total do Item bruto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor acrescimo"},"valorAcrescimo":{"multipleOf":0.01,"type":"number","description":"Valor acrescimo"},"aliquotaIpi":{"type":"number","description":"Aliquota ipi"},"quantidadeProduto":{"type":"number","description":"Quantidade"},"percRedBaseIcms":{"multipleOf":0.01,"type":"number","description":"Percentual Reducao Base ICMS"},"percIcms":{"multipleOf":0.01,"type":"number","description":"Percentual ICMS"},"baseIpi":{"multipleOf":0.01,"type":"number","description":"Base do ipi"},"valorIpi":{"multipleOf":0.01,"type":"number","description":"valor ipi"},"ipiDespAcessorias":{"multipleOf":0.01,"type":"number","description":"Ipi sobre despesas acessórias"},"baseIcms":{"multipleOf":0.01,"type":"number","description":"Base icms"},"aliquotaIcms":{"multipleOf":0.01,"type":"number","description":"Aliquota icms"},"valorIcms":{"multipleOf":0.01,"type":"number","description":"Valor icms"},"percRedIcms":{"multipleOf":0.01,"type":"number","description":"Percentual de redução icms"},"baseCalcIcmsSt":{"multipleOf":0.01,"type":"number","description":"Base de cálculo icms-st"},"aliqInternaIcmsSt":{"multipleOf":0.01,"type":"number","description":"Aliquota interna icms-st"},"valorIcmsSt":{"multipleOf":0.01,"type":"number","description":"valor icms-st"},"percMva":{"multipleOf":0.01,"type":"number","description":"Percentual MVA"},"percReducao":{"multipleOf":0.01,"type":"number","description":"Percentual de redução"},"descontoIcmsZF":{"multipleOf":0.01,"type":"number","description":"Desconto Icms zona franca"},"descontoPisZF":{"multipleOf":0.01,"type":"number","description":"Desconto Pis zona franca"},"descontoCofinsZF":{"multipleOf":0.01,"type":"number","description":"Desconto Cofins zona franca"},"origemIcmsDiferenciado":{"type":"string","description":"Origem do Icms Diferenciado"},"cfop":{"type":"string","description":"CFOP"},"basePis":{"multipleOf":0.01,"type":"number","description":"Base PIS"},"aliquotaPis":{"multipleOf":0.01,"type":"number","description":"Alíquota PIS"},"valorPis":{"multipleOf":0.01,"type":"number","description":"Valor PIS"},"baseConfins":{"multipleOf":0.01,"type":"number","description":"Base COFINS"},"aliqCofins":{"multipleOf":0.01,"type":"number","description":"Alíquota COFINS"},"valorCofins":{"multipleOf":0.01,"type":"number","description":"Valor COFINS"},"CSOSN":{"type":"string","description":"CSOSN"},"finalidade":{"type":"string","description":"Finalidade"},"fcpIcmsNormal":{"multipleOf":0.01,"type":"number","description":"Percentual FCP ICMS Normal"},"valorFcpIcmsNormal":{"multipleOf":0.01,"type":"number","description":"Valor FCP ICMS Normal"},"icmsBaseDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Base UF Destino - DIFAL"},"icmsAliqDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Alíquota FCP - DIFAL"},"icmsAliqInternaDestinoDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Alíquota Interna UF Destino - DIFAL"},"icmsAliqInterestadual":{"multipleOf":0.01,"type":"number","description":"ICMS Alíquota Interestadual - DIFAL"},"percProvPartIcmsInterestDifal":{"multipleOf":0.01,"type":"number","description":"Perc.Prov.Part. ICMS Interestadual - DIFAL"},"icmsValorDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Valor FCP - DIFAL"},"icmsValorUfDestinoDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Valor UF Destino - DIFAL"},"icmsValorUfRemetenteDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Valor UF Remetente - DIFAL"},"percRedIcmsDifal":{"type":"number","description":"Redução BC ICMS DIFAL % - DIFAL"},"valorIcmsIsento":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Isento"},"stDestacado":{"multipleOf":0.01,"type":"number","description":"ST Não Destacado"},"fcpNaoDestacado":{"multipleOf":0.01,"type":"number","description":"FCP Não Destacado"},"cstIcms":{"type":"string","description":"CST ICMS"},"cstPis":{"type":"string","description":"CST PIS"},"cstCofins":{"type":"string","description":"CST COFINS"},"tipoContribPis":{"type":"string","description":"Tipo Contribuição PIS"},"tipoContribCofins":{"type":"string","description":"Tipo Contribuição Cofins"},"codEnquadIpi":{"type":"string","description":"Código Enquadramento do IPI"},"CEST":{"type":"string","description":"CEST"},"codBenifFiscalIcms":{"multipleOf":0.01,"type":"number","description":"Código Benefício Fiscal ICMS"},"valorIpiIsento":{"multipleOf":0.01,"type":"number","description":"Valor IPI Isento"},"valorIcmsOutras":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Outras"},"valorIcmsDiferido":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Diferido"},"valorIcmsDesonerado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Desonerado"},"percDiferimentoParcial":{"multipleOf":0.01,"type":"number","description":"Percentual Diferimento Parcial"},"percIcmsDiferido":{"multipleOf":0.01,"type":"number","description":"Percentual ICMS que foi Diferido"},"valorTribConsFinal":{"multipleOf":0.01,"type":"number","description":"Valor do Tributo do Consumidor Final"},"percTribConsFinal":{"multipleOf":0.01,"type":"number","description":"Percentual do Tributo do Consumidor Final"},"valorTribFederal":{"multipleOf":0.01,"type":"number","description":"Valor do Tributo Federal"},"valorTribEstadual":{"multipleOf":0.01,"type":"number","description":"Valor do Tributo Estadual"},"valorIpiOutras":{"multipleOf":0.01,"type":"number","description":"Valor IPI Outras"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/impostosProduto":{"post":{"tags":["Televendas - Orçamento"],"summary":"Calcular Impostos de Produtos","operationId":"ObterImpostosProduto","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados para Valor dos Impostos do(s) Produto(s)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DadosImpostos"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DadosImpostosResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The Contato object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"Contato":{"type":"object","properties":{"empresa":{"type":"integer","description":"Código da Empresa"},"codContato":{"type":"integer","description":"Código do Contato"},"atendente":{"type":"integer","description":"Código do Atendente"},"cnpj":{"type":"string","description":"Código do CNPJ"},"cidade":{"type":"string","description":"Código da Cidade"},"cliente":{"type":"integer","description":"Código do Cliente"},"consignatario":{"type":"integer","description":"Código do Consignatário"},"transportadora":{"type":"integer","description":"Código da Transportadora"},"formaContato":{"type":"integer","description":"Código da Forma de Contato"},"ocupacaoPesFisica":{"type":"integer","description":"Código da Ocupação para Pessoa Física"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade"},"subRamoAtividade":{"type":"string","description":"Código do Sub-Ramo de Atividade"},"representante":{"type":"integer","description":"Código do Representante"},"setorVenda":{"type":"string","description":"Código do Setor de Venda"},"nivelServico":{"type":"string","description":"Nível de Serviço"},"orcamentoContato":{"type":"string","description":"Contato Orçamento"},"codLead":{"type":"integer","description":"Código do Lead"},"bairro":{"type":"string","description":"Bairro"},"cepCompleto":{"type":"string","description":"CEP Completo"},"codEstruturaComl":{"type":"string","description":"Código da Estrutura Comercial"},"consumidorFinal":{"type":"integer","description":"É Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"contatoPadrao":{"type":"string","description":"Contato Padrão"},"cxPostal":{"type":"string","description":"Caixa Postal"},"dataCadastro":{"type":"string","description":"Data do Cadastro (YYYY-MM-DD)","format":"date"},"email":{"type":"string","description":"E-mail Principal do Contato"},"emailNfe":{"type":"string","description":"E-mail para NF-e"},"emailSecundarioNfe":{"type":"string","description":"E-mail Secundário do Contato"},"endComplementar":{"type":"string","description":"Endereço Complementar"},"endereco":{"type":"string","description":"Endereço Padrão"},"enderecoNumero":{"type":"string","description":"Número do Endereço"},"fantasia":{"type":"string","description":"Nome Fantasia"},"fax":{"type":"string","description":"Número de Fax"},"frequenciaContato":{"type":"integer","description":"Número de Dias em que Deve-se Entrar em Contato com o Cliente"},"frequenciaNF":{"type":"integer","description":"Frequência da Nota Fiscal"},"homepage":{"type":"string","description":"Home Page do Contato"},"inscricaoEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"uf":{"type":"string","description":"Código do Estado"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","description":"País do Contato"},"proximidade":{"type":"string","description":"Proximidade"},"razaoSocial":{"type":"string","description":"Razão Social"},"rzSocCobEscritural":{"type":"string","description":"Razão Social - Cobrança Escritural"},"situacao":{"type":"integer","description":"Situação (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"type":"string","description":"Número de Telefone"},"tipo":{"type":"integer","description":"Tipo do Contato (1-Prospect, 2-Cliente)","enum":[1,2]},"recMalaDireta":{"type":"integer","description":"Recebe Mala Direta? (0-Não, 1-Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Contaot é Simples Nacional? (0-Não, 1-Sim)","enum":[0,1]},"irpjLucroPresumido":{"type":"integer","description":"IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)","enum":[0,1]},"dataAssociacao":{"type":"string","description":"Data da Associação (YYYY-MM-DD)","format":"date"},"tipoReferencia":{"type":"integer","description":"Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)","enum":[1,2,3,4,5]},"enderecoEntrega":{"type":"array","description":"Endereços de Entrega","items":{"$ref":"#/components/schemas/ContatoEnderecoEntrega"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ContatoEnderecoEntrega":{"required":["bairro","cep","endereco","numero","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço"},"localEntrega":{"maxLength":35,"type":"string","description":"Local de Entrega"},"endereco":{"maxLength":40,"minLength":1,"type":"string","description":"Endereço"},"numero":{"maxLength":4,"minLength":1,"type":"string","description":"Número do Endereço"},"complemento":{"maxLength":60,"type":"string","description":"Complemento"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP"},"cpfCnpj":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ"},"inscEstadual":{"maxLength":18,"type":"string","description":"Código da Inscrição Estadual"},"telefone":{"maxLength":20,"type":"string","description":"Número do Telefone"},"horario":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaContato object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"ListaContato":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Contato"}}}},"Contato":{"type":"object","properties":{"empresa":{"type":"integer","description":"Código da Empresa"},"codContato":{"type":"integer","description":"Código do Contato"},"atendente":{"type":"integer","description":"Código do Atendente"},"cnpj":{"type":"string","description":"Código do CNPJ"},"cidade":{"type":"string","description":"Código da Cidade"},"cliente":{"type":"integer","description":"Código do Cliente"},"consignatario":{"type":"integer","description":"Código do Consignatário"},"transportadora":{"type":"integer","description":"Código da Transportadora"},"formaContato":{"type":"integer","description":"Código da Forma de Contato"},"ocupacaoPesFisica":{"type":"integer","description":"Código da Ocupação para Pessoa Física"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade"},"subRamoAtividade":{"type":"string","description":"Código do Sub-Ramo de Atividade"},"representante":{"type":"integer","description":"Código do Representante"},"setorVenda":{"type":"string","description":"Código do Setor de Venda"},"nivelServico":{"type":"string","description":"Nível de Serviço"},"orcamentoContato":{"type":"string","description":"Contato Orçamento"},"codLead":{"type":"integer","description":"Código do Lead"},"bairro":{"type":"string","description":"Bairro"},"cepCompleto":{"type":"string","description":"CEP Completo"},"codEstruturaComl":{"type":"string","description":"Código da Estrutura Comercial"},"consumidorFinal":{"type":"integer","description":"É Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"contatoPadrao":{"type":"string","description":"Contato Padrão"},"cxPostal":{"type":"string","description":"Caixa Postal"},"dataCadastro":{"type":"string","description":"Data do Cadastro (YYYY-MM-DD)","format":"date"},"email":{"type":"string","description":"E-mail Principal do Contato"},"emailNfe":{"type":"string","description":"E-mail para NF-e"},"emailSecundarioNfe":{"type":"string","description":"E-mail Secundário do Contato"},"endComplementar":{"type":"string","description":"Endereço Complementar"},"endereco":{"type":"string","description":"Endereço Padrão"},"enderecoNumero":{"type":"string","description":"Número do Endereço"},"fantasia":{"type":"string","description":"Nome Fantasia"},"fax":{"type":"string","description":"Número de Fax"},"frequenciaContato":{"type":"integer","description":"Número de Dias em que Deve-se Entrar em Contato com o Cliente"},"frequenciaNF":{"type":"integer","description":"Frequência da Nota Fiscal"},"homepage":{"type":"string","description":"Home Page do Contato"},"inscricaoEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"uf":{"type":"string","description":"Código do Estado"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","description":"País do Contato"},"proximidade":{"type":"string","description":"Proximidade"},"razaoSocial":{"type":"string","description":"Razão Social"},"rzSocCobEscritural":{"type":"string","description":"Razão Social - Cobrança Escritural"},"situacao":{"type":"integer","description":"Situação (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"type":"string","description":"Número de Telefone"},"tipo":{"type":"integer","description":"Tipo do Contato (1-Prospect, 2-Cliente)","enum":[1,2]},"recMalaDireta":{"type":"integer","description":"Recebe Mala Direta? (0-Não, 1-Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Contaot é Simples Nacional? (0-Não, 1-Sim)","enum":[0,1]},"irpjLucroPresumido":{"type":"integer","description":"IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)","enum":[0,1]},"dataAssociacao":{"type":"string","description":"Data da Associação (YYYY-MM-DD)","format":"date"},"tipoReferencia":{"type":"integer","description":"Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)","enum":[1,2,3,4,5]},"enderecoEntrega":{"type":"array","description":"Endereços de Entrega","items":{"$ref":"#/components/schemas/ContatoEnderecoEntrega"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ContatoEnderecoEntrega":{"required":["bairro","cep","endereco","numero","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço"},"localEntrega":{"maxLength":35,"type":"string","description":"Local de Entrega"},"endereco":{"maxLength":40,"minLength":1,"type":"string","description":"Endereço"},"numero":{"maxLength":4,"minLength":1,"type":"string","description":"Número do Endereço"},"complemento":{"maxLength":60,"type":"string","description":"Complemento"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP"},"cpfCnpj":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ"},"inscEstadual":{"maxLength":18,"type":"string","description":"Código da Inscrição Estadual"},"telefone":{"maxLength":20,"type":"string","description":"Número do Telefone"},"horario":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ContatoPut object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"ContatoPut":{"required":["atendente","bairro","cepCompleto","consumidorFinal","endereco","enderecoNumero","frequenciaContato","frequenciaNF","irpjLucroPresumido","razaoSocial","recMalaDireta","representante","simplesNacional","situacao","telefone","tipo"],"type":"object","properties":{"atendente":{"maximum":9999,"minimum":1,"type":"integer","description":"Código do Atendente"},"cnpj":{"maxLength":14,"type":"string","description":"Código do CNPJ"},"cidade":{"maxLength":60,"type":"string","description":"Código da Cidade"},"cliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"consignatario":{"maximum":9999,"type":"integer","description":"Código do Consignatário"},"transportadora":{"maximum":9999,"type":"integer","description":"Código da Transportadora"},"formaContato":{"maximum":999,"type":"integer","description":"Código da Forma de Contato"},"ocupacaoPesFisica":{"maximum":999,"type":"integer","description":"Código da Ocupação para Pessoa Física"},"ramoAtividade":{"maximum":99,"type":"integer","description":"Código do Ramo de Atividade"},"subRamoAtividade":{"maxLength":3,"type":"string","description":"Código do Sub-Ramo de Atividade"},"representante":{"maximum":9999,"minimum":1,"type":"integer","description":"Código do Representante"},"setorVenda":{"maxLength":3,"type":"string","description":"Código do Setor de Venda"},"nivelServico":{"maxLength":4,"type":"string","description":"Nível de Serviço"},"codLead":{"maximum":9999,"type":"integer","description":"Código do Lead"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cepCompleto":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP Completo"},"codEstruturaComl":{"maxLength":50,"type":"string","description":"Código da Estrutura Comercial"},"consumidorFinal":{"type":"integer","description":"É Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"contatoPadrao":{"maxLength":50,"type":"string","description":"Contato Padrão"},"cxPostal":{"maxLength":10,"type":"string","description":"Caixa Postal"},"dataCadastro":{"type":"string","description":"Data do Cadastro (YYYY-MM-DD)","format":"date"},"email":{"maxLength":50,"type":"string","description":"E-mail Principal do Contato"},"emailNfe":{"maxLength":50,"type":"string","description":"E-mail para NF-e"},"emailSecundarioNfe":{"maxLength":999,"type":"string","description":"E-mail Secundário do Contato"},"endComplementar":{"maxLength":30,"type":"string","description":"Endereço Complementar"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço Padrão"},"enderecoNumero":{"maxLength":10,"minLength":1,"type":"string","description":"Número do Endereço"},"fantasia":{"maxLength":30,"type":"string","description":"Nome Fantasia"},"fax":{"maxLength":15,"type":"string","description":"Número de Fax"},"frequenciaContato":{"maximum":999,"minimum":1,"type":"integer","description":"Número de Dias em que Deve-se Entrar em Contato com o Cliente"},"frequenciaNF":{"maximum":9999,"minimum":1,"type":"integer","description":"Frequência da Nota Fiscal"},"homepage":{"maxLength":100,"type":"string","description":"Home Page do Contato"},"inscricaoEstadual":{"maxLength":15,"type":"string","description":"Código da Inscrição Estadual"},"uf":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"},"observacao":{"maxLength":50,"type":"string","description":"Observação"},"pais":{"maxLength":50,"type":"string","description":"País do Contato"},"proximidade":{"maxLength":25,"type":"string","description":"Proximidade"},"razaoSocial":{"maxLength":60,"minLength":1,"type":"string","description":"Razão Social"},"rzSocCobEscritural":{"maxLength":40,"type":"string","description":"Razão Social - Cobrança Escritural"},"situacao":{"type":"integer","description":"Situação (0-Inativo, 1-Ativo)","enum":[0,1]},"telefone":{"maxLength":15,"minLength":1,"type":"string","description":"Número de Telefone"},"tipo":{"type":"integer","description":"Tipo do Contato (1-Prospect, 2-Cliente)","enum":[1,2]},"recMalaDireta":{"type":"integer","description":"Recebe Mala Direta? (0-Não, 1-Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Contaot é Simples Nacional? (0-Não, 1-Sim)","enum":[0,1]},"irpjLucroPresumido":{"type":"integer","description":"IRPJ Lucro Presumido (Inclusão para PJ200) (0-Não, 1-Sim)","enum":[0,1]},"dataAssociacao":{"type":"string","description":"Data da Associação (YYYY-MM-DD)","format":"date"},"tipoReferencia":{"type":"integer","description":"Tipo de Refêrencia (1-Refêrencias por Produto, 2-Refêrencias Produto/Cor, 3-Refêrencias Produto/Cor/Tamanho, 4-Refêrencias Produto/Tamanhos, 5-Sem Refêrencia Cliente)","enum":[1,2,3,4,5]},"enderecoEntrega":{"type":"array","description":"Endereços de Entrega","items":{"$ref":"#/components/schemas/ContatoEnderecoEntrega"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ContatoEnderecoEntrega":{"required":["bairro","cep","endereco","numero","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço"},"localEntrega":{"maxLength":35,"type":"string","description":"Local de Entrega"},"endereco":{"maxLength":40,"minLength":1,"type":"string","description":"Endereço"},"numero":{"maxLength":4,"minLength":1,"type":"string","description":"Número do Endereço"},"complemento":{"maxLength":60,"type":"string","description":"Complemento"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP"},"cpfCnpj":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ"},"inscEstadual":{"maxLength":18,"type":"string","description":"Código da Inscrição Estadual"},"telefone":{"maxLength":20,"type":"string","description":"Número do Telefone"},"horario":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ContatoEnderecoEntrega object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"ContatoEnderecoEntrega":{"required":["bairro","cep","endereco","numero","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço"},"localEntrega":{"maxLength":35,"type":"string","description":"Local de Entrega"},"endereco":{"maxLength":40,"minLength":1,"type":"string","description":"Endereço"},"numero":{"maxLength":4,"minLength":1,"type":"string","description":"Número do Endereço"},"complemento":{"maxLength":60,"type":"string","description":"Complemento"},"bairro":{"maxLength":30,"minLength":1,"type":"string","description":"Bairro"},"cep":{"maxLength":8,"minLength":1,"type":"string","description":"Código do CEP"},"cpfCnpj":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ"},"inscEstadual":{"maxLength":18,"type":"string","description":"Código da Inscrição Estadual"},"telefone":{"maxLength":20,"type":"string","description":"Número do Telefone"},"horario":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Código do Estado"}}}}}} ``` ## The Orcamento object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"Orcamento":{"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"dataUnidadeMonetaria":{"type":"string","description":"Data da Moeda"},"valorUnidadeMonetaria":{"type":"number","description":"Valor da Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"type":"number","description":"Desconto do Orçamento"},"desconto2":{"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Em percentual, 1 - Em valor)","enum":[0,1]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"type":"number","description":"Valor Antecipado"},"valorDesconto":{"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"type":"number","description":"Valor do Frete"},"valorSeguro":{"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"type":"integer","description":"Voltagem"},"localEmbarque":{"type":"string","description":"Local de Embarque"},"localDescarga":{"type":"string","description":"Local de Descarga"},"incoterm":{"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The itemOrcamento object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The OrcamentoPut object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"OrcamentoPut":{"required":["codRepresentante","codTipodeNota","unidadeMonetaria"],"type":"object","properties":{"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"maxLength":3000,"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"maxLength":1000,"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Desconto do Orçamento"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento/Pedido"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (1 - Em percentual, 2 - Em valor)","enum":[1,2]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"multipleOf":0.01,"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"multipleOf":0.01,"type":"number","description":"Valor Antecipado"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"multipleOf":0.01,"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"maximum":99999,"type":"integer","description":"Voltagem"},"localEmbarque":{"maxLength":50,"type":"string","description":"Local de Embarque"},"localDescarga":{"maxLength":50,"type":"string","description":"Local de Descarga"},"incoterm":{"maxLength":50,"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"maxLength":5000,"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente (0 - Não, 1 - Sim)"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio (0 - Não, 1 - Sim)"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"maxLength":8,"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"maxLength":35,"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"maxLength":30,"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"maxLength":20,"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Código da Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}}} ``` ## The ListaOrcamento object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"ListaOrcamento":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Orcamento"}}}},"Orcamento":{"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"codAtendente":{"type":"integer","description":"Código do Atendente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"codCondicaoPagamento":{"type":"integer","description":"Primeira Condição de Pagamento"},"codCondicaoPagamento1":{"type":"integer","description":"Segunda Condição de Pagamento"},"codCondicaoPagamento2":{"type":"integer","description":"Terceira Condição de Pagamento"},"codCondicaoPagamento3":{"type":"integer","description":"Quarta Condição de Pagamento"},"codCondicaoPagamento4":{"type":"integer","description":"Quinta Condição de Pagamento"},"condicaoGeralVenda":{"type":"string","description":"Condições Gerais de Venda - Apenas para Impressão do Orçamento"},"condicaoGeralVendaPre":{"type":"string","description":"Condições Gerais de Venda Texto Antes do Itens - Apenas para Impressão do Orçamento"},"codConsignatario":{"type":"integer","description":"Código da Trasportadora Consignatária"},"codContato":{"type":"integer","description":"Código do Contato"},"unidadeMonetaria":{"type":"integer","description":"Unidade Monetária"},"dataUnidadeMonetaria":{"type":"string","description":"Data da Moeda"},"valorUnidadeMonetaria":{"type":"number","description":"Valor da Unidade Monetária"},"teleAtendimento":{"type":"integer","description":"Teleatendimento"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codPessoaContato":{"type":"integer","description":"Código da Pessoa de Contato"},"codPortador":{"type":"integer","description":"Código do Portador"},"codProcedencia":{"type":"integer","description":"Código da Procedência"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codTabelaPrecoDefault":{"type":"integer","description":"Código da Tabela de Preço Padrão"},"codTabelaPrecoMalharia":{"type":"integer","description":"Código da Tabela de Preço para Malharias"},"codTipoCobranca":{"type":"integer","description":"Código do Tipo de Cobrança"},"codTipoFrete":{"type":"integer","description":"Código do Tipo de Frete"},"codTipoFreteConsignatario":{"type":"integer","description":"Código do Tipo de Frete da Transportador Consignatária"},"codTipodeNota":{"type":"integer","description":"Código do Tipo de Nota Fiscal"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"arquivoAnexo":{"type":"string","description":"Nome do Arquivo Anexo"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"dataValidadeOrcamento":{"type":"string","description":"Data de Validade do Orçamento (YYYY-MM-DD)","format":"date"},"desconto1":{"type":"number","description":"Desconto do Orçamento"},"desconto2":{"type":"number","description":"Segundo Desconto do Orçamento"},"desconto3":{"type":"number","description":"Terceiro Desconto do Orçamento"},"desconto4":{"type":"number","description":"Quarto Desconto do Orçamento"},"desconto5":{"type":"number","description":"Quinto Desconto do Orçamento"},"desconto6":{"type":"number","description":"Sexto Desconto do Orçamento"},"codPedido":{"type":"string","description":"Código do Pedido"},"observacaoNF":{"maxLength":1000,"type":"string","description":"Observação para ser Impressa na Nota Fiscal"},"observacaoOrcamento":{"maxLength":250,"type":"string","description":"Observação do Orçamento"},"pedidoCliente":{"type":"string","description":"Descrição do Pedido do Cliente"},"percAcrescimo1":{"type":"number","description":"Percentual de Acréscimo"},"percAcrescimo2":{"type":"number","description":"Segundo Percentual de Acréscimo"},"percAcrescimo3":{"type":"number","description":"Terceiro Percentual de Acréscimo"},"percAcrescimo4":{"type":"number","description":"Quarto Percentual de Acréscimo"},"percComissao":{"type":"number","description":"Percentual de Comissão"},"percComissaoAtendente":{"type":"number","description":"Percentual de Comissão do Atendente"},"prazoFaturamento":{"type":"integer","description":"Prazo em Dias do Faturamento"},"previsaoFaturamento":{"type":"string","description":"Data de Previsão do Faturamento (YYYY-MM-DD)","format":"date"},"situacao":{"type":"integer","description":"Situação (0 - Aberto, 1 - Aprovado, 2 - Não Aprovado, 3 - Revisão Cancelada)","enum":[0,1,2,3]},"supervisorAtendente":{"type":"integer","description":"Supervidor do Atendente"},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Em percentual, 1 - Em valor)","enum":[0,1]},"tipoOrcamento":{"type":"integer","description":"Tipo do Orçamento (0 - Normal, 1 - Tirantes, 2 - Trefilados, 3 - Aços)","enum":[0,1,2,3]},"totalOrcamentoAntes":{"type":"number","description":"Valor Total Bruto - Sem Desconto / Acréscimo"},"validadeOrcamento":{"type":"integer","description":"Dias de Validade do Orçamento"},"valorAcrescimo":{"type":"number","description":"Valor Total de Acréscimo"},"valorAntecipado":{"type":"number","description":"Valor Antecipado"},"valorDesconto":{"type":"number","description":"Valor Total de Desconto"},"valorFrete":{"type":"number","description":"Valor do Frete"},"valorSeguro":{"type":"number","description":"Valor do Seguro (Destacado)"},"valorOutrasDespesas":{"type":"number","description":"Valor de Outras Despesas (Destacado)"},"voltagem":{"type":"integer","description":"Voltagem"},"localEmbarque":{"type":"string","description":"Local de Embarque"},"localDescarga":{"type":"string","description":"Local de Descarga"},"incoterm":{"type":"string","description":"Incoterm"},"palavraChave":{"type":"string","description":"Palavra Chave"},"envioMsgBaixa":{"type":"boolean","description":"Verifica envio de mensagem automática de baixa"},"dataBaixaAutomatica":{"type":"string","description":"Data da Baixa Automática (YYYY-MM-DD)","format":"date"},"numCartaoBNDES":{"type":"integer","description":"Número do Cartão BNDES"},"dataValidadeBNDES":{"type":"string","description":"Data da Baixa Automática (MM/YYYY)"},"bancoBNDES":{"type":"string","description":"Banco Emissor BNDES"},"bandeiraBNDES":{"type":"string","description":"Bandeira BNDES"},"parcelasBNDES":{"type":"integer","description":"Parcelas BNDES"},"tipoOrcamento2":{"type":"integer","description":"Código do Tipo do Orçamento"},"observacaoGeral":{"type":"string","description":"Observação Geral"},"orcamentoInicial":{"type":"string","description":"Orçamento Inicial"},"orcamentoOrigem":{"type":"string","description":"Orçamento Origem"},"enviadoCliente":{"type":"boolean","description":"Enviado para Cliente"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio"},"localEntregaSequencia":{"type":"integer","description":"Endereço de Entrega Sequencial"},"localEntregaNome":{"type":"string","description":"Nome do Local de Entrega"},"localEntregaEndereco":{"type":"string","description":"Endereço do Local de Entrega"},"localEntregaCep":{"type":"string","description":"CEP do Local de Entrega"},"localEntregaCnpj":{"type":"string","description":"CNPJ do Local de Entrega"},"localEntregaInscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Local de Entrega"},"horarioEntrega":{"type":"string","description":"Horário de Entrega"},"localEntregaBairro":{"type":"string","description":"Bairro do Local de Entrega"},"localEntregaTelefone":{"type":"string","description":"Telefone do Local de Entrega"},"localEntregaFax":{"type":"string","description":"Fax do Local de Entrega"},"localEntregaNumeroEndereco":{"type":"string","description":"Número do Endereço do Local de Entrega"},"localEntregaComplemento":{"type":"string","description":"Complemento do Local de Entrega"},"tipoDescontoDuplicata":{"type":"integer","description":"Tipo de Desconto para Duplicatas (0 - Nenhum, 1 - Em percentual, 2 - Em valor)","enum":[0,1,2]},"descontoDuplicata":{"type":"number","description":"Valor de Desconto para Duplicatas"},"diaDesDuplicata":{"type":"integer","description":"Quantidade de Dias Antes do Vencimento da Duplicata"},"codInscEstadualSelecionado":{"type":"string","description":"Inscrição Estadual Selecionado"},"vencimentos":{"type":"array","description":"Vencimentos do Orçamento (Obrigatório para condição de venda 99)","items":{"type":"string"}},"orcamentoItem":{"type":"array","description":"Itens do Orçamento","items":{"$ref":"#/components/schemas/itemOrcamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"itemOrcamento":{"required":["quantidade"],"type":"object","properties":{"codOrcamento":{"type":"string","description":"Código do Orçamento"},"sequencial":{"type":"integer","description":"Sequencial do Item"},"codEstadoFornecimento":{"type":"string","description":"Código do Estado do Fornecimento"},"codFinalidade":{"type":"string","description":"Código do Estado do Fornecimento - Trefilados"},"codItem":{"type":"string","description":"Código do Item"},"codLista":{"type":"integer","description":"Código da Lista"},"codMotivoNaoVenda":{"type":"string","description":"Código do Motivo de não Venda"},"codNorma":{"type":"string","description":"Código do Motivo de não Venda"},"codTipoAco":{"type":"string","description":"Código do Tipo de Aço - Trefilados"},"codTipoTubo":{"type":"string","description":"Código do Tipo de Tubo - TTrefilados"},"codTransacaoEstoque":{"type":"integer","description":"Código da Transação de Estoque"},"comprimentoMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Comprimento em Centímetros - Trefilados"},"comprimentoMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Comprimento em Centímetros - Trefilados"},"composicaoPreco":{"type":"string","description":"Composição do Preço - TTrefilados"},"codUnidadeMedida":{"type":"string","description":"Código da Unidade de Medida"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"codCotacaoRes":{"type":"integer","description":"Cotação do Item Aços Ressulfurados - Custos"},"diametroExterno":{"multipleOf":0.01,"type":"number","description":"Diâmetro Externo - Trefilados"},"espessura":{"multipleOf":0.01,"type":"number","description":"Espessura - Trefilados"},"dadosComprimento":{"multipleOf":0.01,"type":"number","description":"Comprimento De - Trefilados"},"dadosComprimentoAte":{"multipleOf":0.01,"type":"number","description":"Comprimento Até - Trefilados"},"dataPrevFaturamento":{"type":"string","description":"Data de Previsão de Faturamento (YYYY-MM-DD)","format":"date"},"dataPrevisaoSugerida":{"type":"string","description":"Data de Previsão de Faturamento Sugerida (YYYY-MM-DD)","format":"date"},"descComplementar":{"type":"string","description":"Descrição Complementar do Item"},"desconto1":{"multipleOf":0.01,"type":"number","description":"Primeiro Percentual ou Valor do Desconto"},"desconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual ou Valor do Desconto"},"desconto3":{"multipleOf":0.01,"type":"number","description":"Terceiro Percentual ou Valor do Desconto"},"desconto4":{"multipleOf":0.01,"type":"number","description":"Quarto Percentual ou Valor do Desconto"},"desconto5":{"multipleOf":0.01,"type":"number","description":"Quinto Percentual ou Valor do Desconto"},"desconto6":{"multipleOf":0.01,"type":"number","description":"Sexto Percentual ou Valor do Desconto"},"diametroExtMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Externo em Centímetros - Trefilados"},"diametroExtMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Externo em Centímetros - Trefilados"},"diametroIntMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva do Diâmetro Interno em Centímetros - Trefilados"},"diametroIntMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa do Diâmetro Interno em Centímetros - Trefilados"},"diasUteis":{"type":"integer","description":"Dias Úteis"},"espessuraMais":{"multipleOf":0.01,"type":"number","description":"Tolerância Positiva da Espessura em Centímetros - Trefilados"},"espessuraMenos":{"multipleOf":0.01,"type":"number","description":"Tolerância Negativa da Espessura em Centímetros - Trefilados"},"tipoIPI":{"type":"integer","description":"Tipo do IPI (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"gerarPedido":{"type":"boolean","description":"Gerar Pedido do Item (0 - Não, 1 - Sim)"},"incideDescontoCapa":{"type":"boolean","description":"Incide Desconto na Capa (0 - Não, 1 - Sim)"},"mostrarTolerancia":{"type":"boolean","description":"Mostrar Tolerância - Trefilados"},"observacaoItem":{"maxLength":105,"type":"string","description":"Observação do Item do Orçamento"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"percAcrescimoCorte":{"multipleOf":0.01,"type":"number","description":"Percentual de Acréssimo de Corte - Trefilados"},"percComissaoAtendente":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão do Atendente"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual de IPI"},"percICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de ICMS"},"preco":{"multipleOf":0.0001,"type":"number","description":"Preço do Item"},"precoFabrica":{"multipleOf":0.00001,"type":"number","description":"Preço de Fábrica do Item"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Item"},"tipoAcrescimo":{"type":"integer","description":"Tipo de Acréssimo (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"tipoDesconto":{"type":"integer","description":"Tipo de Desconto (0 - Porcentagem, 1 - Valor)","enum":[0,1]},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"acrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo"},"valorCustoCorte":{"type":"number","description":"Valor do Custo do Corte - Trefilados"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"valorUnitario":{"multipleOf":0.00001,"type":"number","description":"Valor Unitário do Item"},"valorTabelaProg":{"multipleOf":0.01,"type":"number","description":"Valor da Tabela de Descontos Progressivos"},"classificacaoFiscal":{"type":"string","description":"VCódigo da Classificação Fiscal"},"codFae":{"type":"integer","description":"Código da FAE"},"codAplicacao":{"type":"integer","description":"Código da Aplicação (1 - Condução, 2 - Espelhamento, 3 - Caldeira / Trocador, 4 - Caldeira / Trocador, 5 - Liso/Sem riscos)","enum":[1,2,3,4,5]},"codOrcamentoRef":{"type":"string","description":"Código do Orçamento de Referência"},"codItemCliente":{"type":"string","description":"Código do Item no Cliente (Qquando item genérico)"},"itemPedidoCliente":{"type":"string","description":"Item do Pedido do Cliente"},"pedidoClienteItem":{"type":"string","description":"Pedido do cliente Item"},"descricaoProdCliConfeccao":{"type":"string","description":"Descrição do Produto do Cliente para Confeccao"},"codProdCliConfeccao":{"type":"string","description":"Código do Produto do Cliente para Confeccao"},"itemMateriaPrima":{"type":"boolean","description":"Item Será Utilizado como Matéria Prima (0 - Não, 1 - Sim)"},"precoUnitarioSemImpostos":{"multipleOf":0.00001,"type":"number","description":"Preço Unitário sem Impostos"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCancelamentoOrcamento object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"DadosCancelamentoOrcamento":{"required":["codMotivoNaoVenda"],"type":"object","properties":{"codMotivoNaoVenda":{"type":"integer","description":"Código do Motivo de não Venda"}}}}}} ``` ## The IcmsOrcamento object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"IcmsOrcamento":{"type":"object","properties":{"percentualIcms":{"type":"number","description":"Percentual do ICMS do Orçamento"}}}}}} ``` ## The DadosImpostosResult object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"DadosImpostosResult":{"type":"object","properties":{"codTipoNota":{"type":"string","description":"Código do Pedido de Venda"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio? ( 0 - Não / 1 - Sim)"},"codCliente":{"type":"string","description":"Código do Cliente"},"cepEntrega":{"type":"string","description":"Código do CEP do Endereço de Entrega (99999-999)"},"itensDadosImpostos":{"type":"array","description":"Dados de Impostos dos Itens","items":{"$ref":"#/components/schemas/ItensDadosImpostosResult"}}}},"ItensDadosImpostosResult":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do produto"},"valorTotalBrutoProduto":{"multipleOf":0.01,"type":"number","description":"Valor total do Item bruto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor acrescimo"},"valorAcrescimo":{"multipleOf":0.01,"type":"number","description":"Valor acrescimo"},"aliquotaIpi":{"type":"number","description":"Aliquota ipi"},"quantidadeProduto":{"type":"number","description":"Quantidade"},"percRedBaseIcms":{"multipleOf":0.01,"type":"number","description":"Percentual Reducao Base ICMS"},"percIcms":{"multipleOf":0.01,"type":"number","description":"Percentual ICMS"},"baseIpi":{"multipleOf":0.01,"type":"number","description":"Base do ipi"},"valorIpi":{"multipleOf":0.01,"type":"number","description":"valor ipi"},"ipiDespAcessorias":{"multipleOf":0.01,"type":"number","description":"Ipi sobre despesas acessórias"},"baseIcms":{"multipleOf":0.01,"type":"number","description":"Base icms"},"aliquotaIcms":{"multipleOf":0.01,"type":"number","description":"Aliquota icms"},"valorIcms":{"multipleOf":0.01,"type":"number","description":"Valor icms"},"percRedIcms":{"multipleOf":0.01,"type":"number","description":"Percentual de redução icms"},"baseCalcIcmsSt":{"multipleOf":0.01,"type":"number","description":"Base de cálculo icms-st"},"aliqInternaIcmsSt":{"multipleOf":0.01,"type":"number","description":"Aliquota interna icms-st"},"valorIcmsSt":{"multipleOf":0.01,"type":"number","description":"valor icms-st"},"percMva":{"multipleOf":0.01,"type":"number","description":"Percentual MVA"},"percReducao":{"multipleOf":0.01,"type":"number","description":"Percentual de redução"},"descontoIcmsZF":{"multipleOf":0.01,"type":"number","description":"Desconto Icms zona franca"},"descontoPisZF":{"multipleOf":0.01,"type":"number","description":"Desconto Pis zona franca"},"descontoCofinsZF":{"multipleOf":0.01,"type":"number","description":"Desconto Cofins zona franca"},"origemIcmsDiferenciado":{"type":"string","description":"Origem do Icms Diferenciado"},"cfop":{"type":"string","description":"CFOP"},"basePis":{"multipleOf":0.01,"type":"number","description":"Base PIS"},"aliquotaPis":{"multipleOf":0.01,"type":"number","description":"Alíquota PIS"},"valorPis":{"multipleOf":0.01,"type":"number","description":"Valor PIS"},"baseConfins":{"multipleOf":0.01,"type":"number","description":"Base COFINS"},"aliqCofins":{"multipleOf":0.01,"type":"number","description":"Alíquota COFINS"},"valorCofins":{"multipleOf":0.01,"type":"number","description":"Valor COFINS"},"CSOSN":{"type":"string","description":"CSOSN"},"finalidade":{"type":"string","description":"Finalidade"},"fcpIcmsNormal":{"multipleOf":0.01,"type":"number","description":"Percentual FCP ICMS Normal"},"valorFcpIcmsNormal":{"multipleOf":0.01,"type":"number","description":"Valor FCP ICMS Normal"},"icmsBaseDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Base UF Destino - DIFAL"},"icmsAliqDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Alíquota FCP - DIFAL"},"icmsAliqInternaDestinoDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Alíquota Interna UF Destino - DIFAL"},"icmsAliqInterestadual":{"multipleOf":0.01,"type":"number","description":"ICMS Alíquota Interestadual - DIFAL"},"percProvPartIcmsInterestDifal":{"multipleOf":0.01,"type":"number","description":"Perc.Prov.Part. ICMS Interestadual - DIFAL"},"icmsValorDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Valor FCP - DIFAL"},"icmsValorUfDestinoDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Valor UF Destino - DIFAL"},"icmsValorUfRemetenteDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Valor UF Remetente - DIFAL"},"percRedIcmsDifal":{"type":"number","description":"Redução BC ICMS DIFAL % - DIFAL"},"valorIcmsIsento":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Isento"},"stDestacado":{"multipleOf":0.01,"type":"number","description":"ST Não Destacado"},"fcpNaoDestacado":{"multipleOf":0.01,"type":"number","description":"FCP Não Destacado"},"cstIcms":{"type":"string","description":"CST ICMS"},"cstPis":{"type":"string","description":"CST PIS"},"cstCofins":{"type":"string","description":"CST COFINS"},"tipoContribPis":{"type":"string","description":"Tipo Contribuição PIS"},"tipoContribCofins":{"type":"string","description":"Tipo Contribuição Cofins"},"codEnquadIpi":{"type":"string","description":"Código Enquadramento do IPI"},"CEST":{"type":"string","description":"CEST"},"codBenifFiscalIcms":{"multipleOf":0.01,"type":"number","description":"Código Benefício Fiscal ICMS"},"valorIpiIsento":{"multipleOf":0.01,"type":"number","description":"Valor IPI Isento"},"valorIcmsOutras":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Outras"},"valorIcmsDiferido":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Diferido"},"valorIcmsDesonerado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Desonerado"},"percDiferimentoParcial":{"multipleOf":0.01,"type":"number","description":"Percentual Diferimento Parcial"},"percIcmsDiferido":{"multipleOf":0.01,"type":"number","description":"Percentual ICMS que foi Diferido"},"valorTribConsFinal":{"multipleOf":0.01,"type":"number","description":"Valor do Tributo do Consumidor Final"},"percTribConsFinal":{"multipleOf":0.01,"type":"number","description":"Percentual do Tributo do Consumidor Final"},"valorTribFederal":{"multipleOf":0.01,"type":"number","description":"Valor do Tributo Federal"},"valorTribEstadual":{"multipleOf":0.01,"type":"number","description":"Valor do Tributo Estadual"},"valorIpiOutras":{"multipleOf":0.01,"type":"number","description":"Valor IPI Outras"}}}}}} ``` ## The ItensDadosImpostosResult object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"ItensDadosImpostosResult":{"type":"object","properties":{"codProduto":{"type":"string","description":"Código do produto"},"valorTotalBrutoProduto":{"multipleOf":0.01,"type":"number","description":"Valor total do Item bruto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor acrescimo"},"valorAcrescimo":{"multipleOf":0.01,"type":"number","description":"Valor acrescimo"},"aliquotaIpi":{"type":"number","description":"Aliquota ipi"},"quantidadeProduto":{"type":"number","description":"Quantidade"},"percRedBaseIcms":{"multipleOf":0.01,"type":"number","description":"Percentual Reducao Base ICMS"},"percIcms":{"multipleOf":0.01,"type":"number","description":"Percentual ICMS"},"baseIpi":{"multipleOf":0.01,"type":"number","description":"Base do ipi"},"valorIpi":{"multipleOf":0.01,"type":"number","description":"valor ipi"},"ipiDespAcessorias":{"multipleOf":0.01,"type":"number","description":"Ipi sobre despesas acessórias"},"baseIcms":{"multipleOf":0.01,"type":"number","description":"Base icms"},"aliquotaIcms":{"multipleOf":0.01,"type":"number","description":"Aliquota icms"},"valorIcms":{"multipleOf":0.01,"type":"number","description":"Valor icms"},"percRedIcms":{"multipleOf":0.01,"type":"number","description":"Percentual de redução icms"},"baseCalcIcmsSt":{"multipleOf":0.01,"type":"number","description":"Base de cálculo icms-st"},"aliqInternaIcmsSt":{"multipleOf":0.01,"type":"number","description":"Aliquota interna icms-st"},"valorIcmsSt":{"multipleOf":0.01,"type":"number","description":"valor icms-st"},"percMva":{"multipleOf":0.01,"type":"number","description":"Percentual MVA"},"percReducao":{"multipleOf":0.01,"type":"number","description":"Percentual de redução"},"descontoIcmsZF":{"multipleOf":0.01,"type":"number","description":"Desconto Icms zona franca"},"descontoPisZF":{"multipleOf":0.01,"type":"number","description":"Desconto Pis zona franca"},"descontoCofinsZF":{"multipleOf":0.01,"type":"number","description":"Desconto Cofins zona franca"},"origemIcmsDiferenciado":{"type":"string","description":"Origem do Icms Diferenciado"},"cfop":{"type":"string","description":"CFOP"},"basePis":{"multipleOf":0.01,"type":"number","description":"Base PIS"},"aliquotaPis":{"multipleOf":0.01,"type":"number","description":"Alíquota PIS"},"valorPis":{"multipleOf":0.01,"type":"number","description":"Valor PIS"},"baseConfins":{"multipleOf":0.01,"type":"number","description":"Base COFINS"},"aliqCofins":{"multipleOf":0.01,"type":"number","description":"Alíquota COFINS"},"valorCofins":{"multipleOf":0.01,"type":"number","description":"Valor COFINS"},"CSOSN":{"type":"string","description":"CSOSN"},"finalidade":{"type":"string","description":"Finalidade"},"fcpIcmsNormal":{"multipleOf":0.01,"type":"number","description":"Percentual FCP ICMS Normal"},"valorFcpIcmsNormal":{"multipleOf":0.01,"type":"number","description":"Valor FCP ICMS Normal"},"icmsBaseDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Base UF Destino - DIFAL"},"icmsAliqDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Alíquota FCP - DIFAL"},"icmsAliqInternaDestinoDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Alíquota Interna UF Destino - DIFAL"},"icmsAliqInterestadual":{"multipleOf":0.01,"type":"number","description":"ICMS Alíquota Interestadual - DIFAL"},"percProvPartIcmsInterestDifal":{"multipleOf":0.01,"type":"number","description":"Perc.Prov.Part. ICMS Interestadual - DIFAL"},"icmsValorDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Valor FCP - DIFAL"},"icmsValorUfDestinoDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Valor UF Destino - DIFAL"},"icmsValorUfRemetenteDifal":{"multipleOf":0.01,"type":"number","description":"ICMS Valor UF Remetente - DIFAL"},"percRedIcmsDifal":{"type":"number","description":"Redução BC ICMS DIFAL % - DIFAL"},"valorIcmsIsento":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Isento"},"stDestacado":{"multipleOf":0.01,"type":"number","description":"ST Não Destacado"},"fcpNaoDestacado":{"multipleOf":0.01,"type":"number","description":"FCP Não Destacado"},"cstIcms":{"type":"string","description":"CST ICMS"},"cstPis":{"type":"string","description":"CST PIS"},"cstCofins":{"type":"string","description":"CST COFINS"},"tipoContribPis":{"type":"string","description":"Tipo Contribuição PIS"},"tipoContribCofins":{"type":"string","description":"Tipo Contribuição Cofins"},"codEnquadIpi":{"type":"string","description":"Código Enquadramento do IPI"},"CEST":{"type":"string","description":"CEST"},"codBenifFiscalIcms":{"multipleOf":0.01,"type":"number","description":"Código Benefício Fiscal ICMS"},"valorIpiIsento":{"multipleOf":0.01,"type":"number","description":"Valor IPI Isento"},"valorIcmsOutras":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Outras"},"valorIcmsDiferido":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Diferido"},"valorIcmsDesonerado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Desonerado"},"percDiferimentoParcial":{"multipleOf":0.01,"type":"number","description":"Percentual Diferimento Parcial"},"percIcmsDiferido":{"multipleOf":0.01,"type":"number","description":"Percentual ICMS que foi Diferido"},"valorTribConsFinal":{"multipleOf":0.01,"type":"number","description":"Valor do Tributo do Consumidor Final"},"percTribConsFinal":{"multipleOf":0.01,"type":"number","description":"Percentual do Tributo do Consumidor Final"},"valorTribFederal":{"multipleOf":0.01,"type":"number","description":"Valor do Tributo Federal"},"valorTribEstadual":{"multipleOf":0.01,"type":"number","description":"Valor do Tributo Estadual"},"valorIpiOutras":{"multipleOf":0.01,"type":"number","description":"Valor IPI Outras"}}}}}} ``` ## The DadosImpostos object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"DadosImpostos":{"required":["codCliente","codTipoNota","consumoProprio"],"type":"object","properties":{"codTipoNota":{"type":"string","description":"Código do Tipo de Nota"},"consumoProprio":{"type":"boolean","description":"Consumo Próprio? ( 0 - Não / 1 - Sim)"},"codCliente":{"type":"string","description":"Código do Cliente"},"cepEntrega":{"type":"string","description":"Código do CEP do Endereço de Entrega (99999-999) * Se for consumidor final Será aplicada a alíquota de ICMS do Endereço de Entrega caso este seja diferente do Cadastro de Clientes."},"CPFCNPJ":{"type":"string","description":"CPF / CNPJ do cliente * Informar caso cliente não esteja cadastrado"},"inscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Cliente * Informar caso cliente não esteja cadastrado"},"codRamo":{"type":"string","description":"Código do Ramo de Atividade do Cliente * Informar caso cliente não esteja cadastrado"},"consFinal":{"type":"boolean","description":"Consumidor final (0- Não / 1 - Sim) * Informar caso cliente não esteja cadastrado"},"simplesNacional":{"type":"boolean","description":"Simples Nacional (0- Não / 1 - Sim) * Informar caso cliente não esteja cadastrado"},"numeroSuframa":{"type":"string","description":"Número Inscrição Suframa * Informar caso cliente não esteja cadastrado"},"itensDadosImpostos":{"type":"array","description":"Itens do Pedido de Venda","items":{"$ref":"#/components/schemas/ItensDadosImpostos"}}}},"ItensDadosImpostos":{"required":["codProduto","qtdPedida","valorAcrescimo","valorDesconto","valorTotalBrutoProduto"],"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"multipleOf":0.001,"type":"number","description":"Quantidade Pedida"},"valorTotalBrutoProduto":{"multipleOf":0.01,"type":"number","description":"Valor Total Bruto do Produto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto Aplicado no Produto"},"valorAcrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo Aplicado no Produto"}}}}}} ``` ## The ItensDadosImpostos object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"ItensDadosImpostos":{"required":["codProduto","qtdPedida","valorAcrescimo","valorDesconto","valorTotalBrutoProduto"],"type":"object","properties":{"codProduto":{"type":"string","description":"Código do Produto"},"qtdPedida":{"multipleOf":0.001,"type":"number","description":"Quantidade Pedida"},"valorTotalBrutoProduto":{"multipleOf":0.01,"type":"number","description":"Valor Total Bruto do Produto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto Aplicado no Produto"},"valorAcrescimo":{"multipleOf":0.01,"type":"number","description":"Valor do Acréscimo Aplicado no Produto"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Televendas - CRM","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Pedido De Compra pedidoCompra ## PUT /pedidoCompra > Cadastrar um Pedido de Compra ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"tags":[{"name":"Pedido de Compra","description":"pedidoCompra"}],"servers":[{"url":"https://localhost/compras/v20"},{"url":"http://localhost/compras/v20"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PedidoCompraPut":{"required":["itemPedidoCompra"],"type":"object","properties":{"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codLocalEntrega":{"type":"integer","description":"Código do Local de Entrega"},"condicaoPagamento":{"type":"integer","description":"Código da Condição de Pagamento"},"codLocalCobranca":{"type":"integer","description":"Código do Local de Cobrança"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"observacoesPadrao":{"type":"array","description":"Observações padrão","items":{"$ref":"#/components/schemas/ObservacaoPadrao"}},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)","enum":[1,2,3,4,5,6,7]},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"codMoeda":{"type":"integer","description":"Código da Moeda"},"cotacaoMoeda":{"multipleOf":0.0001,"type":"number","description":"Valor da Cotação"},"opcaoTipoFrete":{"type":"integer","description":"Opção de Tipo de Frete"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"percSeguro":{"multipleOf":0.01,"type":"number","description":"Percentual do Seguro Sobre o Valor das Mercadorias"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro Sobre o Valor das Mercadorias"},"percDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesas Acessórias"},"valorDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias"},"codPerfilComprador":{"type":"integer","description":"Código do Perfil do Comprador"},"finalidade":{"type":"number","description":"Finalidade da compra"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"condicaoPagtoInfo":{"type":"array","description":"Condição de pagamento","items":{"$ref":"#/components/schemas/CondicaoPagtoInfo"}},"diaEntgPosFatura":{"type":"integer","description":"Dias Entrega pós Faturamento"},"codPolFluxoApr":{"type":"integer","description":"Política do Fluxo de Aprovação"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompraPut"}},"observacoes":{"type":"array","description":"Observações","items":{"$ref":"#/components/schemas/Observacao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"},"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}},"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoCompra":{"put":{"tags":["Pedido de Compra"],"summary":"Cadastrar um Pedido de Compra","operationId":"GerarPedidoAPI","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Pedido de Compra","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoCompraPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /pedidoCompra/{id} > Alterar um Pedido de Compra ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"tags":[{"name":"Pedido de Compra","description":"pedidoCompra"}],"servers":[{"url":"https://localhost/compras/v20"},{"url":"http://localhost/compras/v20"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PedidoCompraPut":{"required":["itemPedidoCompra"],"type":"object","properties":{"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codLocalEntrega":{"type":"integer","description":"Código do Local de Entrega"},"condicaoPagamento":{"type":"integer","description":"Código da Condição de Pagamento"},"codLocalCobranca":{"type":"integer","description":"Código do Local de Cobrança"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"observacoesPadrao":{"type":"array","description":"Observações padrão","items":{"$ref":"#/components/schemas/ObservacaoPadrao"}},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)","enum":[1,2,3,4,5,6,7]},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"codMoeda":{"type":"integer","description":"Código da Moeda"},"cotacaoMoeda":{"multipleOf":0.0001,"type":"number","description":"Valor da Cotação"},"opcaoTipoFrete":{"type":"integer","description":"Opção de Tipo de Frete"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"percSeguro":{"multipleOf":0.01,"type":"number","description":"Percentual do Seguro Sobre o Valor das Mercadorias"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro Sobre o Valor das Mercadorias"},"percDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesas Acessórias"},"valorDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias"},"codPerfilComprador":{"type":"integer","description":"Código do Perfil do Comprador"},"finalidade":{"type":"number","description":"Finalidade da compra"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"condicaoPagtoInfo":{"type":"array","description":"Condição de pagamento","items":{"$ref":"#/components/schemas/CondicaoPagtoInfo"}},"diaEntgPosFatura":{"type":"integer","description":"Dias Entrega pós Faturamento"},"codPolFluxoApr":{"type":"integer","description":"Política do Fluxo de Aprovação"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompraPut"}},"observacoes":{"type":"array","description":"Observações","items":{"$ref":"#/components/schemas/Observacao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"},"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}},"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoCompra/{id}":{"post":{"tags":["Pedido de Compra"],"summary":"Alterar um Pedido de Compra","operationId":"AtualizarPedidoAPI","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Compra","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Pedido de Compra","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoCompraPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoCompraPut"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /pedidoCompraSolicitarLiberacao/{id} > Solicitar Liberação de um Pedido de Compra ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"tags":[{"name":"Pedido de Compra","description":"pedidoCompra"}],"servers":[{"url":"https://localhost/compras/v20"},{"url":"http://localhost/compras/v20"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"PedidoCompraPut":{"required":["itemPedidoCompra"],"type":"object","properties":{"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codLocalEntrega":{"type":"integer","description":"Código do Local de Entrega"},"condicaoPagamento":{"type":"integer","description":"Código da Condição de Pagamento"},"codLocalCobranca":{"type":"integer","description":"Código do Local de Cobrança"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"observacoesPadrao":{"type":"array","description":"Observações padrão","items":{"$ref":"#/components/schemas/ObservacaoPadrao"}},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)","enum":[1,2,3,4,5,6,7]},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"codMoeda":{"type":"integer","description":"Código da Moeda"},"cotacaoMoeda":{"multipleOf":0.0001,"type":"number","description":"Valor da Cotação"},"opcaoTipoFrete":{"type":"integer","description":"Opção de Tipo de Frete"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"percSeguro":{"multipleOf":0.01,"type":"number","description":"Percentual do Seguro Sobre o Valor das Mercadorias"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro Sobre o Valor das Mercadorias"},"percDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesas Acessórias"},"valorDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias"},"codPerfilComprador":{"type":"integer","description":"Código do Perfil do Comprador"},"finalidade":{"type":"number","description":"Finalidade da compra"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"condicaoPagtoInfo":{"type":"array","description":"Condição de pagamento","items":{"$ref":"#/components/schemas/CondicaoPagtoInfo"}},"diaEntgPosFatura":{"type":"integer","description":"Dias Entrega pós Faturamento"},"codPolFluxoApr":{"type":"integer","description":"Política do Fluxo de Aprovação"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompraPut"}},"observacoes":{"type":"array","description":"Observações","items":{"$ref":"#/components/schemas/Observacao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"},"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}},"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/pedidoCompraSolicitarLiberacao/{id}":{"post":{"tags":["Pedido de Compra"],"summary":"Solicitar Liberação de um Pedido de Compra","operationId":"SolicitarLiberarPedidoCompraAPI","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Pedido de Compra","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PedidoCompraPut"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The PedidoCompraPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"PedidoCompraPut":{"required":["itemPedidoCompra"],"type":"object","properties":{"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"codLocalEntrega":{"type":"integer","description":"Código do Local de Entrega"},"condicaoPagamento":{"type":"integer","description":"Código da Condição de Pagamento"},"codLocalCobranca":{"type":"integer","description":"Código do Local de Cobrança"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"observacoesPadrao":{"type":"array","description":"Observações padrão","items":{"$ref":"#/components/schemas/ObservacaoPadrao"}},"tipoPedido":{"type":"integer","description":"Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)","enum":[1,2,3,4,5,6,7]},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"codMoeda":{"type":"integer","description":"Código da Moeda"},"cotacaoMoeda":{"multipleOf":0.0001,"type":"number","description":"Valor da Cotação"},"opcaoTipoFrete":{"type":"integer","description":"Opção de Tipo de Frete"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"percSeguro":{"multipleOf":0.01,"type":"number","description":"Percentual do Seguro Sobre o Valor das Mercadorias"},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor do Seguro Sobre o Valor das Mercadorias"},"percDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesas Acessórias"},"valorDespesasAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias"},"codPerfilComprador":{"type":"integer","description":"Código do Perfil do Comprador"},"finalidade":{"type":"number","description":"Finalidade da compra"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"condicaoPagtoInfo":{"type":"array","description":"Condição de pagamento","items":{"$ref":"#/components/schemas/CondicaoPagtoInfo"}},"diaEntgPosFatura":{"type":"integer","description":"Dias Entrega pós Faturamento"},"codPolFluxoApr":{"type":"integer","description":"Política do Fluxo de Aprovação"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompraPut"}},"observacoes":{"type":"array","description":"Observações","items":{"$ref":"#/components/schemas/Observacao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"},"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}},"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"}}}} ``` ## The itemPedidoCompraPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitario Compra"},"percAliquotaIPI":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Percentual de IPI do Produto"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"type":"integer","description":"Centro de Custo para Uso do Produto"},"contaContabilC":{"maxLength":13,"type":"string","description":"Código da Conta Contábil"},"numControle":{"maxLength":15,"type":"string","description":"Número do Controle"},"valorICMSST":{"multipleOf":0.01,"maximum":99,"type":"number","description":"Valor do ICMS ST"},"ratearCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"percAliquotaPIS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"maximum":99999,"type":"number","description":"Percentual de Aliquota do COFINS"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"descricaoItemC":{"type":"string"},"observacoesItem":{"type":"array","description":"Observações do item","items":{"$ref":"#/components/schemas/ObservacaoItem"}},"rateioCusto":{"type":"array","items":{"$ref":"#/components/schemas/RateioCusto"}},"unidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"dadosCustomizados":{"type":"array","description":"Dados Customizados","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"},"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The RateioCusto object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"RateioCusto":{"required":["centroCustos","contaContabil","percProporcaoCCusto","percProporcaoConta"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Código do Centro de Custos"},"percProporcaoCCusto":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Centro de Custo"},"contaContabil":{"maxLength":13,"type":"string"},"percProporcaoConta":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio Conta Contáil"}}}}}} ``` ## The CondicaoPagtoInfo object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"CondicaoPagtoInfo":{"required":["data","dias","proporcao","valor"],"type":"object","properties":{"dias":{"type":"integer","description":"quantidade dias para pagamento"},"data":{"type":"string","description":"data específica para pagamento","format":"date"},"proporcao":{"multipleOf":0.01,"type":"number","description":"proporção da parcela"},"valor":{"multipleOf":0.01,"type":"number","description":"valor da parcela"}}}}}} ``` ## The Observacao object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"Observacao":{"required":["observacao"],"type":"object","properties":{"observacao":{"type":"string","description":"Observação"}},"description":"Observação"}}}} ``` ## The ObservacaoItem object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"ObservacaoItem":{"type":"object","properties":{"observaoItem":{"type":"string","description":"Observação"}},"description":"Observação"}}}} ``` ## The ObservacaoPadrao object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"ObservacaoPadrao":{"required":["codObservacao"],"type":"object","properties":{"codObservacao":{"type":"integer","description":"Código da Observação"}},"description":"Códigos de Observação"}}}} ``` ## The NumeroControle object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"NumeroControle":{"required":["numControle"],"type":"object","properties":{"numControle":{"type":"number","description":"Número de Controle"}}}}}} ``` ## The MsgStatusRequisicao object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"MsgStatusRequisicao":{"type":"object","properties":{"mensagem":{"type":"string","description":"Status Retorno da Requisição"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"2.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Componentes # Componentes v1.0 # Controle De Alterações Para Sincronismo De Informações (Eventos) evento ## GET /evento > Obter listagem de eventos para sincronizar ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Controle de alterações para sincronismo de informações (Eventos)","description":"evento"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaItens":{"type":"object","properties":{"continuationToken":{"type":"string"},"agrupadores":{"type":"array","items":{"$ref":"#/components/schemas/Agrupadores"}},"data":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}}},"Agrupadores":{"type":"object","required":["dataAgrupador","codAgrupador"],"properties":{"dataAgrupador":{"type":"string","description":"Data do Agrupador"},"codAgrupador":{"type":"integer","description":"Código do Agrupador"}}},"Item":{"type":"object","required":["id","tipoEvento","operacao","item","dadosItem"],"properties":{"id":{"type":"string","description":"Identificador interno da integração"},"tipoEvento":{"type":"string","description":"Indica o tipo de evento que teve alteração"},"operacao":{"type":"string","description":"M-Inclusão/Alteração, D-Exclusão","enum":["M","D"]},"item":{"type":"string"},"dadosItem":{"type":"array","items":{"$ref":"#/components/schemas/DadosItem"}},"objEvento":{"type":"string"}}},"DadosItem":{"type":"object","required":["chave","valor"],"properties":{"chave":{"type":"string","description":"Chave"},"valor":{"type":"string","description":"Valor"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/evento":{"get":{"tags":["Controle de alterações para sincronismo de informações (Eventos)"],"summary":"Obter listagem de eventos para sincronizar","operationId":"ObterItensEvento","parameters":[{"schema":{"type":"string"},"name":"evento","in":"header","description":"Identificador do Evento","required":true},{"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"name":"tipoEventos (Descontinuado)","in":"query","required":false,"description":"Lista de Tipo de Eventos"},{"schema":{"type":"boolean"},"name":"incluirObjEvento","in":"query","description":"Envia objeto no evento","required":false},{"schema":{"type":"string"},"name":"continuationToken","in":"query","description":"Identificador da paginação da consulta","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaItens"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /evento > Confirmar sincronização dos eventos ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Controle de alterações para sincronismo de informações (Eventos)","description":"evento"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaIdentificadores":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Identificador"}}}},"Identificador":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identificador interno de integração que foi recebido"},"tipoEvento":{"type":"string","description":"Indica o tipo de evento que teve alteração"},"item":{"type":"string"}}}}},"paths":{"/evento":{"post":{"tags":["Controle de alterações para sincronismo de informações (Eventos)"],"summary":"Confirmar sincronização dos eventos","operationId":"ConfirmarIdentificadoresEvento","parameters":[{"schema":{"type":"string"},"name":"evento","in":"header","description":"Identificador do Evento","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaIdentificadores"}}},"description":"Listagem dos identificadores internos que foram obtidos com sucesso. Conforme as propriedades forem preenchidas, serão eliminados os eventos passados até o identificador repassado.","required":true}}}}} ``` ## POST /evento/{dataAgrupador}/{codAgrupador} > Confirmar sincronização por Agrupador ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Controle de alterações para sincronismo de informações (Eventos)","description":"evento"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/evento/{dataAgrupador}/{codAgrupador}":{"post":{"tags":["Controle de alterações para sincronismo de informações (Eventos)"],"summary":"Confirmar sincronização por Agrupador","operationId":"ConfirmarIdentificadorAgrupadorEvento","parameters":[{"schema":{"type":"string"},"name":"evento","in":"header","description":"Identificador do Evento","required":true},{"schema":{"type":"string","format":"date"},"name":"dataAgrupador","in":"path","description":"Data do Agrupador (YYYY-MM-DD)","required":true},{"schema":{"type":"integer"},"name":"codAgrupador","in":"path","description":"Código do Agrupador","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## POST /cargaCompleta > Inicia Sincronização completa ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Controle de alterações para sincronismo de informações (Eventos)","description":"evento"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/cargaCompleta":{"post":{"tags":["Controle de alterações para sincronismo de informações (Eventos)"],"summary":"Inicia Sincronização completa","operationId":"CargaCompleta","parameters":[{"schema":{"type":"string"},"name":"evento","in":"query","description":"Identificador do Evento","required":true},{"schema":{"type":"string"},"name":"tipoEventos","in":"query","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Realizar O Envio De Email Do Sistema Consistem ERP Para Destinatários email ## POST /email > Enviar email do Consistem para destinatários ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Realizar o envio de email do sistema Consistem ERP para destinatários","description":"email"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaEmails":{"type":"object","required":["listaEmail"],"properties":{"listaEmail":{"type":"array","items":{"$ref":"#/components/schemas/Email"}}}},"Email":{"type":"object","required":["assunto","texto","destinatarios"],"properties":{"assunto":{"type":"string","minLength":1,"maxLength":128,"description":"Conteúdo do texto que deve ser enviado como assunto do email."},"texto":{"type":"string","minLength":1,"maxLength":1024,"description":"Conteúdo do texto que deve ser enviado no corpo do email."},"destinatarios":{"type":"array","items":{"$ref":"#/components/schemas/Destinatarios"}}}},"Destinatarios":{"type":"object","required":["Realizar o envio de email do sistema Consistem ERP para destinatários"],"properties":{"email":{"minLength":1,"maxLength":128,"description":"Email do destinatário","type":"string"}}}}},"paths":{"/email":{"post":{"tags":["Realizar o envio de email do sistema Consistem ERP para destinatários"],"summary":"Enviar email do Consistem para destinatários","description":"","operationId":"EnviarEmail","responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaEmails"}}},"description":"Listagem de emails que devem ser enviados do Consistem aos destinatários.","required":true}}}}} ``` # Gerar Notificação Para Usuários Do Sistema Consistem ERP notificacao ## POST /notificacao > Gerar notificação para usuários do Consistem ERP ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Gerar notificação para usuários do sistema Consistem ERP","description":"notificacao"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"ListaNotificacoes":{"type":"object","required":["listaNotificacao"],"properties":{"listaNotificacao":{"type":"array","items":{"$ref":"#/components/schemas/Notificacao"}}}},"Notificacao":{"type":"object","required":["texto","usuarios"],"properties":{"texto":{"type":"string","minLength":1,"maxLength":1024,"description":"Conteúdo do texto que deve ser gerado na notificação."},"usuarios":{"type":"array","items":{"$ref":"#/components/schemas/Usuarios"}}}},"Usuarios":{"type":"object","required":["usuario"],"properties":{"usuario":{"minLength":1,"maxLength":50,"description":"Necessário informar um usuário cadastrado no sistema Consistem ERP.","type":"string"}}}}},"paths":{"/notificacao":{"post":{"tags":["Gerar notificação para usuários do sistema Consistem ERP"],"summary":"Gerar notificação para usuários do Consistem ERP","operationId":"GerarNotificacao","responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaNotificacoes"}}},"description":"Listagem de notificações que devem ser geradas aos usuários do Consistem.","required":true}}}}} ``` # Sincronização Dos Eventos Do Sistema Consistem Cloud Com O Sistema Consistem ERP cloud ## POST /event > Evento para sincronização cloud ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Sincronização dos eventos do sistema Consistem Cloud com o sistema Consistem ERP","description":"cloud"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"EventCloud":{"type":"object","required":["method","class"],"properties":{"method":{"type":"string","minLength":1,"maxLength":50,"description":"Método para sincronização."},"class":{"type":"string","minLength":1,"maxLength":50,"description":"Classe para sincronização."},"parameter":{"type":"array","items":{"$ref":"#/components/schemas/Args"}}}},"Args":{"type":"object","required":["method","class"],"properties":{"arg":{"minLength":1,"maxLength":50,"description":"Parâmetro do evento","type":"string"}}}}},"paths":{"/event":{"post":{"tags":["Sincronização dos eventos do sistema Consistem Cloud com o sistema Consistem ERP"],"summary":"Evento para sincronização cloud","operationId":"CloudEvent","responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCloud"}}},"description":"Método para sincronização dos dados cloud com o ERP Consistem.","required":true}}}}} ``` # Autenticação De Usuários Do Consistem ERP autenticacaoUsuario ## GET /autenticacaoUsuario > Autenticação do Usuário Consistem ERP ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Autenticação de Usuários do Consistem ERP","description":"autenticacaoUsuario"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"DadosUsuario":{"type":"object","properties":{"codigo":{"description":"Código do Usuário","type":"integer"},"nome":{"description":"Nome do Usuário","type":"string"},"email":{"description":"E-mail do Usuário","type":"string"},"idiomaPadrao":{"description":"Idioma Padrão do Usuário (0 - Português, 1 - Inglês, 2 - Espanhol, 3 - Alemão, 4 - Italiano, 5 - Francês)","type":"integer"},"usuarioAdmin":{"description":"Usuário é Administrador? (0 - Não, 1 - Sim)","type":"boolean"},"empresaPadrao":{"description":"Código da Empresa Padrão do Usuário","type":"integer"},"rotinaPadrao":{"description":"Rotina Padrão do Usuário","type":"string"},"tipoMenu":{"description":"Tipo de Menu do Usuário (0 - Por Nível, 1 - Por Perfil)","type":"integer"},"empresas":{"description":"Empresas do Usuário","type":"array","items":{"$ref":"#/components/schemas/EmpresasUsuario"}},"areasChave":{"description":"Áreas Chave do Usuário","type":"array","items":{"$ref":"#/components/schemas/AreasChaveUsuario"}},"dispositivos":{"description":"Dispositivos do Usuário","type":"array","items":{"$ref":"#/components/schemas/DispositivosUsuario"}},"dadosCustomizados":{"description":"Dados Customizados","type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"EmpresasUsuario":{"type":"object","properties":{"codigo":{"description":"Código da Empresa","type":"integer"},"nome":{"description":"Nome da Empresa","type":"string"},"fantasia":{"description":"Nome fantasia da Empresa","type":"string"}}},"AreasChaveUsuario":{"type":"object","properties":{"codigoArea":{"description":"Área Chave do Usuário","type":"integer"}}},"DispositivosUsuario":{"type":"object","properties":{"codigoDisp":{"description":"Dispositivo do Usuário","type":"integer"}}},"DadosCustomizados":{"type":"object","properties":{"campo":{"description":"Campo Customizado","type":"integer"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/autenticacaoUsuario":{"get":{"tags":["Autenticação de Usuários do Consistem ERP"],"summary":"Autenticação do Usuário Consistem ERP","operationId":"AutenticarUsuario","parameters":[{"schema":{"type":"string"},"name":"usuario","in":"query","description":"Usuário","required":true},{"schema":{"type":"string"},"name":"senha","in":"query","description":"Senha do Usuário","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DadosUsuario"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Consistem Remote Printer printer ## GET /printer/queue > Obter fila de impressão ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Consistem Remote Printer","description":"printer"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Printer":{"type":"object","properties":{"serverName":{"type":"string"},"printerName":{"type":"string"},"type":{"type":"string"},"dateCreated":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/printer/queue":{"get":{"tags":["Consistem Remote Printer"],"summary":"Obter fila de impressão","operationId":"GetPrinterQueue","parameters":[{"schema":{"type":"string"},"name":"serverName","in":"query","description":"Nome do Servidor","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Printer"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /printer/queue/{contentId} > Obter conteúdo da fila ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Consistem Remote Printer","description":"printer"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}}},"paths":{"/printer/queue/{contentId}":{"get":{"tags":["Consistem Remote Printer"],"summary":"Obter conteúdo da fila","operationId":"GetQueueContent","parameters":[{"schema":{"type":"string"},"name":"contentId","in":"path","description":"Id do Conteúdo","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/octet-stream":{}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/octet-stream":{}}}}}}}} ``` ## POST /printer/queue/finished > Definir processo de fila ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Consistem Remote Printer","description":"printer"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/printer/queue/finished":{"post":{"tags":["Consistem Remote Printer"],"summary":"Definir processo de fila","operationId":"SetQueueProcess","responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"queueId":{"type":"integer"},"status":{"type":"integer"},"msg":{"type":"string"}}}}},"description":"Dados processo de fila.","required":true}}}}} ``` ## POST /printer/registerInstance > Definir impressoras por servidor ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Consistem Remote Printer","description":"printer"}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/printer/registerInstance":{"post":{"tags":["Consistem Remote Printer"],"summary":"Definir impressoras por servidor","operationId":"SetPrinters","responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"serverName":{"type":"string"},"printers":{"type":"array","items":{"type":"string"}}}}}},"description":"Lista de empressoras por servidor.","required":true}}}}} ``` # Whatsapp Webhook Endpoint para tratar mensagens recebidas pelo webhook do Whatsapp. ## POST /whatsapp/webhook > Receber mensagens do webhook do Whatsapp ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"tags":[{"name":"Whatsapp Webhook","description":"Endpoint para tratar mensagens recebidas pelo webhook do Whatsapp."}],"servers":[{"url":"https://localhost/componentes/v10"},{"url":"http://localhost/componentes/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"WebhookWhatsappPayload":{"type":"object","properties":{"messaging_product":{"type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}}},"Metadata":{"type":"object","properties":{"display_phone_number":{"type":"string"},"phone_number_id":{"type":"string"}}},"Contact":{"type":"object","properties":{"profile":{"$ref":"#/components/schemas/Profile"},"wa_id":{"type":"string"}}},"Profile":{"type":"object","properties":{"name":{"type":"string"}}},"Message":{"type":"object","properties":{"from":{"type":"string"},"id":{"type":"string"},"timestamp":{"type":"string"},"text":{"$ref":"#/components/schemas/Text"},"interactive":{"$ref":"#/components/schemas/Interactive"},"reaction":{"$ref":"#/components/schemas/Reaction"},"location":{"$ref":"#/components/schemas/Location"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/MessageContact"}},"button":{"$ref":"#/components/schemas/Button"},"type":{"type":"string"}}},"Text":{"type":"object","properties":{"body":{"type":"string"}}},"Interactive":{"type":"object","properties":{"list_reply":{"$ref":"#/components/schemas/ListReply"},"button_reply":{"$ref":"#/components/schemas/ButtonReply"},"type":{"type":"string"}}},"ListReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}},"ButtonReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}}},"Reaction":{"type":"object","properties":{"message_id":{"type":"string"},"emoji":{"type":"string"}}},"Location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"address":{"type":"string"}}},"MessageContact":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"birthday":{"type":"string"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailWhatsapp"}},"name":{"$ref":"#/components/schemas/Name"},"org":{"$ref":"#/components/schemas/Org"},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"urls":{"type":"array","items":{"$ref":"#/components/schemas/Url"}}}},"Address":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"},"type":{"type":"string"}}},"EmailWhatsapp":{"type":"object","properties":{"email":{"type":"string"},"type":{"type":"string"}}},"Name":{"type":"object","properties":{"formatted_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"middle_name":{"type":"string"},"suffix":{"type":"string"},"prefix":{"type":"string"}}},"Org":{"type":"object","properties":{"company":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"}}},"Phone":{"type":"object","properties":{"phone":{"type":"string"},"wa_id":{"type":"string"},"type":{"type":"string"}}},"Url":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}},"Button":{"type":"object","properties":{"text":{"type":"string"},"payload":{"type":"string"}}}}},"paths":{"/whatsapp/webhook":{"post":{"tags":["Whatsapp Webhook"],"summary":"Receber mensagens do webhook do Whatsapp","operationId":"ReceberWebhookWhatsapp","responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookWhatsappPayload"}}},"description":"Payload recebido pelo webhook do Whatsapp.","required":true}}}}} ``` # Models ## The Item object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Item":{"type":"object","required":["id","tipoEvento","operacao","item","dadosItem"],"properties":{"id":{"type":"string","description":"Identificador interno da integração"},"tipoEvento":{"type":"string","description":"Indica o tipo de evento que teve alteração"},"operacao":{"type":"string","description":"M-Inclusão/Alteração, D-Exclusão","enum":["M","D"]},"item":{"type":"string"},"dadosItem":{"type":"array","items":{"$ref":"#/components/schemas/DadosItem"}},"objEvento":{"type":"string"}}},"DadosItem":{"type":"object","required":["chave","valor"],"properties":{"chave":{"type":"string","description":"Chave"},"valor":{"type":"string","description":"Valor"}}}}}} ``` ## The DadosItem object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"DadosItem":{"type":"object","required":["chave","valor"],"properties":{"chave":{"type":"string","description":"Chave"},"valor":{"type":"string","description":"Valor"}}}}}} ``` ## The Agrupadores object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Agrupadores":{"type":"object","required":["dataAgrupador","codAgrupador"],"properties":{"dataAgrupador":{"type":"string","description":"Data do Agrupador"},"codAgrupador":{"type":"integer","description":"Código do Agrupador"}}}}}} ``` ## The ListaItens object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"ListaItens":{"type":"object","properties":{"continuationToken":{"type":"string"},"agrupadores":{"type":"array","items":{"$ref":"#/components/schemas/Agrupadores"}},"data":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}}},"Agrupadores":{"type":"object","required":["dataAgrupador","codAgrupador"],"properties":{"dataAgrupador":{"type":"string","description":"Data do Agrupador"},"codAgrupador":{"type":"integer","description":"Código do Agrupador"}}},"Item":{"type":"object","required":["id","tipoEvento","operacao","item","dadosItem"],"properties":{"id":{"type":"string","description":"Identificador interno da integração"},"tipoEvento":{"type":"string","description":"Indica o tipo de evento que teve alteração"},"operacao":{"type":"string","description":"M-Inclusão/Alteração, D-Exclusão","enum":["M","D"]},"item":{"type":"string"},"dadosItem":{"type":"array","items":{"$ref":"#/components/schemas/DadosItem"}},"objEvento":{"type":"string"}}},"DadosItem":{"type":"object","required":["chave","valor"],"properties":{"chave":{"type":"string","description":"Chave"},"valor":{"type":"string","description":"Valor"}}}}}} ``` ## The Identificador object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Identificador":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identificador interno de integração que foi recebido"},"tipoEvento":{"type":"string","description":"Indica o tipo de evento que teve alteração"},"item":{"type":"string"}}}}}} ``` ## The ListaIdentificadores object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"ListaIdentificadores":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Identificador"}}}},"Identificador":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identificador interno de integração que foi recebido"},"tipoEvento":{"type":"string","description":"Indica o tipo de evento que teve alteração"},"item":{"type":"string"}}}}}} ``` ## The Email object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Email":{"type":"object","required":["assunto","texto","destinatarios"],"properties":{"assunto":{"type":"string","minLength":1,"maxLength":128,"description":"Conteúdo do texto que deve ser enviado como assunto do email."},"texto":{"type":"string","minLength":1,"maxLength":1024,"description":"Conteúdo do texto que deve ser enviado no corpo do email."},"destinatarios":{"type":"array","items":{"$ref":"#/components/schemas/Destinatarios"}}}},"Destinatarios":{"type":"object","required":["Realizar o envio de email do sistema Consistem ERP para destinatários"],"properties":{"email":{"minLength":1,"maxLength":128,"description":"Email do destinatário","type":"string"}}}}}} ``` ## The Destinatarios object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Destinatarios":{"type":"object","required":["Realizar o envio de email do sistema Consistem ERP para destinatários"],"properties":{"email":{"minLength":1,"maxLength":128,"description":"Email do destinatário","type":"string"}}}}}} ``` ## The ListaEmails object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"ListaEmails":{"type":"object","required":["listaEmail"],"properties":{"listaEmail":{"type":"array","items":{"$ref":"#/components/schemas/Email"}}}},"Email":{"type":"object","required":["assunto","texto","destinatarios"],"properties":{"assunto":{"type":"string","minLength":1,"maxLength":128,"description":"Conteúdo do texto que deve ser enviado como assunto do email."},"texto":{"type":"string","minLength":1,"maxLength":1024,"description":"Conteúdo do texto que deve ser enviado no corpo do email."},"destinatarios":{"type":"array","items":{"$ref":"#/components/schemas/Destinatarios"}}}},"Destinatarios":{"type":"object","required":["Realizar o envio de email do sistema Consistem ERP para destinatários"],"properties":{"email":{"minLength":1,"maxLength":128,"description":"Email do destinatário","type":"string"}}}}}} ``` ## The Notificacao object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Notificacao":{"type":"object","required":["texto","usuarios"],"properties":{"texto":{"type":"string","minLength":1,"maxLength":1024,"description":"Conteúdo do texto que deve ser gerado na notificação."},"usuarios":{"type":"array","items":{"$ref":"#/components/schemas/Usuarios"}}}},"Usuarios":{"type":"object","required":["usuario"],"properties":{"usuario":{"minLength":1,"maxLength":50,"description":"Necessário informar um usuário cadastrado no sistema Consistem ERP.","type":"string"}}}}}} ``` ## The Usuarios object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Usuarios":{"type":"object","required":["usuario"],"properties":{"usuario":{"minLength":1,"maxLength":50,"description":"Necessário informar um usuário cadastrado no sistema Consistem ERP.","type":"string"}}}}}} ``` ## The ListaNotificacoes object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"ListaNotificacoes":{"type":"object","required":["listaNotificacao"],"properties":{"listaNotificacao":{"type":"array","items":{"$ref":"#/components/schemas/Notificacao"}}}},"Notificacao":{"type":"object","required":["texto","usuarios"],"properties":{"texto":{"type":"string","minLength":1,"maxLength":1024,"description":"Conteúdo do texto que deve ser gerado na notificação."},"usuarios":{"type":"array","items":{"$ref":"#/components/schemas/Usuarios"}}}},"Usuarios":{"type":"object","required":["usuario"],"properties":{"usuario":{"minLength":1,"maxLength":50,"description":"Necessário informar um usuário cadastrado no sistema Consistem ERP.","type":"string"}}}}}} ``` ## The EventCloud object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"EventCloud":{"type":"object","required":["method","class"],"properties":{"method":{"type":"string","minLength":1,"maxLength":50,"description":"Método para sincronização."},"class":{"type":"string","minLength":1,"maxLength":50,"description":"Classe para sincronização."},"parameter":{"type":"array","items":{"$ref":"#/components/schemas/Args"}}}},"Args":{"type":"object","required":["method","class"],"properties":{"arg":{"minLength":1,"maxLength":50,"description":"Parâmetro do evento","type":"string"}}}}}} ``` ## The Args object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Args":{"type":"object","required":["method","class"],"properties":{"arg":{"minLength":1,"maxLength":50,"description":"Parâmetro do evento","type":"string"}}}}}} ``` ## The DadosUsuario object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"DadosUsuario":{"type":"object","properties":{"codigo":{"description":"Código do Usuário","type":"integer"},"nome":{"description":"Nome do Usuário","type":"string"},"email":{"description":"E-mail do Usuário","type":"string"},"idiomaPadrao":{"description":"Idioma Padrão do Usuário (0 - Português, 1 - Inglês, 2 - Espanhol, 3 - Alemão, 4 - Italiano, 5 - Francês)","type":"integer"},"usuarioAdmin":{"description":"Usuário é Administrador? (0 - Não, 1 - Sim)","type":"boolean"},"empresaPadrao":{"description":"Código da Empresa Padrão do Usuário","type":"integer"},"rotinaPadrao":{"description":"Rotina Padrão do Usuário","type":"string"},"tipoMenu":{"description":"Tipo de Menu do Usuário (0 - Por Nível, 1 - Por Perfil)","type":"integer"},"empresas":{"description":"Empresas do Usuário","type":"array","items":{"$ref":"#/components/schemas/EmpresasUsuario"}},"areasChave":{"description":"Áreas Chave do Usuário","type":"array","items":{"$ref":"#/components/schemas/AreasChaveUsuario"}},"dispositivos":{"description":"Dispositivos do Usuário","type":"array","items":{"$ref":"#/components/schemas/DispositivosUsuario"}},"dadosCustomizados":{"description":"Dados Customizados","type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"EmpresasUsuario":{"type":"object","properties":{"codigo":{"description":"Código da Empresa","type":"integer"},"nome":{"description":"Nome da Empresa","type":"string"},"fantasia":{"description":"Nome fantasia da Empresa","type":"string"}}},"AreasChaveUsuario":{"type":"object","properties":{"codigoArea":{"description":"Área Chave do Usuário","type":"integer"}}},"DispositivosUsuario":{"type":"object","properties":{"codigoDisp":{"description":"Dispositivo do Usuário","type":"integer"}}},"DadosCustomizados":{"type":"object","properties":{"campo":{"description":"Campo Customizado","type":"integer"}}}}}} ``` ## The EmpresasUsuario object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"EmpresasUsuario":{"type":"object","properties":{"codigo":{"description":"Código da Empresa","type":"integer"},"nome":{"description":"Nome da Empresa","type":"string"},"fantasia":{"description":"Nome fantasia da Empresa","type":"string"}}}}}} ``` ## The AreasChaveUsuario object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"AreasChaveUsuario":{"type":"object","properties":{"codigoArea":{"description":"Área Chave do Usuário","type":"integer"}}}}}} ``` ## The DispositivosUsuario object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"DispositivosUsuario":{"type":"object","properties":{"codigoDisp":{"description":"Dispositivo do Usuário","type":"integer"}}}}}} ``` ## The ConfirmarEvento object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"ConfirmarEvento":{"type":"object","properties":{"codigo":{"description":"Código do Usuário","type":"integer"},"nome":{"description":"Nome do Usuário","type":"string"},"email":{"description":"E-mail do Usuário","type":"string"},"idiomaPadrao":{"description":"Idioma Padrão do Usuário (0 - Português, 1 - Inglês, 2 - Espanhol, 3 - Alemão, 4 - Italiano, 5 - Francês)","type":"integer"},"usuarioAdmin":{"description":"Usuário é Administrador? (0 - Não, 1 - Sim)","type":"boolean"},"empresaPadrao":{"description":"Código da Empresa Padrão do Usuário","type":"integer"},"rotinaPadrao":{"description":"Rotina Padrão do Usuário","type":"string"},"tipoMenu":{"description":"Tipo de Menu do Usuário (0 - Por Nível, 1 - Por Perfil)","type":"integer"},"acessoTerminalWeb":{"description":"Acesso ao Terminal Web (0 - Não, 1 - Sim)","type":"boolean"},"empresas":{"description":"Empresas do Usuário","type":"array","items":{"$ref":"#/components/schemas/EmpresasUsuario"}},"areasChave":{"description":"Áreas Chave do Usuário","type":"array","items":{"$ref":"#/components/schemas/AreasChaveUsuario"}},"dispositivos":{"description":"Dispositivos do Usuário","type":"array","items":{"$ref":"#/components/schemas/DispositivosUsuario"}},"dadosCustomizados":{"description":"Dados Customizados","type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"EmpresasUsuario":{"type":"object","properties":{"codigo":{"description":"Código da Empresa","type":"integer"},"nome":{"description":"Nome da Empresa","type":"string"},"fantasia":{"description":"Nome fantasia da Empresa","type":"string"}}},"AreasChaveUsuario":{"type":"object","properties":{"codigoArea":{"description":"Área Chave do Usuário","type":"integer"}}},"DispositivosUsuario":{"type":"object","properties":{"codigoDisp":{"description":"Dispositivo do Usuário","type":"integer"}}},"DadosCustomizados":{"type":"object","properties":{"campo":{"description":"Campo Customizado","type":"integer"}}}}}} ``` ## The Printer object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Printer":{"type":"object","properties":{"serverName":{"type":"string"},"printerName":{"type":"string"},"type":{"type":"string"},"dateCreated":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"type":"object","properties":{"campo":{"description":"Campo Customizado","type":"integer"}}}}}} ``` ## The Erro object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` ## The WebhookWhatsappPayload object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"WebhookWhatsappPayload":{"type":"object","properties":{"messaging_product":{"type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}}},"Metadata":{"type":"object","properties":{"display_phone_number":{"type":"string"},"phone_number_id":{"type":"string"}}},"Contact":{"type":"object","properties":{"profile":{"$ref":"#/components/schemas/Profile"},"wa_id":{"type":"string"}}},"Profile":{"type":"object","properties":{"name":{"type":"string"}}},"Message":{"type":"object","properties":{"from":{"type":"string"},"id":{"type":"string"},"timestamp":{"type":"string"},"text":{"$ref":"#/components/schemas/Text"},"interactive":{"$ref":"#/components/schemas/Interactive"},"reaction":{"$ref":"#/components/schemas/Reaction"},"location":{"$ref":"#/components/schemas/Location"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/MessageContact"}},"button":{"$ref":"#/components/schemas/Button"},"type":{"type":"string"}}},"Text":{"type":"object","properties":{"body":{"type":"string"}}},"Interactive":{"type":"object","properties":{"list_reply":{"$ref":"#/components/schemas/ListReply"},"button_reply":{"$ref":"#/components/schemas/ButtonReply"},"type":{"type":"string"}}},"ListReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}},"ButtonReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}}},"Reaction":{"type":"object","properties":{"message_id":{"type":"string"},"emoji":{"type":"string"}}},"Location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"address":{"type":"string"}}},"MessageContact":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"birthday":{"type":"string"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailWhatsapp"}},"name":{"$ref":"#/components/schemas/Name"},"org":{"$ref":"#/components/schemas/Org"},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"urls":{"type":"array","items":{"$ref":"#/components/schemas/Url"}}}},"Address":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"},"type":{"type":"string"}}},"EmailWhatsapp":{"type":"object","properties":{"email":{"type":"string"},"type":{"type":"string"}}},"Name":{"type":"object","properties":{"formatted_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"middle_name":{"type":"string"},"suffix":{"type":"string"},"prefix":{"type":"string"}}},"Org":{"type":"object","properties":{"company":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"}}},"Phone":{"type":"object","properties":{"phone":{"type":"string"},"wa_id":{"type":"string"},"type":{"type":"string"}}},"Url":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}},"Button":{"type":"object","properties":{"text":{"type":"string"},"payload":{"type":"string"}}}}}} ``` ## The Metadata object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Metadata":{"type":"object","properties":{"display_phone_number":{"type":"string"},"phone_number_id":{"type":"string"}}}}}} ``` ## The Contact object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Contact":{"type":"object","properties":{"profile":{"$ref":"#/components/schemas/Profile"},"wa_id":{"type":"string"}}},"Profile":{"type":"object","properties":{"name":{"type":"string"}}}}}} ``` ## The Profile object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Profile":{"type":"object","properties":{"name":{"type":"string"}}}}}} ``` ## The Message object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Message":{"type":"object","properties":{"from":{"type":"string"},"id":{"type":"string"},"timestamp":{"type":"string"},"text":{"$ref":"#/components/schemas/Text"},"interactive":{"$ref":"#/components/schemas/Interactive"},"reaction":{"$ref":"#/components/schemas/Reaction"},"location":{"$ref":"#/components/schemas/Location"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/MessageContact"}},"button":{"$ref":"#/components/schemas/Button"},"type":{"type":"string"}}},"Text":{"type":"object","properties":{"body":{"type":"string"}}},"Interactive":{"type":"object","properties":{"list_reply":{"$ref":"#/components/schemas/ListReply"},"button_reply":{"$ref":"#/components/schemas/ButtonReply"},"type":{"type":"string"}}},"ListReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}},"ButtonReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}}},"Reaction":{"type":"object","properties":{"message_id":{"type":"string"},"emoji":{"type":"string"}}},"Location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"address":{"type":"string"}}},"MessageContact":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"birthday":{"type":"string"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailWhatsapp"}},"name":{"$ref":"#/components/schemas/Name"},"org":{"$ref":"#/components/schemas/Org"},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"urls":{"type":"array","items":{"$ref":"#/components/schemas/Url"}}}},"Address":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"},"type":{"type":"string"}}},"EmailWhatsapp":{"type":"object","properties":{"email":{"type":"string"},"type":{"type":"string"}}},"Name":{"type":"object","properties":{"formatted_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"middle_name":{"type":"string"},"suffix":{"type":"string"},"prefix":{"type":"string"}}},"Org":{"type":"object","properties":{"company":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"}}},"Phone":{"type":"object","properties":{"phone":{"type":"string"},"wa_id":{"type":"string"},"type":{"type":"string"}}},"Url":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}},"Button":{"type":"object","properties":{"text":{"type":"string"},"payload":{"type":"string"}}}}}} ``` ## The Text object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Text":{"type":"object","properties":{"body":{"type":"string"}}}}}} ``` ## The Interactive object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Interactive":{"type":"object","properties":{"list_reply":{"$ref":"#/components/schemas/ListReply"},"button_reply":{"$ref":"#/components/schemas/ButtonReply"},"type":{"type":"string"}}},"ListReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}},"ButtonReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}}}}}} ``` ## The ListReply object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"ListReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}}}}} ``` ## The ButtonReply object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"ButtonReply":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}}}}}} ``` ## The Reaction object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Reaction":{"type":"object","properties":{"message_id":{"type":"string"},"emoji":{"type":"string"}}}}}} ``` ## The Location object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"address":{"type":"string"}}}}}} ``` ## The MessageContact object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"MessageContact":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"birthday":{"type":"string"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailWhatsapp"}},"name":{"$ref":"#/components/schemas/Name"},"org":{"$ref":"#/components/schemas/Org"},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"urls":{"type":"array","items":{"$ref":"#/components/schemas/Url"}}}},"Address":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"},"type":{"type":"string"}}},"EmailWhatsapp":{"type":"object","properties":{"email":{"type":"string"},"type":{"type":"string"}}},"Name":{"type":"object","properties":{"formatted_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"middle_name":{"type":"string"},"suffix":{"type":"string"},"prefix":{"type":"string"}}},"Org":{"type":"object","properties":{"company":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"}}},"Phone":{"type":"object","properties":{"phone":{"type":"string"},"wa_id":{"type":"string"},"type":{"type":"string"}}},"Url":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The Address object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Address":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The EmailWhatsapp object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"EmailWhatsapp":{"type":"object","properties":{"email":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The Name object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Name":{"type":"object","properties":{"formatted_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"middle_name":{"type":"string"},"suffix":{"type":"string"},"prefix":{"type":"string"}}}}}} ``` ## The Org object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Org":{"type":"object","properties":{"company":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"}}}}}} ``` ## The Phone object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Phone":{"type":"object","properties":{"phone":{"type":"string"},"wa_id":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The Url object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Url":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The Button object ```json {"openapi":"3.1.1","info":{"title":"Componentes","version":"1.0"},"components":{"schemas":{"Button":{"type":"object","properties":{"text":{"type":"string"},"payload":{"type":"string"}}}}}} ``` # Custos # Custos v1.0 # Centro De Custo centroCusto ## GET /centroCusto > Obter Lista Centros Custo ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Centro de Custo","description":"centroCusto"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaCentrosCusto":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CentroCusto"}}}},"CentroCusto":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"descCentroCusto":{"type":"string","description":"Descrição do Centro de Custo"},"codSituacao":{"type":"integer","description":"Situação (0 - Inativo, 1 - Ativo)","enum":[0,1]},"descSituacao":{"type":"string","description":"Descrição da Situação"},"codTipo":{"type":"integer","description":"Tipo (1 - Comum, 2 - Auxiliar, 3 - Produtivo, 4 - Administrativo, 5 - Diferido)","enum":[1,2,3,4,5]},"descTipo":{"type":"string","description":"Descrição do Tipo"},"codArea":{"type":"integer","description":"Código da Área"},"descArea":{"type":"string","description":"Descrição da Área"},"codUnidadeCalculo":{"type":"integer","description":"Unidade de Cálculo (1 - Horas Homem, 2 - Horas Máquina, 3 - Quantidade Peças)","enum":[1,2,3]},"descUnidadeCalculo":{"type":"string","description":"Descrição da Unidade de Cálculo"},"codNatureza":{"type":"integer","description":"Natureza (1 - Normal, 2 - Agrupador, 3 - Recebedor)","enum":[1,2,3]},"descNatureza":{"type":"string","description":"Descrição da Natureza"},"codCentroCustoAgrupador":{"type":"string","description":"Código do Centro de Custo Agrupador"},"mesAno":{"type":"string","description":"Mês/Ano"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/centroCusto":{"get":{"tags":["Centro de Custo"],"summary":"Obter Lista Centros Custo","operationId":"ObterCentrosCusto","parameters":[{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"empresa","in":"query","description":"Lista de Empresas","required":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"centroCusto","in":"query","description":"Lista de Centros de Custo","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"situacao","in":"query","description":"Situação do Centro de Custo (0 - Inativo, 1 - Ativo)","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"tipo","in":"query","description":"Tipo do Centro de Custo (1 - Comum, 2 - Auxiliar, 3 - Produtivo, 4 - Administrativo, 5 - Diferido)","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"unidadeCalculo","in":"query","description":"Unidade de Cálculo do Centro de Custo (1 - Horas Homem, 2 - Horas Máquina, 3 - Quantidade Peças)","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"natureza","in":"query","description":"Natureza do Centro de Custo (1 - Normal, 2 - Agrupador, 3 - Recebedor)","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"paginacao","in":"query","description":"Quantidade de itens na paginação de retorno","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListaCentrosCusto"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /centroCusto/{id} > Obter Centro Custo ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Centro de Custo","description":"centroCusto"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"CentroCusto":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"descCentroCusto":{"type":"string","description":"Descrição do Centro de Custo"},"codSituacao":{"type":"integer","description":"Situação (0 - Inativo, 1 - Ativo)","enum":[0,1]},"descSituacao":{"type":"string","description":"Descrição da Situação"},"codTipo":{"type":"integer","description":"Tipo (1 - Comum, 2 - Auxiliar, 3 - Produtivo, 4 - Administrativo, 5 - Diferido)","enum":[1,2,3,4,5]},"descTipo":{"type":"string","description":"Descrição do Tipo"},"codArea":{"type":"integer","description":"Código da Área"},"descArea":{"type":"string","description":"Descrição da Área"},"codUnidadeCalculo":{"type":"integer","description":"Unidade de Cálculo (1 - Horas Homem, 2 - Horas Máquina, 3 - Quantidade Peças)","enum":[1,2,3]},"descUnidadeCalculo":{"type":"string","description":"Descrição da Unidade de Cálculo"},"codNatureza":{"type":"integer","description":"Natureza (1 - Normal, 2 - Agrupador, 3 - Recebedor)","enum":[1,2,3]},"descNatureza":{"type":"string","description":"Descrição da Natureza"},"codCentroCustoAgrupador":{"type":"string","description":"Código do Centro de Custo Agrupador"},"mesAno":{"type":"string","description":"Mês/Ano"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/centroCusto/{id}":{"get":{"tags":["Centro de Custo"],"summary":"Obter Centro Custo","operationId":"ObterCentroCusto","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","description":"Código do Centro de Custo","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CentroCusto"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Mark Up markup ## GET /indiceMarkup > Obter Lista de Índices de Mark-up ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Mark-Up","description":"markup"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaIndicesMarkup":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"indicesMarkup":{"type":"array","items":{"$ref":"#/components/schemas/IndiceMarkup"}}}},"IndiceMarkup":{"type":"object","properties":{"codIndice":{"type":"integer","description":"Código do Índice de Mark-Up"},"descIndice":{"type":"string","description":"Descrição do Índice de Mark-Up"},"tipoIndice":{"type":"string","description":"Tipo do Índice de Mark-Up (1 - Fixo, 2 - Variável)","enum":[1,2]},"naturezaIndice":{"type":"string","description":"Natureza do Índice de Mark-Up (1 - Impostos, 2 - Custo Variável de Venda, 3 - Despesas Operacionais)","enum":[1,2,3]}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/indiceMarkup":{"get":{"tags":["Mark-Up"],"summary":"Obter Lista de Índices de Mark-up","operationId":"ObterIndicesMarkup","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"integer"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListaIndicesMarkup"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /indiceMarkup > Cadastrar/Atualizar um Índice de Mark-Up ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Mark-Up","description":"markup"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"IndiceMarkupPut":{"type":"object","properties":{"codIndice":{"maximum":9999,"type":"integer","description":"Código do Índice de Mark-Up"},"descIndice":{"maxLength":20,"type":"string","description":"Descrição do Índice de Mark-Up"},"tipoIndice":{"type":"integer","description":"Tipo do Índice de Mark-Up (1 - Fixo, 2 - Variável)","enum":[1,2]},"naturezaIndice":{"type":"integer","description":"Natureza do Índice de Mark-Up (1 - Impostos, 2 - Custo Variável de Venda, 3 - Despesas Operacionais)","enum":[1,2,3]}}},"IndiceMarkup":{"type":"object","properties":{"codIndice":{"type":"integer","description":"Código do Índice de Mark-Up"},"descIndice":{"type":"string","description":"Descrição do Índice de Mark-Up"},"tipoIndice":{"type":"string","description":"Tipo do Índice de Mark-Up (1 - Fixo, 2 - Variável)","enum":[1,2]},"naturezaIndice":{"type":"string","description":"Natureza do Índice de Mark-Up (1 - Impostos, 2 - Custo Variável de Venda, 3 - Despesas Operacionais)","enum":[1,2,3]}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/indiceMarkup":{"put":{"tags":["Mark-Up"],"summary":"Cadastrar/Atualizar um Índice de Mark-Up","operationId":"CadastrarIndiceMarkup","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Índice de Mark-Up","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndiceMarkupPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndiceMarkup"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaMarkup > Obter Lista de Tabelas de Mark-up ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Mark-Up","description":"markup"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTabelasMarkup":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"tabelasMarkup":{"type":"array","items":{"$ref":"#/components/schemas/ListaTabelaMarkup"}}}},"ListaTabelaMarkup":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Mark-Up"},"descTabela":{"type":"string","description":"Descrição da Tabela de Mark-Up"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaMarkup":{"get":{"tags":["Mark-Up"],"summary":"Obter Lista de Tabelas de Mark-up","operationId":"ObterTabelasMarkup","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"integer"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListaTabelasMarkup"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /tabelaMarkup > Cadastrar/Atualizar uma Tabela de Mark-Up ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Mark-Up","description":"markup"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabelaMarkupPut":{"type":"object","properties":{"codTabela":{"maximum":9999,"type":"integer","description":"Código da Tabela de Mark-Up"},"descTabela":{"maxLength":35,"type":"string","description":"Descrição da Tabela de Mark-Up"},"indicesMarkup":{"type":"array","items":{"$ref":"#/components/schemas/IndicesTabelaMarkupPut"}}}},"IndicesTabelaMarkupPut":{"type":"object","properties":{"codIndice":{"maximum":9999,"type":"integer","description":"Código do Índice de Mark-Up"},"percentual":{"multipleOf":0.01,"type":"number","description":"Percentual de Mark-Up"}}},"TabelaMarkup":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Mark-Up"},"descTabela":{"type":"string","description":"Descrição da Tabela de Mark-Up"},"indicesMarkup":{"type":"array","items":{"$ref":"#/components/schemas/ListaIndicesTabelaMarkup"}}}},"ListaIndicesTabelaMarkup":{"type":"object","properties":{"codIndice":{"type":"integer","description":"Código do Índice de Mark-Up"},"percentual":{"multipleOf":0.01,"type":"number","description":"Percentual de Mark-Up"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaMarkup":{"put":{"tags":["Mark-Up"],"summary":"Cadastrar/Atualizar uma Tabela de Mark-Up","operationId":"CadastrarTabelasMarkup","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da Tabela de Mark-Up","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaMarkupPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TabelaMarkup"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaMarkup/{id} > Obter Tabela de Mark-Up ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Mark-Up","description":"markup"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabelaMarkup":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Mark-Up"},"descTabela":{"type":"string","description":"Descrição da Tabela de Mark-Up"},"indicesMarkup":{"type":"array","items":{"$ref":"#/components/schemas/ListaIndicesTabelaMarkup"}}}},"ListaIndicesTabelaMarkup":{"type":"object","properties":{"codIndice":{"type":"integer","description":"Código do Índice de Mark-Up"},"percentual":{"multipleOf":0.01,"type":"number","description":"Percentual de Mark-Up"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaMarkup/{id}":{"get":{"tags":["Mark-Up"],"summary":"Obter Tabela de Mark-Up","operationId":"ObterTabelaMarkup","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","description":"Código da Tabela de Mark-Up","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TabelaMarkup"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Custos Básico custosBasico ## GET /tabelasValorizacaoInsumos > Obter Lista de Tabelas de Valorização de Insumos ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Custos Básico","description":"custosBasico"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabsValorizacaoInsumos":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"tabelasValInsumos":{"type":"array","items":{"$ref":"#/components/schemas/TabelaValInsumo"}}}},"TabelaValInsumo":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Valorização de Insumos"},"descTabela":{"type":"string","description":"Descrição da Tabela de Valorização de Insumos"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelasValorizacaoInsumos":{"get":{"tags":["Custos Básico"],"summary":"Obter Lista de Tabelas de Valorização de Insumos","operationId":"ObterTabsValorizacaoInsumos","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa no ERP Consistem","required":true,"schema":{"type":"integer"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","description":"Lista de Tabelas de Valorização de Insumos","items":{"$ref":"#/components/schemas/TabsValorizacaoInsumos"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaValorizacaoInsumos/{codTabela} > Obter Tabela Valorização de Insumos ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Custos Básico","description":"custosBasico"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"TabValorizacaoInsumos":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Valorização de Insumos"},"descTabela":{"type":"string","description":"Descrição da Tabela de Valorização de Insumos"},"insumos":{"type":"array","items":{"$ref":"#/components/schemas/InsumoTabValorizacao"}}}},"InsumoTabValorizacao":{"type":"object","properties":{"codReduzido":{"type":"string","description":"Código do Interno ERP-Consistem (Código Reduzido)"},"codMaterial":{"type":"string","description":"Código do Material/Insumo"},"valorLancado":{"multipleOf":0.0001,"type":"number","description":"Valor Lançado"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaValorizacaoInsumos/{codTabela}":{"get":{"tags":["Custos Básico"],"summary":"Obter Tabela Valorização de Insumos","operationId":"ObterTabValorizacaoInsumos","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"integer"}},{"name":"codTabela","in":"path","description":"Código da Tabela de Valorização de Insumos","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","description":"Tabela de Valorização de Insumos","items":{"$ref":"#/components/schemas/TabValorizacaoInsumos"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /tabelaValorizacaoInsumos/{codTabela},{codMaterial} > Obtém o Valor de Custo Lançado de um Material/Insumo em determinada Tabela de Valorização ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Custos Básico","description":"custosBasico"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"InsumoTabValorizacaoLanc":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Valorização de Insumos"},"codReduzido":{"type":"string","description":"Código do Interno ERP-Consistem (Código Reduzido)"},"codMaterial":{"type":"string","description":"Código do Material/Insumo"},"valorLancado":{"multipleOf":0.0001,"type":"number","description":"Valor Lançado"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/tabelaValorizacaoInsumos/{codTabela},{codMaterial}":{"get":{"tags":["Custos Básico"],"summary":"Obtém o Valor de Custo Lançado de um Material/Insumo em determinada Tabela de Valorização","operationId":"ObterValLancMaterialTabValInsu","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"codTabela","in":"path","description":"Código da Tabela de Valorização de Insumos","required":true,"schema":{"type":"string"}},{"name":"codMaterial","in":"path","description":"Código do Material/Insumo","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Valor Tabela Lançado do Insumo","items":{"$ref":"#/components/schemas/InsumoTabValorizacaoLanc"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Custos Projeção Têxtil custosProjecaoTextil ## GET /custoMalhaTinto/{anoMes},{codProjecao} > Obtém o Custo de Malha Tinto ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"tags":[{"name":"Custos Projeção Têxtil","description":"custosProjecaoTextil"}],"servers":[{"url":"https://localhost/custos/v10"},{"url":"http://localhost/custos/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"CustoMalhaTintoProjecao":{"type":"object","properties":{"anoMes":{"type":"string","description":"Ano/Mês da Projeção Têxtil (AAAA/MM)"},"codProjecao":{"type":"integer","description":"Código da Projeção Têxtil"},"codCatalogo":{"type":"integer","description":"Código do Catálogo"},"dataHoraProjecao":{"type":"string","description":"Data e Hora da Geração da Projeção Têxtil"},"tecidos":{"type":"array","items":{"$ref":"#/components/schemas/TecidosCor"}}}},"TecidosCor":{"type":"object","properties":{"codReduzido":{"type":"integer","description":"Código do Interno ERP-Consistem (Código Reduzido)"},"codTecido":{"type":"integer","description":"Código do Tecido"},"codCor":{"type":"string","description":"Código da Cor"},"codGrupoCor":{"type":"string","description":"Código do Grupo de Cor"},"unidadeMedida":{"type":"string","description":"Unidade de Medida"},"custoTecidoCor":{"multipleOf":0.0001,"type":"number","description":"Custo do Tecido/Cor"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/custoMalhaTinto/{anoMes},{codProjecao}":{"get":{"tags":["Custos Projeção Têxtil"],"summary":"Obtém o Custo de Malha Tinto","operationId":"ObterCustoMalhaTintoProjecao","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"anoMes","in":"path","description":"Mês/Ano da Projeção Têxtil (AAAAMM)","required":true,"schema":{"type":"string"}},{"name":"codProjecao","in":"path","description":"Código da Projeção Têxtil","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Lista Projeção de Custo de Malha Tinto","items":{"$ref":"#/components/schemas/CustoMalhaTintoProjecao"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The CentroCusto object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"CentroCusto":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"descCentroCusto":{"type":"string","description":"Descrição do Centro de Custo"},"codSituacao":{"type":"integer","description":"Situação (0 - Inativo, 1 - Ativo)","enum":[0,1]},"descSituacao":{"type":"string","description":"Descrição da Situação"},"codTipo":{"type":"integer","description":"Tipo (1 - Comum, 2 - Auxiliar, 3 - Produtivo, 4 - Administrativo, 5 - Diferido)","enum":[1,2,3,4,5]},"descTipo":{"type":"string","description":"Descrição do Tipo"},"codArea":{"type":"integer","description":"Código da Área"},"descArea":{"type":"string","description":"Descrição da Área"},"codUnidadeCalculo":{"type":"integer","description":"Unidade de Cálculo (1 - Horas Homem, 2 - Horas Máquina, 3 - Quantidade Peças)","enum":[1,2,3]},"descUnidadeCalculo":{"type":"string","description":"Descrição da Unidade de Cálculo"},"codNatureza":{"type":"integer","description":"Natureza (1 - Normal, 2 - Agrupador, 3 - Recebedor)","enum":[1,2,3]},"descNatureza":{"type":"string","description":"Descrição da Natureza"},"codCentroCustoAgrupador":{"type":"string","description":"Código do Centro de Custo Agrupador"},"mesAno":{"type":"string","description":"Mês/Ano"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaCentrosCusto object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"ListaCentrosCusto":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CentroCusto"}}}},"CentroCusto":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa"},"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"descCentroCusto":{"type":"string","description":"Descrição do Centro de Custo"},"codSituacao":{"type":"integer","description":"Situação (0 - Inativo, 1 - Ativo)","enum":[0,1]},"descSituacao":{"type":"string","description":"Descrição da Situação"},"codTipo":{"type":"integer","description":"Tipo (1 - Comum, 2 - Auxiliar, 3 - Produtivo, 4 - Administrativo, 5 - Diferido)","enum":[1,2,3,4,5]},"descTipo":{"type":"string","description":"Descrição do Tipo"},"codArea":{"type":"integer","description":"Código da Área"},"descArea":{"type":"string","description":"Descrição da Área"},"codUnidadeCalculo":{"type":"integer","description":"Unidade de Cálculo (1 - Horas Homem, 2 - Horas Máquina, 3 - Quantidade Peças)","enum":[1,2,3]},"descUnidadeCalculo":{"type":"string","description":"Descrição da Unidade de Cálculo"},"codNatureza":{"type":"integer","description":"Natureza (1 - Normal, 2 - Agrupador, 3 - Recebedor)","enum":[1,2,3]},"descNatureza":{"type":"string","description":"Descrição da Natureza"},"codCentroCustoAgrupador":{"type":"string","description":"Código do Centro de Custo Agrupador"},"mesAno":{"type":"string","description":"Mês/Ano"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaIndicesMarkup object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"ListaIndicesMarkup":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"indicesMarkup":{"type":"array","items":{"$ref":"#/components/schemas/IndiceMarkup"}}}},"IndiceMarkup":{"type":"object","properties":{"codIndice":{"type":"integer","description":"Código do Índice de Mark-Up"},"descIndice":{"type":"string","description":"Descrição do Índice de Mark-Up"},"tipoIndice":{"type":"string","description":"Tipo do Índice de Mark-Up (1 - Fixo, 2 - Variável)","enum":[1,2]},"naturezaIndice":{"type":"string","description":"Natureza do Índice de Mark-Up (1 - Impostos, 2 - Custo Variável de Venda, 3 - Despesas Operacionais)","enum":[1,2,3]}}}}}} ``` ## The IndiceMarkup object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"IndiceMarkup":{"type":"object","properties":{"codIndice":{"type":"integer","description":"Código do Índice de Mark-Up"},"descIndice":{"type":"string","description":"Descrição do Índice de Mark-Up"},"tipoIndice":{"type":"string","description":"Tipo do Índice de Mark-Up (1 - Fixo, 2 - Variável)","enum":[1,2]},"naturezaIndice":{"type":"string","description":"Natureza do Índice de Mark-Up (1 - Impostos, 2 - Custo Variável de Venda, 3 - Despesas Operacionais)","enum":[1,2,3]}}}}}} ``` ## The IndiceMarkupPut object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"IndiceMarkupPut":{"type":"object","properties":{"codIndice":{"maximum":9999,"type":"integer","description":"Código do Índice de Mark-Up"},"descIndice":{"maxLength":20,"type":"string","description":"Descrição do Índice de Mark-Up"},"tipoIndice":{"type":"integer","description":"Tipo do Índice de Mark-Up (1 - Fixo, 2 - Variável)","enum":[1,2]},"naturezaIndice":{"type":"integer","description":"Natureza do Índice de Mark-Up (1 - Impostos, 2 - Custo Variável de Venda, 3 - Despesas Operacionais)","enum":[1,2,3]}}}}}} ``` ## The ListaTabelasMarkup object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"ListaTabelasMarkup":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"tabelasMarkup":{"type":"array","items":{"$ref":"#/components/schemas/ListaTabelaMarkup"}}}},"ListaTabelaMarkup":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Mark-Up"},"descTabela":{"type":"string","description":"Descrição da Tabela de Mark-Up"}}}}}} ``` ## The ListaTabelaMarkup object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"ListaTabelaMarkup":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Mark-Up"},"descTabela":{"type":"string","description":"Descrição da Tabela de Mark-Up"}}}}}} ``` ## The TabelaMarkup object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"TabelaMarkup":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Mark-Up"},"descTabela":{"type":"string","description":"Descrição da Tabela de Mark-Up"},"indicesMarkup":{"type":"array","items":{"$ref":"#/components/schemas/ListaIndicesTabelaMarkup"}}}},"ListaIndicesTabelaMarkup":{"type":"object","properties":{"codIndice":{"type":"integer","description":"Código do Índice de Mark-Up"},"percentual":{"multipleOf":0.01,"type":"number","description":"Percentual de Mark-Up"}}}}}} ``` ## The ListaIndicesTabelaMarkup object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"ListaIndicesTabelaMarkup":{"type":"object","properties":{"codIndice":{"type":"integer","description":"Código do Índice de Mark-Up"},"percentual":{"multipleOf":0.01,"type":"number","description":"Percentual de Mark-Up"}}}}}} ``` ## The TabelaMarkupPut object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"TabelaMarkupPut":{"type":"object","properties":{"codTabela":{"maximum":9999,"type":"integer","description":"Código da Tabela de Mark-Up"},"descTabela":{"maxLength":35,"type":"string","description":"Descrição da Tabela de Mark-Up"},"indicesMarkup":{"type":"array","items":{"$ref":"#/components/schemas/IndicesTabelaMarkupPut"}}}},"IndicesTabelaMarkupPut":{"type":"object","properties":{"codIndice":{"maximum":9999,"type":"integer","description":"Código do Índice de Mark-Up"},"percentual":{"multipleOf":0.01,"type":"number","description":"Percentual de Mark-Up"}}}}}} ``` ## The IndicesTabelaMarkupPut object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"IndicesTabelaMarkupPut":{"type":"object","properties":{"codIndice":{"maximum":9999,"type":"integer","description":"Código do Índice de Mark-Up"},"percentual":{"multipleOf":0.01,"type":"number","description":"Percentual de Mark-Up"}}}}}} ``` ## The TabsValorizacaoInsumos object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"TabsValorizacaoInsumos":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"tabelasValInsumos":{"type":"array","items":{"$ref":"#/components/schemas/TabelaValInsumo"}}}},"TabelaValInsumo":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Valorização de Insumos"},"descTabela":{"type":"string","description":"Descrição da Tabela de Valorização de Insumos"}}}}}} ``` ## The TabelaValInsumo object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"TabelaValInsumo":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Valorização de Insumos"},"descTabela":{"type":"string","description":"Descrição da Tabela de Valorização de Insumos"}}}}}} ``` ## The TabValorizacaoInsumos object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"TabValorizacaoInsumos":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Valorização de Insumos"},"descTabela":{"type":"string","description":"Descrição da Tabela de Valorização de Insumos"},"insumos":{"type":"array","items":{"$ref":"#/components/schemas/InsumoTabValorizacao"}}}},"InsumoTabValorizacao":{"type":"object","properties":{"codReduzido":{"type":"string","description":"Código do Interno ERP-Consistem (Código Reduzido)"},"codMaterial":{"type":"string","description":"Código do Material/Insumo"},"valorLancado":{"multipleOf":0.0001,"type":"number","description":"Valor Lançado"}}}}}} ``` ## The InsumoTabValorizacao object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"InsumoTabValorizacao":{"type":"object","properties":{"codReduzido":{"type":"string","description":"Código do Interno ERP-Consistem (Código Reduzido)"},"codMaterial":{"type":"string","description":"Código do Material/Insumo"},"valorLancado":{"multipleOf":0.0001,"type":"number","description":"Valor Lançado"}}}}}} ``` ## The InsumoTabValorizacaoLanc object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"InsumoTabValorizacaoLanc":{"type":"object","properties":{"codTabela":{"type":"integer","description":"Código da Tabela de Valorização de Insumos"},"codReduzido":{"type":"string","description":"Código do Interno ERP-Consistem (Código Reduzido)"},"codMaterial":{"type":"string","description":"Código do Material/Insumo"},"valorLancado":{"multipleOf":0.0001,"type":"number","description":"Valor Lançado"}}}}}} ``` ## The CustoMalhaTintoProjecao object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"CustoMalhaTintoProjecao":{"type":"object","properties":{"anoMes":{"type":"string","description":"Ano/Mês da Projeção Têxtil (AAAA/MM)"},"codProjecao":{"type":"integer","description":"Código da Projeção Têxtil"},"codCatalogo":{"type":"integer","description":"Código do Catálogo"},"dataHoraProjecao":{"type":"string","description":"Data e Hora da Geração da Projeção Têxtil"},"tecidos":{"type":"array","items":{"$ref":"#/components/schemas/TecidosCor"}}}},"TecidosCor":{"type":"object","properties":{"codReduzido":{"type":"integer","description":"Código do Interno ERP-Consistem (Código Reduzido)"},"codTecido":{"type":"integer","description":"Código do Tecido"},"codCor":{"type":"string","description":"Código da Cor"},"codGrupoCor":{"type":"string","description":"Código do Grupo de Cor"},"unidadeMedida":{"type":"string","description":"Unidade de Medida"},"custoTecidoCor":{"multipleOf":0.0001,"type":"number","description":"Custo do Tecido/Cor"}}}}}} ``` ## The TecidosCor object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"TecidosCor":{"type":"object","properties":{"codReduzido":{"type":"integer","description":"Código do Interno ERP-Consistem (Código Reduzido)"},"codTecido":{"type":"integer","description":"Código do Tecido"},"codCor":{"type":"string","description":"Código da Cor"},"codGrupoCor":{"type":"string","description":"Código do Grupo de Cor"},"unidadeMedida":{"type":"string","description":"Unidade de Medida"},"custoTecidoCor":{"multipleOf":0.0001,"type":"number","description":"Custo do Tecido/Cor"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Custos","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Contábil/Fiscal # Contábil/Fiscal v1.0 # Escrita Fiscal escritaFiscal ## GET /listaTributos > Obter Lista de Tributos ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"tags":[{"name":"Escrita Fiscal","description":"escritaFiscal"}],"servers":[{"url":"https://localhost/contabilfiscal/v10"},{"url":"http://localhost/contabilfiscal/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTributos":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Tributo"}}}},"Tributo":{"type":"object","properties":{"seqTributo":{"type":"integer","description":"Sequência do Tributo"},"descTributo":{"type":"string","description":"Descrição do Tributo"},"sitTibuto":{"type":"integer","description":"Situação do Tributo (0 - Inativo, 1 - Ativ0)","enum":[0,1]},"codTributo":{"type":"number","description":"Código do Tributo (0 - Nenhum, 1 - ISS (Retenção), 2 - IRRF (Retenção), 3 - INSS (Retenção), 4 - PIS/PASEP (Retenção), 5 - COFINS (Retenção), 6 - CSRF (Retenção), 7 - CSLL (Retenção), 8 - FUNRURAL (Retenção), 9 - ICMS (Retenção))","enum":[0,1,2,3,4,5,6,7,8,9]},"codReceita":{"type":"integer","description":"Código da retenção do tributo"},"fatoGerador":{"type":"number","description":"Código do Tributo (1 - Emissão, 2 - Entrada, 3 - Liquidação, 4 - Constituição do Crédito)","enum":[1,2,3,4]},"aliquota":{"multipleOf":0.01,"type":"number","description":"Alíquota do Tributo"},"codNatRend":{"type":"integer","description":"Código da Natureza Rendimento"},"vlrMinRetencao":{"multipleOf":0.01,"type":"number","description":"Valor Mínimo de Retenção"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/listaTributos":{"get":{"tags":["Escrita Fiscal"],"summary":"Obter Lista de Tributos","operationId":"ObterListaTributos","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTributos"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Movimento Contábil movimentoContabil ## GET /movimentoContabil > Obter Listagem de Movimento Contabil ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"tags":[{"name":"Movimento Contábil","description":"movimentoContabil"}],"servers":[{"url":"https://localhost/contabilfiscal/v10"},{"url":"http://localhost/contabilfiscal/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaMovimentoContabil":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MovimentoContabil"}}}},"MovimentoContabil":{"type":"object","properties":{"dataMovimento":{"type":"string","description":"Data do Movimento Contabil (YYYY-MM-DD)","format":"date"},"lancamento":{"type":"array","items":{"$ref":"#/components/schemas/Lancamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Lancamento":{"type":"object","properties":{"historico":{"maxLength":99999,"type":"string","description":"Histórico do Lançamento do Movimento Contabil"},"contaMovimentoContabil":{"type":"array","description":"Conta do Movimento Contabil","items":{"$ref":"#/components/schemas/ContaMovimentoContabil"}}}},"ContaMovimentoContabil":{"required":["codConta","tipo","valorConta"],"type":"object","properties":{"codConta":{"type":"string","description":"Código da Conta"},"valorConta":{"multipleOf":0.01,"type":"number","description":"Valor da Conta"},"tipo":{"type":"string","description":"Tipo da Conta (D - Débito, C - Crédito)","enum":["D","C"]},"centroCustoMovimentoContabil":{"type":"array","description":"Centro de Custo da Conta","items":{"$ref":"#/components/schemas/CentroCustoMovimentoContabil"}}}},"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/movimentoContabil":{"get":{"tags":["Movimento Contábil"],"summary":"Obter Listagem de Movimento Contabil","operationId":"ObterMovimentosContabeis","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaMovimentoContabil"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /movimentoContabil > Cadastrar Movimento Contábil ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"tags":[{"name":"Movimento Contábil","description":"movimentoContabil"}],"servers":[{"url":"https://localhost/contabilfiscal/v10"},{"url":"http://localhost/contabilfiscal/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"MovimentoContabilPut":{"required":["dataMovimento","lancamento"],"type":"object","properties":{"dataMovimento":{"type":"string","description":"Data do Movimento Contabil (YYYY-MM-DD)","format":"date"},"lancamento":{"type":"array","description":"Lançamento do Movimento Contabil","items":{"$ref":"#/components/schemas/Lancamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Lancamento":{"type":"object","properties":{"historico":{"maxLength":99999,"type":"string","description":"Histórico do Lançamento do Movimento Contabil"},"contaMovimentoContabil":{"type":"array","description":"Conta do Movimento Contabil","items":{"$ref":"#/components/schemas/ContaMovimentoContabil"}}}},"ContaMovimentoContabil":{"required":["codConta","tipo","valorConta"],"type":"object","properties":{"codConta":{"type":"string","description":"Código da Conta"},"valorConta":{"multipleOf":0.01,"type":"number","description":"Valor da Conta"},"tipo":{"type":"string","description":"Tipo da Conta (D - Débito, C - Crédito)","enum":["D","C"]},"centroCustoMovimentoContabil":{"type":"array","description":"Centro de Custo da Conta","items":{"$ref":"#/components/schemas/CentroCustoMovimentoContabil"}}}},"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/movimentoContabil":{"put":{"tags":["Movimento Contábil"],"summary":"Cadastrar Movimento Contábil","operationId":"CadastrarMovimentoContabil","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Movimento Contábil","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MovimentoContabilPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /movimentoContabil/{id} > Obter Movimento Contábil ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"tags":[{"name":"Movimento Contábil","description":"movimentoContabil"}],"servers":[{"url":"https://localhost/contabilfiscal/v10"},{"url":"http://localhost/contabilfiscal/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"MovimentoContabil":{"type":"object","properties":{"dataMovimento":{"type":"string","description":"Data do Movimento Contabil (YYYY-MM-DD)","format":"date"},"lancamento":{"type":"array","items":{"$ref":"#/components/schemas/Lancamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Lancamento":{"type":"object","properties":{"historico":{"maxLength":99999,"type":"string","description":"Histórico do Lançamento do Movimento Contabil"},"contaMovimentoContabil":{"type":"array","description":"Conta do Movimento Contabil","items":{"$ref":"#/components/schemas/ContaMovimentoContabil"}}}},"ContaMovimentoContabil":{"required":["codConta","tipo","valorConta"],"type":"object","properties":{"codConta":{"type":"string","description":"Código da Conta"},"valorConta":{"multipleOf":0.01,"type":"number","description":"Valor da Conta"},"tipo":{"type":"string","description":"Tipo da Conta (D - Débito, C - Crédito)","enum":["D","C"]},"centroCustoMovimentoContabil":{"type":"array","description":"Centro de Custo da Conta","items":{"$ref":"#/components/schemas/CentroCustoMovimentoContabil"}}}},"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/movimentoContabil/{id}":{"get":{"tags":["Movimento Contábil"],"summary":"Obter Movimento Contábil","operationId":"ObterMovimentoContabil","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Data do Movimento Contábil (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MovimentoContabil"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /movimentoContabil/{id} > Alterar Movimento Contábil ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"tags":[{"name":"Movimento Contábil","description":"movimentoContabil"}],"servers":[{"url":"https://localhost/contabilfiscal/v10"},{"url":"http://localhost/contabilfiscal/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"MovimentoContabilPut":{"required":["dataMovimento","lancamento"],"type":"object","properties":{"dataMovimento":{"type":"string","description":"Data do Movimento Contabil (YYYY-MM-DD)","format":"date"},"lancamento":{"type":"array","description":"Lançamento do Movimento Contabil","items":{"$ref":"#/components/schemas/Lancamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Lancamento":{"type":"object","properties":{"historico":{"maxLength":99999,"type":"string","description":"Histórico do Lançamento do Movimento Contabil"},"contaMovimentoContabil":{"type":"array","description":"Conta do Movimento Contabil","items":{"$ref":"#/components/schemas/ContaMovimentoContabil"}}}},"ContaMovimentoContabil":{"required":["codConta","tipo","valorConta"],"type":"object","properties":{"codConta":{"type":"string","description":"Código da Conta"},"valorConta":{"multipleOf":0.01,"type":"number","description":"Valor da Conta"},"tipo":{"type":"string","description":"Tipo da Conta (D - Débito, C - Crédito)","enum":["D","C"]},"centroCustoMovimentoContabil":{"type":"array","description":"Centro de Custo da Conta","items":{"$ref":"#/components/schemas/CentroCustoMovimentoContabil"}}}},"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"MovimentoContabil":{"type":"object","properties":{"dataMovimento":{"type":"string","description":"Data do Movimento Contabil (YYYY-MM-DD)","format":"date"},"lancamento":{"type":"array","items":{"$ref":"#/components/schemas/Lancamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/movimentoContabil/{id}":{"put":{"tags":["Movimento Contábil"],"summary":"Alterar Movimento Contábil","operationId":"AlterarMovimentoContabil","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Data do Movimento Contábil (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}}],"requestBody":{"description":"Dados do Movimento Contábil","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MovimentoContabilPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MovimentoContabil"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /movimentoContabil/{id} > Exclui Movimento Contábil ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"tags":[{"name":"Movimento Contábil","description":"movimentoContabil"}],"servers":[{"url":"https://localhost/contabilfiscal/v10"},{"url":"http://localhost/contabilfiscal/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/movimentoContabil/{id}":{"delete":{"tags":["Movimento Contábil"],"summary":"Exclui Movimento Contábil","operationId":"ExcluirMovimentoContabil","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Data do Movimento Contábil (YYYY-MM-DD)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` # Models ## The ListaTributos object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"ListaTributos":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Tributo"}}}},"Tributo":{"type":"object","properties":{"seqTributo":{"type":"integer","description":"Sequência do Tributo"},"descTributo":{"type":"string","description":"Descrição do Tributo"},"sitTibuto":{"type":"integer","description":"Situação do Tributo (0 - Inativo, 1 - Ativ0)","enum":[0,1]},"codTributo":{"type":"number","description":"Código do Tributo (0 - Nenhum, 1 - ISS (Retenção), 2 - IRRF (Retenção), 3 - INSS (Retenção), 4 - PIS/PASEP (Retenção), 5 - COFINS (Retenção), 6 - CSRF (Retenção), 7 - CSLL (Retenção), 8 - FUNRURAL (Retenção), 9 - ICMS (Retenção))","enum":[0,1,2,3,4,5,6,7,8,9]},"codReceita":{"type":"integer","description":"Código da retenção do tributo"},"fatoGerador":{"type":"number","description":"Código do Tributo (1 - Emissão, 2 - Entrada, 3 - Liquidação, 4 - Constituição do Crédito)","enum":[1,2,3,4]},"aliquota":{"multipleOf":0.01,"type":"number","description":"Alíquota do Tributo"},"codNatRend":{"type":"integer","description":"Código da Natureza Rendimento"},"vlrMinRetencao":{"multipleOf":0.01,"type":"number","description":"Valor Mínimo de Retenção"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Tributo object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"Tributo":{"type":"object","properties":{"seqTributo":{"type":"integer","description":"Sequência do Tributo"},"descTributo":{"type":"string","description":"Descrição do Tributo"},"sitTibuto":{"type":"integer","description":"Situação do Tributo (0 - Inativo, 1 - Ativ0)","enum":[0,1]},"codTributo":{"type":"number","description":"Código do Tributo (0 - Nenhum, 1 - ISS (Retenção), 2 - IRRF (Retenção), 3 - INSS (Retenção), 4 - PIS/PASEP (Retenção), 5 - COFINS (Retenção), 6 - CSRF (Retenção), 7 - CSLL (Retenção), 8 - FUNRURAL (Retenção), 9 - ICMS (Retenção))","enum":[0,1,2,3,4,5,6,7,8,9]},"codReceita":{"type":"integer","description":"Código da retenção do tributo"},"fatoGerador":{"type":"number","description":"Código do Tributo (1 - Emissão, 2 - Entrada, 3 - Liquidação, 4 - Constituição do Crédito)","enum":[1,2,3,4]},"aliquota":{"multipleOf":0.01,"type":"number","description":"Alíquota do Tributo"},"codNatRend":{"type":"integer","description":"Código da Natureza Rendimento"},"vlrMinRetencao":{"multipleOf":0.01,"type":"number","description":"Valor Mínimo de Retenção"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The MovimentoContabil object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"MovimentoContabil":{"type":"object","properties":{"dataMovimento":{"type":"string","description":"Data do Movimento Contabil (YYYY-MM-DD)","format":"date"},"lancamento":{"type":"array","items":{"$ref":"#/components/schemas/Lancamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Lancamento":{"type":"object","properties":{"historico":{"maxLength":99999,"type":"string","description":"Histórico do Lançamento do Movimento Contabil"},"contaMovimentoContabil":{"type":"array","description":"Conta do Movimento Contabil","items":{"$ref":"#/components/schemas/ContaMovimentoContabil"}}}},"ContaMovimentoContabil":{"required":["codConta","tipo","valorConta"],"type":"object","properties":{"codConta":{"type":"string","description":"Código da Conta"},"valorConta":{"multipleOf":0.01,"type":"number","description":"Valor da Conta"},"tipo":{"type":"string","description":"Tipo da Conta (D - Débito, C - Crédito)","enum":["D","C"]},"centroCustoMovimentoContabil":{"type":"array","description":"Centro de Custo da Conta","items":{"$ref":"#/components/schemas/CentroCustoMovimentoContabil"}}}},"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaMovimentoContabil object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"ListaMovimentoContabil":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MovimentoContabil"}}}},"MovimentoContabil":{"type":"object","properties":{"dataMovimento":{"type":"string","description":"Data do Movimento Contabil (YYYY-MM-DD)","format":"date"},"lancamento":{"type":"array","items":{"$ref":"#/components/schemas/Lancamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Lancamento":{"type":"object","properties":{"historico":{"maxLength":99999,"type":"string","description":"Histórico do Lançamento do Movimento Contabil"},"contaMovimentoContabil":{"type":"array","description":"Conta do Movimento Contabil","items":{"$ref":"#/components/schemas/ContaMovimentoContabil"}}}},"ContaMovimentoContabil":{"required":["codConta","tipo","valorConta"],"type":"object","properties":{"codConta":{"type":"string","description":"Código da Conta"},"valorConta":{"multipleOf":0.01,"type":"number","description":"Valor da Conta"},"tipo":{"type":"string","description":"Tipo da Conta (D - Débito, C - Crédito)","enum":["D","C"]},"centroCustoMovimentoContabil":{"type":"array","description":"Centro de Custo da Conta","items":{"$ref":"#/components/schemas/CentroCustoMovimentoContabil"}}}},"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The MovimentoContabilPut object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"MovimentoContabilPut":{"required":["dataMovimento","lancamento"],"type":"object","properties":{"dataMovimento":{"type":"string","description":"Data do Movimento Contabil (YYYY-MM-DD)","format":"date"},"lancamento":{"type":"array","description":"Lançamento do Movimento Contabil","items":{"$ref":"#/components/schemas/Lancamento"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Lancamento":{"type":"object","properties":{"historico":{"maxLength":99999,"type":"string","description":"Histórico do Lançamento do Movimento Contabil"},"contaMovimentoContabil":{"type":"array","description":"Conta do Movimento Contabil","items":{"$ref":"#/components/schemas/ContaMovimentoContabil"}}}},"ContaMovimentoContabil":{"required":["codConta","tipo","valorConta"],"type":"object","properties":{"codConta":{"type":"string","description":"Código da Conta"},"valorConta":{"multipleOf":0.01,"type":"number","description":"Valor da Conta"},"tipo":{"type":"string","description":"Tipo da Conta (D - Débito, C - Crédito)","enum":["D","C"]},"centroCustoMovimentoContabil":{"type":"array","description":"Centro de Custo da Conta","items":{"$ref":"#/components/schemas/CentroCustoMovimentoContabil"}}}},"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Lancamento object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"Lancamento":{"type":"object","properties":{"historico":{"maxLength":99999,"type":"string","description":"Histórico do Lançamento do Movimento Contabil"},"contaMovimentoContabil":{"type":"array","description":"Conta do Movimento Contabil","items":{"$ref":"#/components/schemas/ContaMovimentoContabil"}}}},"ContaMovimentoContabil":{"required":["codConta","tipo","valorConta"],"type":"object","properties":{"codConta":{"type":"string","description":"Código da Conta"},"valorConta":{"multipleOf":0.01,"type":"number","description":"Valor da Conta"},"tipo":{"type":"string","description":"Tipo da Conta (D - Débito, C - Crédito)","enum":["D","C"]},"centroCustoMovimentoContabil":{"type":"array","description":"Centro de Custo da Conta","items":{"$ref":"#/components/schemas/CentroCustoMovimentoContabil"}}}},"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}}}}} ``` ## The ContaMovimentoContabil object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"ContaMovimentoContabil":{"required":["codConta","tipo","valorConta"],"type":"object","properties":{"codConta":{"type":"string","description":"Código da Conta"},"valorConta":{"multipleOf":0.01,"type":"number","description":"Valor da Conta"},"tipo":{"type":"string","description":"Tipo da Conta (D - Débito, C - Crédito)","enum":["D","C"]},"centroCustoMovimentoContabil":{"type":"array","description":"Centro de Custo da Conta","items":{"$ref":"#/components/schemas/CentroCustoMovimentoContabil"}}}},"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}}}}} ``` ## The CentroCustoMovimentoContabil object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"CentroCustoMovimentoContabil":{"required":["codCentroCusto","valorCentroCusto"],"type":"object","properties":{"codCentroCusto":{"type":"string","description":"Código do Centro de Custo"},"valorCentroCusto":{"multipleOf":0.01,"type":"number","description":"Valor do Centro de Custo"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Contabil/Fiscal","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` # Entradas # Cadastros Itens v1.0 # Unidade De Medida unidadeMedida ## GET /unidadeMedida > Obter Listagem de Unidades de Medida ```json {"openapi":"3.0.1","info":{"title":"Cadastros Itens","version":"1.0"},"tags":[{"name":"Unidade de Medida","description":"unidadeMedida"}],"servers":[{"url":"https://localhost/itens/v10"},{"url":"http://localhost/itens/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaUnidadeMedida":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UnidadeMedida"}}}},"UnidadeMedida":{"type":"object","properties":{"id":{"type":"string","description":"Código da Unidade de Medida"},"descricao":{"type":"string","description":"Descrição da Unidade de Medida"},"ibge":{"type":"string","description":"Código IBGE"},"formatoUndMed":{"type":"integer","description":"Código do Formato da Unidade de Medida"},"formatoUndMedDesc":{"type":"string","description":"Descrição do Formato da Unidade de Medida"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/unidadeMedida":{"get":{"tags":["Unidade de Medida"],"summary":"Obter Listagem de Unidades de Medida","operationId":"ObterUnidadesMedida","parameters":[{"name":"empresa","in":"header","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaUnidadeMedida"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /unidadeMedida/{id} > Obter uma Unidade de Medida ```json {"openapi":"3.0.1","info":{"title":"Cadastros Itens","version":"1.0"},"tags":[{"name":"Unidade de Medida","description":"unidadeMedida"}],"servers":[{"url":"https://localhost/itens/v10"},{"url":"http://localhost/itens/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"UnidadeMedida":{"type":"object","properties":{"id":{"type":"string","description":"Código da Unidade de Medida"},"descricao":{"type":"string","description":"Descrição da Unidade de Medida"},"ibge":{"type":"string","description":"Código IBGE"},"formatoUndMed":{"type":"integer","description":"Código do Formato da Unidade de Medida"},"formatoUndMedDesc":{"type":"string","description":"Descrição do Formato da Unidade de Medida"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/unidadeMedida/{id}":{"get":{"tags":["Unidade de Medida"],"summary":"Obter uma Unidade de Medida","operationId":"ObterUnidadeMedida","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Unidade de Medida","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnidadeMedida"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /unidadeMedida/{id} > Cadastrar/Atualizar uma Unidade de Medida ```json {"openapi":"3.0.1","info":{"title":"Cadastros Itens","version":"1.0"},"tags":[{"name":"Unidade de Medida","description":"unidadeMedida"}],"servers":[{"url":"https://localhost/itens/v10"},{"url":"http://localhost/itens/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"UnidadeMedidaPut":{"required":["descricao"],"type":"object","properties":{"descricao":{"maxLength":15,"type":"string","description":"Descrição da Unidade de Medida"},"ibge":{"maxLength":6,"type":"string","description":"Código IBGE"},"formatoUndMed":{"type":"integer","description":"Código do Formato da Unidade de Medida (0 - Valor em Decimal, 1 - Valor Inteiro)","enum":[0,1]},"flagReplicado":{"type":"boolean","description":"Flag Replicado"}}},"UnidadeMedida":{"type":"object","properties":{"id":{"type":"string","description":"Código da Unidade de Medida"},"descricao":{"type":"string","description":"Descrição da Unidade de Medida"},"ibge":{"type":"string","description":"Código IBGE"},"formatoUndMed":{"type":"integer","description":"Código do Formato da Unidade de Medida"},"formatoUndMedDesc":{"type":"string","description":"Descrição do Formato da Unidade de Medida"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/unidadeMedida/{id}":{"put":{"tags":["Unidade de Medida"],"summary":"Cadastrar/Atualizar uma Unidade de Medida","operationId":"CadastrarUnidadeMedida","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Unidade de Medida","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados da Unidade de Medida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnidadeMedidaPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnidadeMedida"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /unidadeMedida/{id} > Excluir uma Unidade de Medida ```json {"openapi":"3.0.1","info":{"title":"Cadastros Itens","version":"1.0"},"tags":[{"name":"Unidade de Medida","description":"unidadeMedida"}],"servers":[{"url":"https://localhost/itens/v10"},{"url":"http://localhost/itens/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/unidadeMedida/{id}":{"delete":{"tags":["Unidade de Medida"],"summary":"Excluir uma Unidade de Medida","operationId":"ExcluirUnidadeMedida","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Unidade de Medida","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` --- [Next Page](/llms-full.txt/1)