> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/entradas/compras-v1.0/models.md). # Models ## The ListaPerfisSolCompra object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ListaPerfisSolCompra":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PerfilSolCompra"}}}},"PerfilSolCompra":{"type":"object","properties":{"codPerfilSolicitante":{"type":"integer","description":"Código do Perfil do Solicitante"},"descPerfilSolicitante":{"type":"string","description":"Descrição"}}}}}} ``` ## The PerfilSolCompra object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"PerfilSolCompra":{"type":"object","properties":{"codPerfilSolicitante":{"type":"integer","description":"Código do Perfil do Solicitante"},"descPerfilSolicitante":{"type":"string","description":"Descrição"}}}}}} ``` ## The ListaFinalidadesSolCompraPedido object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ListaFinalidadesSolCompraPedido":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FinalidadeSolCompraPedido"}}}},"FinalidadeSolCompraPedido":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Finalidade"},"descricao":{"type":"string","description":"Descrição"}}}}}} ``` ## The FinalidadeSolCompraPedido object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"FinalidadeSolCompraPedido":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Finalidade"},"descricao":{"type":"string","description":"Descrição"}}}}}} ``` ## The ListaOpcoesUrgenciaSolCompraPedido object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ListaOpcoesUrgenciaSolCompraPedido":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/opcaoUrgenciaSolCompraPedido"}}}},"opcaoUrgenciaSolCompraPedido":{"type":"object","properties":{"codUrgencia":{"type":"integer","description":"Código da Urgência"},"descUrgencia":{"type":"string","description":"Descrição"},"prioridade":{"type":"integer","description":"Prioridade"},"codSituacao":{"type":"integer","description":"Situação da Opção de Urgência (0 - Inativa, 1 - Ativa)","enum":[0,1]}}}}}} ``` ## The opcaoUrgenciaSolCompraPedido object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"opcaoUrgenciaSolCompraPedido":{"type":"object","properties":{"codUrgencia":{"type":"integer","description":"Código da Urgência"},"descUrgencia":{"type":"string","description":"Descrição"},"prioridade":{"type":"integer","description":"Prioridade"},"codSituacao":{"type":"integer","description":"Situação da Opção de Urgência (0 - Inativa, 1 - Ativa)","enum":[0,1]}}}}}} ``` ## The PedidoCompra object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"PedidoCompra":{"type":"object","properties":{"codPedido":{"type":"integer","description":"Código do Pedido de Compra"},"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"condicaoFrete":{"type":"integer","description":"Código da Condição de Frete"},"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"},"percDespesaFinanceira":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesa Financeira"},"valorDespesaFinanceira":{"multipleOf":0.01,"type":"number","description":"Valor de Despesa Financeira"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"valorPedido":{"multipleOf":0.01,"type":"number","description":"Valor do Pedido"},"dataRecebimento":{"type":"string","description":"Data de Recebimento (YYYY-MM-DD)","format":"date"},"situacaoPedido":{"type":"integer","description":"Situação (0 - Aberto, 1 - Atendido, 2 - Atendido parte, 3 - Cancelado)","enum":[0,1,2,3]},"observacao":{"maxLength":160,"type":"string","description":"Observação"},"situacaoQtoEntrada":{"type":"integer","description":"Situação Quanto a Entrada"},"tipoDescontoEspecial":{"type":"integer","description":"Tipo do Desconto Especial (0 - Em dias, 1 - Em data específica)","enum":[0,1]},"valorDespesaAcessoria":{"multipleOf":0.01,"type":"number","description":"Valor de Despesa Acessória"},"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]},"codPedidoComplementar":{"type":"integer","description":"Código do Pedido Complementar"},"codMensagemPadrao":{"type":"integer","description":"Código da Mensagem Padrão"},"codPortador":{"type":"integer","description":"Código do Portador"},"situacaoImpresso":{"type":"boolean","description":"Situação da Impressão (0 - Não Impresso, 1 - Impresso)","enum":[0,1]},"condicaoPagamentoEspecial":{"type":"integer","description":"Código da Primeira Condição de Pagamento Especial"},"condicaoPagamentoEspecial1":{"type":"integer","description":"Código da Segunda Condição de Pagamento Especial"},"condicaoPagamentoEspecial2":{"type":"integer","description":"Código da Terceira Condição de Pagamento Especial"},"condicaoPagamentoEspecial3":{"type":"integer","description":"Código da Quarta Condição de Pagamento Especial"},"condicaoPagamentoEspecial4":{"type":"integer","description":"Código da Quinta Condição de Pagamento Especial"},"pedidoBloqueado":{"type":"boolean","description":"Pedido esta Bloqueado? (0 - Não, 1 - Sim)"},"motivoCancelamento":{"maxLength":105,"type":"string","description":"Motivo Descritivo do Cancelamento do Pedido"},"dataHoraCancelamento":{"type":"string","description":"Data e Hora do Cancelamento do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"operadorCancelamento":{"maxLength":30,"type":"string","description":"Operador do Cancelamento do Pedido"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"mascaraComprador":{"type":"integer","description":"Código da Máscara do Comprador"},"flagPedido":{"type":"integer","description":"Flag do Pedido 1 - Liberado, 2 - Liberado com Restrição, 3 - Cancelado","enum":[1,2,3]},"pedidoAutomatico":{"type":"boolean","description":"Pedido Automático? (0 - Não, 1 - Sim)"},"pedidoIntegracao":{"maxLength":30,"type":"string","description":"Número do Pedido Importado de Outros Sistemas para Integração com o Sistema Consistem"},"numControle":{"maxLength":10,"type":"string","description":"Número do Controle"},"finalidade":{"type":"integer","description":"Código da Finalidade"},"codMoedaEstrangeira":{"type":"integer","description":"Código da Moeda Estrangeira"},"dataCotacao":{"type":"string","description":"Data da Cotação (YYYY-MM-DD)","format":"date"},"valorPedidoMoedaEstrangeira":{"multipleOf":0.001,"type":"number","description":"Valor do Pedido em Moeda Estrangeira"},"valorDespFinanceiraMoedaEstrang":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Financeiras em Moeda Estrangeira"},"valorDespAcessoriaMoedaEstrange":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias em Moeda Estrangeira"},"valorFreteMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Frete em Moeda Estrangeira"},"valorDescontoMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto em Moeda Estrangeira"},"pedidoGrade":{"type":"boolean","description":"Pedido por Grade (0 - Não, 1 - Sim)"},"rotinaGeradoraPedido":{"type":"string","description":"Rotina Geradora do Pedido"},"situacaoAceitePortal":{"type":"integer","description":"Situação do Aceite no Portal (1 - Gerado, 2 - Em Aceite, 3 - Aceito, 4 - Não Aceito)","enum":[1,2,3,4]},"codCotacao":{"type":"integer","description":"Código da Cotação"},"dataLimite":{"type":"string","description":"Data Limite para Aceite do Pedido (YYYY-MM-DD)","format":"date"},"motivoLiberacao":{"maxLength":160,"type":"string","description":"Motivo da Liberação"},"valorCotacaoMoeda":{"multipleOf":0.01,"type":"number","description":"Valor da Cotação da Moeda"},"situacaoBloqueio":{"type":"integer","description":"Situação do Bloqueio (0 - Liberado, 1 - Bloqueado, 2 - Digitado, 3- Retornado)","enum":[0,1,2,3]},"opcaoTipoFrete":{"maxLength":10,"type":"string","description":"Opção de Tipo de Frete"},"dataPrevisaoInicial":{"type":"string","description":"Data de Previsão de Entrega Inicial (YYYY-MM-DD)","format":"date"},"dataPrevisaoAtual":{"type":"string","description":"Data de Previsão de Entrega Atual (YYYY-MM-DD)","format":"date"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"valorFixoFrete":{"multipleOf":0.01,"type":"number","description":"Valor Fixo do Frete a ser Somado no Valor do Pedido"},"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"},"percDesconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual de Desconto"},"valorDesconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Valor de Desconto"},"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"},"dataHoraSituacao":{"type":"string","description":"Data e Hora da Atualização da Situação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraBloqueio":{"type":"string","description":"Data e Hora do Bloqueio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraLiberacao":{"type":"string","description":"Data e Hora da Liberação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraEnvio":{"type":"string","description":"Data e Hora do Envio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraAceite":{"type":"string","description":"Data e Hora do Aceite do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"situacaoAceite":{"type":"integer","description":"Situação do Aceite do Pedido (0 - Não Enviado, 1 - Enviado, 2 - Aceito, 3 - Rejeitado)","enum":[0,1,2,3]},"codUsuario":{"type":"integer","description":"Código do Usuário"},"nomeContato":{"maxLength":30,"type":"string","description":"Nome do Contato"},"telefoneContato":{"maxLength":18,"type":"string","description":"Telefone do Contato"},"emailContato":{"maxLength":50,"type":"string","description":"E-mail do Contato"},"emailCopiaContato":{"maxLength":50,"type":"string","description":"E-mail para Cópia do Contato"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompra"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"itemPedidoCompra":{"type":"object","properties":{"percAliquotaICMS":{"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"codPedido":{"type":"integer","description":"Código do Pedido"},"itemPedido":{"type":"integer","description":"Sequência do Item do Pedido"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"qtdeAtendida":{"multipleOf":0.001,"type":"number","description":"Quantidade Atentida do Produto"},"qtdeCancelada":{"multipleOf":0.001,"type":"number","description":"Quantidade Cancelada do Produto"},"qtdeSaldo":{"multipleOf":0.001,"type":"number","description":"Quantidade de Saldo do Produto"},"valorDesconto":{"multipleOf":0.0001,"type":"number","description":"Valor do Desconto"},"situacao":{"type":"integer","description":"Situação do Item do Pedido (0 - Em Aberto, 1 - Atendido, 2 - Atendido Parte, 3 - Cancelado)","enum":[0,1,2,3]},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário do Produto"},"percIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de IPI do Produto"},"percDesconto":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Desconto do Produto"},"loteProducao":{"maxLength":6,"type":"string","description":"Lote de Produção"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"maxLength":25,"type":"string","description":"Centro de Custo para Uso do Produto"},"solicCompras":{"type":"integer","description":"Código da Solicitação de Compra"},"itemSolicCompras":{"maximum":99,"type":"integer","description":"Sequência do Item da Solicitação de Compra"},"itemDespesa":{"maximum":999,"type":"integer","description":"Código do Item de Despesa"},"itemIntegracao":{"maxLength":30,"type":"string","description":"Número do Item do Pedido Importado de Outros Sistemas"},"ultSeqAtendida":{"maximum":99,"type":"integer","description":"Última Sequência Atendida"},"unidadeMedida":{"maxLength":3,"type":"string","description":"Unidade de Medida do Produto"},"composicaoIPI":{"type":"string","description":"Composição do IPI (Despesas Acessórias;Descontos;Despesas Financeiras)"},"impressoComunicacao":{"type":"boolean","description":"Já Impresso para Comunicação de Atraso ao Fornecedor? (0 - Não, 1 - Sim)"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete (Somente existe quando frete FOB)"},"valorFreteMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Frete para Moeda Estrangeira"},"dataLimiteEntrega":{"type":"string","description":"Data Limite de Entrada do Produto (YYYY-MM-DD)","format":"date"},"pedidoFornecedor":{"type":"string","description":"Pedido do Fornecedor"},"referenciaFornecedor":{"type":"string","description":"Referência do Fornecedor"},"dataEntregaOriginal":{"type":"string","description":"Data de Entrega Original (YYYY-MM-DD)","format":"date"},"codFinalidade":{"type":"integer","description":"Código da Finalidade"},"codOS":{"type":"integer","description":"Número da Ordem de Serviço"},"precoUnitarioMoedaEstrangeira":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário para Moeda Estrangeira"},"contaContabil":{"type":"string","description":"Código da Conta Contábil"},"contaContabilC":{"type":"string","description":"Código da Conta contábil para Itens sem Código"},"numControle":{"maxLength":10,"type":"string","description":"Número do Controle"},"dataHoraCancelamentoItem":{"type":"string","description":"Data e Hora do Cancelamento do Item (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"motivoCancelamentoItem":{"maxLength":35,"type":"string","description":"Motivo do Cancelamento do Item"},"operadorCancelamentoItem":{"maxLength":30,"type":"string","description":"Operador do Cancelamento do Item"},"codUnidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"fatorConversaoCompra":{"maxLength":10,"minLength":1,"type":"string","description":"Fator de Conversão da Unidade de Medida para Compra [Deprecated]"},"fatorConversaoQuantidade":{"multipleOf":0.000001,"type":"number","description":"Quantidade Fator de Conversão da Unidade de Medida de Compra"},"fatorConversaoOperador":{"type":"integer","description":"Operador Fator de Conversão da Unidade de Medida de Compra (0 - Multiplicação / 1 - Divisão)","enum":[0,1]},"baseCalculoICMSST":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do ICMS ST"},"aliquotaICMSST":{"multipleOf":0.01,"type":"number","description":"Aliquota do ICMS ST"},"valorICMSST":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS ST"},"percDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Percentual do Diferencial da Aliquota"},"valorDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Valor do Diferencial da Aliquota"},"descricaoProduto":{"maxLength":150,"type":"string","description":"Descrição do Produto"},"rateioCentrosDeCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"codFamilia":{"type":"integer","description":"Código da Família do Produto"},"codSubFamilia":{"type":"integer","description":"Código da Subfamilia do Produto"},"codContrato":{"type":"integer","description":"Código do Contrato"},"seqProdutoContrato":{"type":"integer","description":"Sequência do Produto no Contrato"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"seqEnvioCotacao":{"type":"integer","description":"Sequência de Envio da Cotação"},"seqFornecedorCotacao":{"type":"integer","description":"Sequência do Fornecedor da Cotação"},"seqProdutoCotacao":{"type":"integer","description":"Sequência do Produto da Cotação"},"dataHoraSituacaoItem":{"type":"string","description":"Data e Hora da Atualização da Situação do Item do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataPrevisaoInicial":{"type":"string","description":"Data de Previsão Inicial (YYYY-MM-DD)","format":"date"},"percAliquotaPIS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do COFINS"},"valorUnitarioICMSST":{"multipleOf":0.01,"type":"number","description":"Valor Unitário ICMS ST"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}},"itensPedidoContaContabilCentrosCustosRateio":{"type":"array","description":"Conta(s) Contabil(eis) para Rateio","items":{"$ref":"#/components/schemas/RateioContaContabil"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}}}}} ``` ## The itemPedidoCompra object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"itemPedidoCompra":{"type":"object","properties":{"percAliquotaICMS":{"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"codPedido":{"type":"integer","description":"Código do Pedido"},"itemPedido":{"type":"integer","description":"Sequência do Item do Pedido"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"qtdeAtendida":{"multipleOf":0.001,"type":"number","description":"Quantidade Atentida do Produto"},"qtdeCancelada":{"multipleOf":0.001,"type":"number","description":"Quantidade Cancelada do Produto"},"qtdeSaldo":{"multipleOf":0.001,"type":"number","description":"Quantidade de Saldo do Produto"},"valorDesconto":{"multipleOf":0.0001,"type":"number","description":"Valor do Desconto"},"situacao":{"type":"integer","description":"Situação do Item do Pedido (0 - Em Aberto, 1 - Atendido, 2 - Atendido Parte, 3 - Cancelado)","enum":[0,1,2,3]},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário do Produto"},"percIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de IPI do Produto"},"percDesconto":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Desconto do Produto"},"loteProducao":{"maxLength":6,"type":"string","description":"Lote de Produção"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"maxLength":25,"type":"string","description":"Centro de Custo para Uso do Produto"},"solicCompras":{"type":"integer","description":"Código da Solicitação de Compra"},"itemSolicCompras":{"maximum":99,"type":"integer","description":"Sequência do Item da Solicitação de Compra"},"itemDespesa":{"maximum":999,"type":"integer","description":"Código do Item de Despesa"},"itemIntegracao":{"maxLength":30,"type":"string","description":"Número do Item do Pedido Importado de Outros Sistemas"},"ultSeqAtendida":{"maximum":99,"type":"integer","description":"Última Sequência Atendida"},"unidadeMedida":{"maxLength":3,"type":"string","description":"Unidade de Medida do Produto"},"composicaoIPI":{"type":"string","description":"Composição do IPI (Despesas Acessórias;Descontos;Despesas Financeiras)"},"impressoComunicacao":{"type":"boolean","description":"Já Impresso para Comunicação de Atraso ao Fornecedor? (0 - Não, 1 - Sim)"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete (Somente existe quando frete FOB)"},"valorFreteMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Frete para Moeda Estrangeira"},"dataLimiteEntrega":{"type":"string","description":"Data Limite de Entrada do Produto (YYYY-MM-DD)","format":"date"},"pedidoFornecedor":{"type":"string","description":"Pedido do Fornecedor"},"referenciaFornecedor":{"type":"string","description":"Referência do Fornecedor"},"dataEntregaOriginal":{"type":"string","description":"Data de Entrega Original (YYYY-MM-DD)","format":"date"},"codFinalidade":{"type":"integer","description":"Código da Finalidade"},"codOS":{"type":"integer","description":"Número da Ordem de Serviço"},"precoUnitarioMoedaEstrangeira":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário para Moeda Estrangeira"},"contaContabil":{"type":"string","description":"Código da Conta Contábil"},"contaContabilC":{"type":"string","description":"Código da Conta contábil para Itens sem Código"},"numControle":{"maxLength":10,"type":"string","description":"Número do Controle"},"dataHoraCancelamentoItem":{"type":"string","description":"Data e Hora do Cancelamento do Item (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"motivoCancelamentoItem":{"maxLength":35,"type":"string","description":"Motivo do Cancelamento do Item"},"operadorCancelamentoItem":{"maxLength":30,"type":"string","description":"Operador do Cancelamento do Item"},"codUnidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"fatorConversaoCompra":{"maxLength":10,"minLength":1,"type":"string","description":"Fator de Conversão da Unidade de Medida para Compra [Deprecated]"},"fatorConversaoQuantidade":{"multipleOf":0.000001,"type":"number","description":"Quantidade Fator de Conversão da Unidade de Medida de Compra"},"fatorConversaoOperador":{"type":"integer","description":"Operador Fator de Conversão da Unidade de Medida de Compra (0 - Multiplicação / 1 - Divisão)","enum":[0,1]},"baseCalculoICMSST":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do ICMS ST"},"aliquotaICMSST":{"multipleOf":0.01,"type":"number","description":"Aliquota do ICMS ST"},"valorICMSST":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS ST"},"percDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Percentual do Diferencial da Aliquota"},"valorDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Valor do Diferencial da Aliquota"},"descricaoProduto":{"maxLength":150,"type":"string","description":"Descrição do Produto"},"rateioCentrosDeCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"codFamilia":{"type":"integer","description":"Código da Família do Produto"},"codSubFamilia":{"type":"integer","description":"Código da Subfamilia do Produto"},"codContrato":{"type":"integer","description":"Código do Contrato"},"seqProdutoContrato":{"type":"integer","description":"Sequência do Produto no Contrato"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"seqEnvioCotacao":{"type":"integer","description":"Sequência de Envio da Cotação"},"seqFornecedorCotacao":{"type":"integer","description":"Sequência do Fornecedor da Cotação"},"seqProdutoCotacao":{"type":"integer","description":"Sequência do Produto da Cotação"},"dataHoraSituacaoItem":{"type":"string","description":"Data e Hora da Atualização da Situação do Item do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataPrevisaoInicial":{"type":"string","description":"Data de Previsão Inicial (YYYY-MM-DD)","format":"date"},"percAliquotaPIS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do COFINS"},"valorUnitarioICMSST":{"multipleOf":0.01,"type":"number","description":"Valor Unitário ICMS ST"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}},"itensPedidoContaContabilCentrosCustosRateio":{"type":"array","description":"Conta(s) Contabil(eis) para Rateio","items":{"$ref":"#/components/schemas/RateioContaContabil"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}}}}} ``` ## The ListaPedidoCompra object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ListaPedidoCompra":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","description":"Dados do pedido de compra","items":{"$ref":"#/components/schemas/PedidoCompra"}}}},"PedidoCompra":{"type":"object","properties":{"codPedido":{"type":"integer","description":"Código do Pedido de Compra"},"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"condicaoFrete":{"type":"integer","description":"Código da Condição de Frete"},"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"},"percDespesaFinanceira":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesa Financeira"},"valorDespesaFinanceira":{"multipleOf":0.01,"type":"number","description":"Valor de Despesa Financeira"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"valorPedido":{"multipleOf":0.01,"type":"number","description":"Valor do Pedido"},"dataRecebimento":{"type":"string","description":"Data de Recebimento (YYYY-MM-DD)","format":"date"},"situacaoPedido":{"type":"integer","description":"Situação (0 - Aberto, 1 - Atendido, 2 - Atendido parte, 3 - Cancelado)","enum":[0,1,2,3]},"observacao":{"maxLength":160,"type":"string","description":"Observação"},"situacaoQtoEntrada":{"type":"integer","description":"Situação Quanto a Entrada"},"tipoDescontoEspecial":{"type":"integer","description":"Tipo do Desconto Especial (0 - Em dias, 1 - Em data específica)","enum":[0,1]},"valorDespesaAcessoria":{"multipleOf":0.01,"type":"number","description":"Valor de Despesa Acessória"},"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]},"codPedidoComplementar":{"type":"integer","description":"Código do Pedido Complementar"},"codMensagemPadrao":{"type":"integer","description":"Código da Mensagem Padrão"},"codPortador":{"type":"integer","description":"Código do Portador"},"situacaoImpresso":{"type":"boolean","description":"Situação da Impressão (0 - Não Impresso, 1 - Impresso)","enum":[0,1]},"condicaoPagamentoEspecial":{"type":"integer","description":"Código da Primeira Condição de Pagamento Especial"},"condicaoPagamentoEspecial1":{"type":"integer","description":"Código da Segunda Condição de Pagamento Especial"},"condicaoPagamentoEspecial2":{"type":"integer","description":"Código da Terceira Condição de Pagamento Especial"},"condicaoPagamentoEspecial3":{"type":"integer","description":"Código da Quarta Condição de Pagamento Especial"},"condicaoPagamentoEspecial4":{"type":"integer","description":"Código da Quinta Condição de Pagamento Especial"},"pedidoBloqueado":{"type":"boolean","description":"Pedido esta Bloqueado? (0 - Não, 1 - Sim)"},"motivoCancelamento":{"maxLength":105,"type":"string","description":"Motivo Descritivo do Cancelamento do Pedido"},"dataHoraCancelamento":{"type":"string","description":"Data e Hora do Cancelamento do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"operadorCancelamento":{"maxLength":30,"type":"string","description":"Operador do Cancelamento do Pedido"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"mascaraComprador":{"type":"integer","description":"Código da Máscara do Comprador"},"flagPedido":{"type":"integer","description":"Flag do Pedido 1 - Liberado, 2 - Liberado com Restrição, 3 - Cancelado","enum":[1,2,3]},"pedidoAutomatico":{"type":"boolean","description":"Pedido Automático? (0 - Não, 1 - Sim)"},"pedidoIntegracao":{"maxLength":30,"type":"string","description":"Número do Pedido Importado de Outros Sistemas para Integração com o Sistema Consistem"},"numControle":{"maxLength":10,"type":"string","description":"Número do Controle"},"finalidade":{"type":"integer","description":"Código da Finalidade"},"codMoedaEstrangeira":{"type":"integer","description":"Código da Moeda Estrangeira"},"dataCotacao":{"type":"string","description":"Data da Cotação (YYYY-MM-DD)","format":"date"},"valorPedidoMoedaEstrangeira":{"multipleOf":0.001,"type":"number","description":"Valor do Pedido em Moeda Estrangeira"},"valorDespFinanceiraMoedaEstrang":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Financeiras em Moeda Estrangeira"},"valorDespAcessoriaMoedaEstrange":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias em Moeda Estrangeira"},"valorFreteMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Frete em Moeda Estrangeira"},"valorDescontoMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto em Moeda Estrangeira"},"pedidoGrade":{"type":"boolean","description":"Pedido por Grade (0 - Não, 1 - Sim)"},"rotinaGeradoraPedido":{"type":"string","description":"Rotina Geradora do Pedido"},"situacaoAceitePortal":{"type":"integer","description":"Situação do Aceite no Portal (1 - Gerado, 2 - Em Aceite, 3 - Aceito, 4 - Não Aceito)","enum":[1,2,3,4]},"codCotacao":{"type":"integer","description":"Código da Cotação"},"dataLimite":{"type":"string","description":"Data Limite para Aceite do Pedido (YYYY-MM-DD)","format":"date"},"motivoLiberacao":{"maxLength":160,"type":"string","description":"Motivo da Liberação"},"valorCotacaoMoeda":{"multipleOf":0.01,"type":"number","description":"Valor da Cotação da Moeda"},"situacaoBloqueio":{"type":"integer","description":"Situação do Bloqueio (0 - Liberado, 1 - Bloqueado, 2 - Digitado, 3- Retornado)","enum":[0,1,2,3]},"opcaoTipoFrete":{"maxLength":10,"type":"string","description":"Opção de Tipo de Frete"},"dataPrevisaoInicial":{"type":"string","description":"Data de Previsão de Entrega Inicial (YYYY-MM-DD)","format":"date"},"dataPrevisaoAtual":{"type":"string","description":"Data de Previsão de Entrega Atual (YYYY-MM-DD)","format":"date"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"valorFixoFrete":{"multipleOf":0.01,"type":"number","description":"Valor Fixo do Frete a ser Somado no Valor do Pedido"},"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"},"percDesconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual de Desconto"},"valorDesconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Valor de Desconto"},"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"},"dataHoraSituacao":{"type":"string","description":"Data e Hora da Atualização da Situação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraBloqueio":{"type":"string","description":"Data e Hora do Bloqueio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraLiberacao":{"type":"string","description":"Data e Hora da Liberação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraEnvio":{"type":"string","description":"Data e Hora do Envio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraAceite":{"type":"string","description":"Data e Hora do Aceite do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"situacaoAceite":{"type":"integer","description":"Situação do Aceite do Pedido (0 - Não Enviado, 1 - Enviado, 2 - Aceito, 3 - Rejeitado)","enum":[0,1,2,3]},"codUsuario":{"type":"integer","description":"Código do Usuário"},"nomeContato":{"maxLength":30,"type":"string","description":"Nome do Contato"},"telefoneContato":{"maxLength":18,"type":"string","description":"Telefone do Contato"},"emailContato":{"maxLength":50,"type":"string","description":"E-mail do Contato"},"emailCopiaContato":{"maxLength":50,"type":"string","description":"E-mail para Cópia do Contato"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompra"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"itemPedidoCompra":{"type":"object","properties":{"percAliquotaICMS":{"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"codPedido":{"type":"integer","description":"Código do Pedido"},"itemPedido":{"type":"integer","description":"Sequência do Item do Pedido"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"qtdeAtendida":{"multipleOf":0.001,"type":"number","description":"Quantidade Atentida do Produto"},"qtdeCancelada":{"multipleOf":0.001,"type":"number","description":"Quantidade Cancelada do Produto"},"qtdeSaldo":{"multipleOf":0.001,"type":"number","description":"Quantidade de Saldo do Produto"},"valorDesconto":{"multipleOf":0.0001,"type":"number","description":"Valor do Desconto"},"situacao":{"type":"integer","description":"Situação do Item do Pedido (0 - Em Aberto, 1 - Atendido, 2 - Atendido Parte, 3 - Cancelado)","enum":[0,1,2,3]},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário do Produto"},"percIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de IPI do Produto"},"percDesconto":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Desconto do Produto"},"loteProducao":{"maxLength":6,"type":"string","description":"Lote de Produção"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"maxLength":25,"type":"string","description":"Centro de Custo para Uso do Produto"},"solicCompras":{"type":"integer","description":"Código da Solicitação de Compra"},"itemSolicCompras":{"maximum":99,"type":"integer","description":"Sequência do Item da Solicitação de Compra"},"itemDespesa":{"maximum":999,"type":"integer","description":"Código do Item de Despesa"},"itemIntegracao":{"maxLength":30,"type":"string","description":"Número do Item do Pedido Importado de Outros Sistemas"},"ultSeqAtendida":{"maximum":99,"type":"integer","description":"Última Sequência Atendida"},"unidadeMedida":{"maxLength":3,"type":"string","description":"Unidade de Medida do Produto"},"composicaoIPI":{"type":"string","description":"Composição do IPI (Despesas Acessórias;Descontos;Despesas Financeiras)"},"impressoComunicacao":{"type":"boolean","description":"Já Impresso para Comunicação de Atraso ao Fornecedor? (0 - Não, 1 - Sim)"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete (Somente existe quando frete FOB)"},"valorFreteMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Frete para Moeda Estrangeira"},"dataLimiteEntrega":{"type":"string","description":"Data Limite de Entrada do Produto (YYYY-MM-DD)","format":"date"},"pedidoFornecedor":{"type":"string","description":"Pedido do Fornecedor"},"referenciaFornecedor":{"type":"string","description":"Referência do Fornecedor"},"dataEntregaOriginal":{"type":"string","description":"Data de Entrega Original (YYYY-MM-DD)","format":"date"},"codFinalidade":{"type":"integer","description":"Código da Finalidade"},"codOS":{"type":"integer","description":"Número da Ordem de Serviço"},"precoUnitarioMoedaEstrangeira":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário para Moeda Estrangeira"},"contaContabil":{"type":"string","description":"Código da Conta Contábil"},"contaContabilC":{"type":"string","description":"Código da Conta contábil para Itens sem Código"},"numControle":{"maxLength":10,"type":"string","description":"Número do Controle"},"dataHoraCancelamentoItem":{"type":"string","description":"Data e Hora do Cancelamento do Item (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"motivoCancelamentoItem":{"maxLength":35,"type":"string","description":"Motivo do Cancelamento do Item"},"operadorCancelamentoItem":{"maxLength":30,"type":"string","description":"Operador do Cancelamento do Item"},"codUnidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"fatorConversaoCompra":{"maxLength":10,"minLength":1,"type":"string","description":"Fator de Conversão da Unidade de Medida para Compra [Deprecated]"},"fatorConversaoQuantidade":{"multipleOf":0.000001,"type":"number","description":"Quantidade Fator de Conversão da Unidade de Medida de Compra"},"fatorConversaoOperador":{"type":"integer","description":"Operador Fator de Conversão da Unidade de Medida de Compra (0 - Multiplicação / 1 - Divisão)","enum":[0,1]},"baseCalculoICMSST":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do ICMS ST"},"aliquotaICMSST":{"multipleOf":0.01,"type":"number","description":"Aliquota do ICMS ST"},"valorICMSST":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS ST"},"percDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Percentual do Diferencial da Aliquota"},"valorDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Valor do Diferencial da Aliquota"},"descricaoProduto":{"maxLength":150,"type":"string","description":"Descrição do Produto"},"rateioCentrosDeCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"codFamilia":{"type":"integer","description":"Código da Família do Produto"},"codSubFamilia":{"type":"integer","description":"Código da Subfamilia do Produto"},"codContrato":{"type":"integer","description":"Código do Contrato"},"seqProdutoContrato":{"type":"integer","description":"Sequência do Produto no Contrato"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"seqEnvioCotacao":{"type":"integer","description":"Sequência de Envio da Cotação"},"seqFornecedorCotacao":{"type":"integer","description":"Sequência do Fornecedor da Cotação"},"seqProdutoCotacao":{"type":"integer","description":"Sequência do Produto da Cotação"},"dataHoraSituacaoItem":{"type":"string","description":"Data e Hora da Atualização da Situação do Item do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataPrevisaoInicial":{"type":"string","description":"Data de Previsão Inicial (YYYY-MM-DD)","format":"date"},"percAliquotaPIS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do COFINS"},"valorUnitarioICMSST":{"multipleOf":0.01,"type":"number","description":"Valor Unitário ICMS ST"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}},"itensPedidoContaContabilCentrosCustosRateio":{"type":"array","description":"Conta(s) Contabil(eis) para Rateio","items":{"$ref":"#/components/schemas/RateioContaContabil"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}}}}} ``` ## The PedidoCompraPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"PedidoCompraPut":{"required":["itemPedidoCompra","valorPedido"],"type":"object","properties":{"codPedido":{"type":"integer","description":"Código do Pedido de Compra"},"codFornecedor":{"type":"integer","description":"Código do Fornecedor"},"dataEmissao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"codComprador":{"type":"integer","description":"Código do Comprador"},"codTransportadora":{"type":"integer","description":"Código da Transportadora"},"condicaoFrete":{"type":"integer","description":"Código da Condição de Frete"},"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"},"percDespesaFinanceira":{"multipleOf":0.01,"type":"number","description":"Percentual de Despesa Financeira"},"valorDespesaFinanceira":{"multipleOf":0.01,"type":"number","description":"Valor de Despesa Financeira"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual de Desconto"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto"},"valorPedido":{"multipleOf":0.01,"type":"number","description":"Valor Total do Pedido"},"dataRecebimento":{"type":"string","description":"Data de Recebimento (YYYY-MM-DD)","format":"date"},"situacaoPedido":{"type":"integer","description":"Situação (0 - Aberto, 1 - Atendido, 2 - Atendido parte, 3 - Cancelado)","enum":[0,1,2,3]},"observacao":{"maxLength":160,"type":"string","description":"Observação"},"situacaoQtoEntrada":{"type":"integer","description":"Situação Quanto a Entrada"},"tipoDescontoEspecial":{"type":"integer","description":"Tipo do Desconto Especial (0 - Em dias, 1 - Em data específica)","enum":[0,1]},"valorDespesaAcessoria":{"multipleOf":0.01,"type":"number","description":"Valor de Despesa Acessória"},"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]},"codPedidoComplementar":{"type":"integer","description":"Código do Pedido Complementar"},"codMensagemPadrao":{"type":"integer","description":"Código da Mensagem Padrão"},"codPortador":{"type":"integer","description":"Código do Portador"},"situacaoImpresso":{"type":"boolean","description":"Situação da Impressão (0 - Não Impresso, 1 - Impresso)"},"condicaoPagamentoEspecial":{"type":"integer","description":"Código da Segunda Condição de Pagamento Especial"},"condicaoPagamentoEspecial1":{"type":"integer","description":"Código da Terceira Condição de Pagamento Especial"},"condicaoPagamentoEspecial2":{"type":"integer","description":"Código da Quarta Condição de Pagamento Especial"},"condicaoPagamentoEspecial3":{"type":"integer","description":"Código da Quinta Condição de Pagamento Especial"},"condicaoPagamentoEspecial4":{"type":"integer","description":"Código da Sexta Condição de Pagamento Especial"},"pedidoBloqueado":{"type":"boolean","description":"Pedido esta Bloqueado? (0 - Não, 1 - Sim)"},"motivoCancelamento":{"maxLength":105,"type":"string","description":"Motivo Descritivo do Cancelamento do Pedido"},"dataHoraCancelamento":{"type":"string","description":"Data e Hora do Cancelamento do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"operadorCancelamento":{"maxLength":30,"type":"string","description":"Operador do Cancelamento do Pedido"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete"},"mascaraComprador":{"type":"integer","description":"Código da Máscara do Comprador"},"flagPedido":{"type":"integer","description":"Flag do Pedido (1 - Liberado, 2 - Liberado com Restrição, 3 - Cancelado)","enum":[1,2,3]},"pedidoAutomatico":{"type":"boolean","description":"Pedido Automático? (0 - Não, 1 - Sim)"},"pedidoIntegracao":{"maxLength":30,"type":"string","description":"Número do Pedido Importado de Outros Sistemas para Integração com o Sistema Consistem"},"numControle":{"maxLength":10,"type":"string","description":"Número do Controle"},"finalidade":{"type":"integer","description":"Código da Finalidade"},"codMoedaEstrangeira":{"type":"integer","description":"Código da Moeda Estrangeira"},"dataCotacao":{"type":"string","description":"Data da Cotação (YYYY-MM-DD)","format":"date"},"valorPedidoMoedaEstrangeira":{"multipleOf":0.001,"type":"number","description":"Valor do Pedido em Moeda Estrangeira"},"valorDespFinanceiraMoedaEstrang":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Financeiras em Moeda Estrangeira"},"valorDespAcessoriaMoedaEstrange":{"multipleOf":0.01,"type":"number","description":"Valor de Despesas Acessórias em Moeda Estrangeira"},"valorFreteMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Frete em Moeda Estrangeira"},"valorDescontoMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto em Moeda Estrangeira"},"pedidoGrade":{"type":"boolean","description":"Pedido por Grade (0 - Não, 1 - Sim)"},"rotinaGeradoraPedido":{"type":"string","description":"Rotina Geradora do Pedido"},"situacaoAceitePortal":{"type":"integer","description":"Situação do Aceite no Portal (1 - Gerado, 2 - Em Aceite, 3 - Aceito, 4 - Não Aceito)","enum":[1,2,3,4]},"codCotacao":{"type":"integer","description":"Código da Cotação"},"dataLimite":{"type":"string","description":"Data Limite para Aceite do Pedido (YYYY-MM-DD)","format":"date"},"motivoLiberacao":{"maxLength":160,"type":"string","description":"Motivo da Liberação"},"valorCotacaoMoeda":{"multipleOf":0.01,"type":"number","description":"Valor da Cotação da Moeda"},"situacaoBloqueio":{"type":"integer","description":"Situação do Bloqueio (0 - Liberado, 1 - Bloqueado, 2 - Digitado, 3- Retornado)","enum":[0,1,2,3]},"opcaoTipoFrete":{"maxLength":10,"type":"string","description":"Opção de Tipo de Frete"},"dataPrevisaoInicial":{"type":"string","description":"Data de Previsão de Entrega Inicial (YYYY-MM-DD)","format":"date"},"dataPrevisaoAtual":{"type":"string","description":"Data de Previsão de Entrega Atual (YYYY-MM-DD)","format":"date"},"percFrete":{"multipleOf":0.01,"type":"number","description":"Percentual de Frete Sobre o Valor das Mercadorias"},"valorFixoFrete":{"multipleOf":0.01,"type":"number","description":"Valor Fixo do Frete a ser Somado no Valor do Pedido"},"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"},"percDesconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Percentual de Desconto"},"valorDesconto2":{"multipleOf":0.01,"type":"number","description":"Segundo Valor de Desconto"},"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"},"dataHoraSituacao":{"type":"string","description":"Data e Hora da Atualização da Situação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraBloqueio":{"type":"string","description":"Data e Hora do Bloqueio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraLiberacao":{"type":"string","description":"Data e Hora da Liberação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraEnvio":{"type":"string","description":"Data e Hora do Envio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataHoraAceite":{"type":"string","description":"Data e Hora do Aceite do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"situacaoAceite":{"type":"integer","description":"Situação do Aceite do Pedido (0 - Não Enviado, 1 - Enviado, 2 - Aceito, 3 - Rejeitado)","enum":[0,1,2,3]},"codUsuario":{"type":"integer","description":"Código do Usuário"},"nomeContato":{"maxLength":30,"type":"string","description":"Nome do Contato"},"telefoneContato":{"maxLength":18,"type":"string","description":"Telefone do Contato"},"emailContato":{"maxLength":50,"type":"string","description":"E-mail do Contato"},"emailCopiaContato":{"maxLength":50,"type":"string","description":"E-mail para Cópia do Contato"},"itemPedidoCompra":{"type":"array","description":"Itens do Pedido de Compra","items":{"$ref":"#/components/schemas/itemPedidoCompraPut"}},"parcelasPedido":{"type":"array","description":"Parcelas do Pedido de Compra","items":{"$ref":"#/components/schemas/ParcelasPedidoPut"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"itemPedido":{"type":"integer","description":"Código da Sequencia do Item do Pedido"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"situacao":{"type":"integer","description":"Situação do Item do Pedido (0 - Em Aberto, 1 - Atendido, 2 - Atendido Parte, 3 - Cancelado)","enum":[0,1,2,3]},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário do Produto"},"percIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de IPI do Produto"},"percDesconto":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Desconto do Produto"},"loteProducao":{"maxLength":6,"type":"string","description":"Lote de Produção"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"maxLength":25,"type":"string","description":"Centro de Custo para Uso do Produto"},"solicCompras":{"type":"integer","description":"Código da Solicitação de Compra"},"itemSolicCompras":{"maximum":99,"type":"integer","description":"Sequência do Item da Solicitação de Compra"},"itemDespesa":{"maximum":999,"type":"integer","description":"Código do Item de Despesa"},"itemIntegracao":{"maxLength":30,"type":"string","description":"Número do Item do Pedido Importado de Outros Sistemas"},"ultSeqAtendida":{"maximum":99,"type":"integer","description":"Última Sequência Atendida"},"unidadeMedida":{"maxLength":3,"type":"string","description":"Unidade de Medida do Produto"},"composicaoIPI":{"type":"string","description":"Composição do IPI (Despesas Acessórias;Descontos;Despesas Financeiras)"},"impressoComunicacao":{"type":"boolean","description":"Já Impresso para Comunicação de Atraso ao Fornecedor? (0 - Não, 1 - Sim)"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete (Somente existe quando frete FOB)"},"valorFreteMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Frete para Moeda Estrangeira"},"dataLimiteEntrega":{"type":"string","description":"Data Limite de Entrada do Produto (YYYY-MM-DD)","format":"date"},"pedidoFornecedor":{"type":"string","description":"Pedido do Fornecedor"},"referenciaFornecedor":{"type":"string","description":"Referência do Fornecedor"},"dataEntregaOriginal":{"type":"string","description":"Data de Entrega Original (YYYY-MM-DD)","format":"date"},"codFinalidade":{"type":"integer","description":"Código da Finalidade"},"codOS":{"type":"integer","description":"Número da Ordem de Serviço"},"precoUnitarioMoedaEstrangeira":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário para Moeda Estrangeira"},"contaContabil":{"type":"string","description":"Código da Conta Contábil"},"contaContabilC":{"type":"string","description":"Código da Conta contábil para Itens sem Código"},"numControle":{"maxLength":10,"type":"string","description":"Número do Controle"},"dataHoraCancelamentoItem":{"type":"string","description":"Data e Hora do Cancelamento do Item (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"motivoCancelamentoItem":{"maxLength":35,"type":"string","description":"Motivo do Cancelamento do Item"},"operadorCancelamentoItem":{"maxLength":30,"type":"string","description":"Operador do Cancelamento do Item"},"codUnidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"fatorConversaoCompra":{"maxLength":10,"minLength":1,"type":"string","description":"Fator de Conversão da Unidade de Medida para Compra"},"fatorConversaoQuantidade":{"multipleOf":0.01,"type":"number","description":"Quantidade Fator de Conversão da Unidade de Medida de Compra"},"fatorConversaoOperador":{"type":"integer","description":"Operador Fator de Conversão da Unidade de Medida de Compra (0 - Multiplicação / 1 - Divisão)","enum":[0,1]},"baseCalculoICMSST":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do ICMS ST"},"aliquotaICMSST":{"multipleOf":0.01,"type":"number","description":"Aliquota do ICMS ST"},"valorICMSST":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS ST"},"percDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Percentual do Diferencial da Aliquota"},"valorDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Valor do Diferencial da Aliquota"},"descricaoProduto":{"maxLength":150,"type":"string","description":"Descrição do Produto"},"rateioCentrosDeCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"codFamilia":{"type":"integer","description":"Código da Família do Produto"},"codSubFamilia":{"type":"integer","description":"Código da Subfamilia do Produto"},"codContrato":{"type":"integer","description":"Código do Contrato"},"seqProdutoContrato":{"type":"integer","description":"Sequência do Produto no Contrato"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"seqEnvioCotacao":{"type":"integer","description":"Sequência de Envio da Cotação"},"seqFornecedorCotacao":{"type":"integer","description":"Sequência do Fornecedor da Cotação"},"seqProdutoCotacao":{"type":"integer","description":"Sequência do Produto da Cotação"},"dataHoraSituacaoItem":{"type":"string","description":"Data e Hora da Atualização da Situação do Item do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataPrevisaoInicial":{"type":"string","description":"Data de Previsão Inicial (YYYY-MM-DD)","format":"date"},"percAliquotaPIS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do COFINS"},"valorUnitarioICMSST":{"multipleOf":0.01,"type":"number","description":"Valor Unitário ICMS ST"},"itensContaContabilCentroCustosRateio":{"type":"array","description":"Contas Contabéis para Rateio","items":{"$ref":"#/components/schemas/RateioContaContabil"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ParcelasPedidoPut":{"type":"object","properties":{"qtdeDiasParcela":{"type":"integer","description":"Quantidade de Dias da Parcela"},"valProporcao":{"multipleOf":0.01,"type":"number","description":"Proporção (Parte) que Será Paga na Parcela"},"dataPagamento":{"type":"string","description":"Data para Vencimento da Parcela (YYYY-MM-DD)","format":"date"},"valorPagamento":{"multipleOf":0.01,"type":"number","description":"Valor da Parcela"}}}}}} ``` ## The itemPedidoCompraPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"itemPedidoCompraPut":{"type":"object","properties":{"percAliquotaICMS":{"type":"number","description":"Percentual de Aliquota do ICMS"},"codProduto":{"type":"string","description":"Código do Produto"},"itemPedido":{"type":"integer","description":"Código da Sequencia do Item do Pedido"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"situacao":{"type":"integer","description":"Situação do Item do Pedido (0 - Em Aberto, 1 - Atendido, 2 - Atendido Parte, 3 - Cancelado)","enum":[0,1,2,3]},"precoUnitario":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário do Produto"},"percIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de IPI do Produto"},"percDesconto":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Desconto do Produto"},"loteProducao":{"maxLength":6,"type":"string","description":"Lote de Produção"},"dataPrevisao":{"type":"string","description":"Data de Previsão de Entrega (YYYY-MM-DD)","format":"date"},"centroCusto":{"maxLength":25,"type":"string","description":"Centro de Custo para Uso do Produto"},"solicCompras":{"type":"integer","description":"Código da Solicitação de Compra"},"itemSolicCompras":{"maximum":99,"type":"integer","description":"Sequência do Item da Solicitação de Compra"},"itemDespesa":{"maximum":999,"type":"integer","description":"Código do Item de Despesa"},"itemIntegracao":{"maxLength":30,"type":"string","description":"Número do Item do Pedido Importado de Outros Sistemas"},"ultSeqAtendida":{"maximum":99,"type":"integer","description":"Última Sequência Atendida"},"unidadeMedida":{"maxLength":3,"type":"string","description":"Unidade de Medida do Produto"},"composicaoIPI":{"type":"string","description":"Composição do IPI (Despesas Acessórias;Descontos;Despesas Financeiras)"},"impressoComunicacao":{"type":"boolean","description":"Já Impresso para Comunicação de Atraso ao Fornecedor? (0 - Não, 1 - Sim)"},"valorFrete":{"multipleOf":0.01,"type":"number","description":"Valor do Frete (Somente existe quando frete FOB)"},"valorFreteMoedaEstrangeira":{"multipleOf":0.01,"type":"number","description":"Valor do Frete para Moeda Estrangeira"},"dataLimiteEntrega":{"type":"string","description":"Data Limite de Entrada do Produto (YYYY-MM-DD)","format":"date"},"pedidoFornecedor":{"type":"string","description":"Pedido do Fornecedor"},"referenciaFornecedor":{"type":"string","description":"Referência do Fornecedor"},"dataEntregaOriginal":{"type":"string","description":"Data de Entrega Original (YYYY-MM-DD)","format":"date"},"codFinalidade":{"type":"integer","description":"Código da Finalidade"},"codOS":{"type":"integer","description":"Número da Ordem de Serviço"},"precoUnitarioMoedaEstrangeira":{"multipleOf":0.0001,"type":"number","description":"Preço Unitário para Moeda Estrangeira"},"contaContabil":{"type":"string","description":"Código da Conta Contábil"},"contaContabilC":{"type":"string","description":"Código da Conta contábil para Itens sem Código"},"numControle":{"maxLength":10,"type":"string","description":"Número do Controle"},"dataHoraCancelamentoItem":{"type":"string","description":"Data e Hora do Cancelamento do Item (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"motivoCancelamentoItem":{"maxLength":35,"type":"string","description":"Motivo do Cancelamento do Item"},"operadorCancelamentoItem":{"maxLength":30,"type":"string","description":"Operador do Cancelamento do Item"},"codUnidadeCompra":{"type":"string","description":"Código da Unidade de Medida para Compra"},"fatorConversaoCompra":{"maxLength":10,"minLength":1,"type":"string","description":"Fator de Conversão da Unidade de Medida para Compra"},"fatorConversaoQuantidade":{"multipleOf":0.01,"type":"number","description":"Quantidade Fator de Conversão da Unidade de Medida de Compra"},"fatorConversaoOperador":{"type":"integer","description":"Operador Fator de Conversão da Unidade de Medida de Compra (0 - Multiplicação / 1 - Divisão)","enum":[0,1]},"baseCalculoICMSST":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do ICMS ST"},"aliquotaICMSST":{"multipleOf":0.01,"type":"number","description":"Aliquota do ICMS ST"},"valorICMSST":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS ST"},"percDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Percentual do Diferencial da Aliquota"},"valorDiferencialAliquota":{"multipleOf":0.01,"type":"number","description":"Valor do Diferencial da Aliquota"},"descricaoProduto":{"maxLength":150,"type":"string","description":"Descrição do Produto"},"rateioCentrosDeCusto":{"type":"boolean","description":"Indicar se Deve ou Não Ratear para Mais de um Centro de Custo (0 - Não, 1- Sim)"},"codFamilia":{"type":"integer","description":"Código da Família do Produto"},"codSubFamilia":{"type":"integer","description":"Código da Subfamilia do Produto"},"codContrato":{"type":"integer","description":"Código do Contrato"},"seqProdutoContrato":{"type":"integer","description":"Sequência do Produto no Contrato"},"codCotacao":{"type":"integer","description":"Código da Cotação"},"seqEnvioCotacao":{"type":"integer","description":"Sequência de Envio da Cotação"},"seqFornecedorCotacao":{"type":"integer","description":"Sequência do Fornecedor da Cotação"},"seqProdutoCotacao":{"type":"integer","description":"Sequência do Produto da Cotação"},"dataHoraSituacaoItem":{"type":"string","description":"Data e Hora da Atualização da Situação do Item do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"dataPrevisaoInicial":{"type":"string","description":"Data de Previsão Inicial (YYYY-MM-DD)","format":"date"},"percAliquotaPIS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do PIS"},"percAliquotaCOFINS":{"multipleOf":0.01,"type":"number","description":"Percentual de Aliquota do COFINS"},"valorUnitarioICMSST":{"multipleOf":0.01,"type":"number","description":"Valor Unitário ICMS ST"},"itensContaContabilCentroCustosRateio":{"type":"array","description":"Contas Contabéis para Rateio","items":{"$ref":"#/components/schemas/RateioContaContabil"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"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":"1.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ParcelasPedidoPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ParcelasPedidoPut":{"type":"object","properties":{"qtdeDiasParcela":{"type":"integer","description":"Quantidade de Dias da Parcela"},"valProporcao":{"multipleOf":0.01,"type":"number","description":"Proporção (Parte) que Será Paga na Parcela"},"dataPagamento":{"type":"string","description":"Data para Vencimento da Parcela (YYYY-MM-DD)","format":"date"},"valorPagamento":{"multipleOf":0.01,"type":"number","description":"Valor da Parcela"}}}}}} ``` ## The ListaHistoricoComprasMaterialMoedaEstrangeira object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ListaHistoricoComprasMaterialMoedaEstrangeira":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"historicoComprasMaterial":{"type":"array","description":"Histórico de Compras","items":{"$ref":"#/components/schemas/HistoricoComprasMaterial"}}}},"HistoricoComprasMaterial":{"type":"object","properties":{"dataEmissao":{"type":"string","description":"Data da Emissão da Nota (YYYY-MM-DD)","format":"date"},"dataEntrada":{"type":"string","description":"Data de Entrada da Nota (YYYY-MM-DD)","format":"date"},"fornecedor":{"type":"integer","description":"Código do Fornecedor"},"serie":{"type":"string","description":"Código da Série Fiscal"},"codNFEntrada":{"type":"integer","description":"Código Numérico da Nota"},"codItem":{"maximum":999999,"type":"integer","description":"Sequencia do Item na Nota"},"codMaterial":{"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"valorCustoItem":{"multipleOf":0.01,"type":"number","description":"Valor Custo de Aquisição do Item"},"cotacaoMoedaEstrangeira":{"type":"array","description":"Lista de Engenharias","items":{"$ref":"#/components/schemas/CotacaoMoedaEstrangeira"}}}},"CotacaoMoedaEstrangeira":{"type":"object","properties":{"codMoeda":{"type":"string","description":"Código da Moeda Estrangeira"},"descMoeda":{"type":"string","description":"Descrição da Moeda Estrangeira"},"valorCotacaoDataEntrada":{"multipleOf":0.001,"type":"number","description":"Valor Cotação Moeda Estrangeira na Data de Entrada da Nota Fiscal"}}}}}} ``` ## The HistoricoComprasMaterial object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"HistoricoComprasMaterial":{"type":"object","properties":{"dataEmissao":{"type":"string","description":"Data da Emissão da Nota (YYYY-MM-DD)","format":"date"},"dataEntrada":{"type":"string","description":"Data de Entrada da Nota (YYYY-MM-DD)","format":"date"},"fornecedor":{"type":"integer","description":"Código do Fornecedor"},"serie":{"type":"string","description":"Código da Série Fiscal"},"codNFEntrada":{"type":"integer","description":"Código Numérico da Nota"},"codItem":{"maximum":999999,"type":"integer","description":"Sequencia do Item na Nota"},"codMaterial":{"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"valorCustoItem":{"multipleOf":0.01,"type":"number","description":"Valor Custo de Aquisição do Item"},"cotacaoMoedaEstrangeira":{"type":"array","description":"Lista de Engenharias","items":{"$ref":"#/components/schemas/CotacaoMoedaEstrangeira"}}}},"CotacaoMoedaEstrangeira":{"type":"object","properties":{"codMoeda":{"type":"string","description":"Código da Moeda Estrangeira"},"descMoeda":{"type":"string","description":"Descrição da Moeda Estrangeira"},"valorCotacaoDataEntrada":{"multipleOf":0.001,"type":"number","description":"Valor Cotação Moeda Estrangeira na Data de Entrada da Nota Fiscal"}}}}}} ``` ## The CotacaoMoedaEstrangeira object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"CotacaoMoedaEstrangeira":{"type":"object","properties":{"codMoeda":{"type":"string","description":"Código da Moeda Estrangeira"},"descMoeda":{"type":"string","description":"Descrição da Moeda Estrangeira"},"valorCotacaoDataEntrada":{"multipleOf":0.001,"type":"number","description":"Valor Cotação Moeda Estrangeira na Data de Entrada da Nota Fiscal"}}}}}} ``` ## The NotaFiscalEntrada object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"NotaFiscalEntrada":{"type":"object","properties":{"dataEntrada":{"type":"string","description":"Data de Entrada da Nota (YYYY-MM-DD)","format":"date"},"fornecedor":{"type":"integer","description":"Código do Fornecedor"},"serie":{"type":"string","description":"Código da Série Fiscal"},"numero":{"type":"integer","description":"Código Numérico da Nota"},"dataEmissao":{"type":"string","description":"Data da Emissão da Nota (YYYY-MM-DD)","format":"date"},"valorMercadoria":{"multipleOf":0.01,"type":"number","description":"Valor da Mercadoria"},"valorDespAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor das Despesas Acessórias"},"valorDespFinanceira":{"multipleOf":0.01,"type":"number","description":"Valor das Despesas Financeiras"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"descontosBonificacao":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto de Bonificação"},"valorTotal":{"multipleOf":0.01,"type":"number","description":"Valor Total da Nota"},"naturezaOperacao":{"type":"string","description":"Código da Natureza de Operaçaõ"},"baseIcmsCredito":{"multipleOf":0.01,"type":"number","description":"Base de ICMS de Crédito"},"valorIcmsCredito":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS de Crédito"},"aliquotaIcmsCredito":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS de Crédito"},"valorIsentasIcms":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS Isentas"},"valorOutrasIcms":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS Outras"},"baseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Base de IPI de Crédito"},"valIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor de IPI de Crédito"},"valorIsentasIPI":{"multipleOf":0.01,"type":"number","description":"Valor de IPI Isentas"},"valorOutrasIPI":{"multipleOf":0.01,"type":"number","description":"Valor de IPI Outras"},"especieDocumento":{"type":"integer","description":"Espécie do Documento (1 - Nota Fiscal, 2 - Nota Fiscal com Conhecimento, 3 - Nota Fiscal de Devolução, 4 - Conhecimento, 5 - Fatura Energia Elétrica, 6 - Nota Serviço, 7 - Nota Fiscal Complementar, 8 - Nota Fiscal Retorno Industrialização, 10 - Nota Fiscal Retorno Industrialização com Conhecimento, 11 - Nota Fiscal com Serviço, 12 - Nota Fiscal com Serviço e Conhecimento, 13 - Nota Fiscal Retorno de Industrialização/Serviço, 14 - Nota Fiscal Retorno de Industrialização/Serviço/Conhecimento)","enum":[1,2,3,4,5,6,7,8,10,11,12,13,14]},"situacao":{"type":"integer","description":"Situação (0 - Normal, 1 - Uso futuro, 2 - Cancelada, 3 - Cancelada (Grãos))","enum":[0,1,2,3]},"basePisPasepCredito":{"multipleOf":0.01,"type":"number","description":"Base de PIS/PASEP (Crédito)"},"valorPisPasepCredito":{"multipleOf":0.01,"type":"number","description":"Valor de PIS/PASEP (Crédito)"},"valorISS":{"multipleOf":0.01,"type":"number","description":"Valor de ISS"},"valorINSS":{"multipleOf":0.01,"type":"number","description":"Valor de INSS"},"dataHoraLancamento":{"type":"string","description":"Data e Hora de Lançamento da Nota (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"baseCofinsCredito":{"multipleOf":0.01,"type":"number","description":"Base COFINS (Crédito)"},"valorCofinsCredito":{"multipleOf":0.01,"type":"number","description":"Valor do COFINS (Crédito)"},"valorCsllRetencao":{"multipleOf":0.01,"type":"number","description":"Valor CSLL - Retenção"},"valorPisPasepRetencao":{"multipleOf":0.01,"type":"number","description":"Valor PIS/PASEP (Retenção)"},"valorCofinsRetencao":{"multipleOf":0.01,"type":"number","description":"Valor COFINS (Retenção)"},"valorSubstituicaoTribICMS":{"multipleOf":0.01,"type":"number","description":"Valor Substituição Tributária ICMS a Recolher"},"UFTransportador":{"maxLength":2,"type":"string","description":"UF do Transportador (NF-e)"},"placaVeiculo":{"maxLength":10,"type":"string","description":"Placa do Veículo (NF-e)"},"qtdVolume":{"multipleOf":0.01,"type":"number","description":"Quantidade de Columes (NF-e)"},"pesoBruto":{"multipleOf":0.01,"type":"number","description":"Peso Bruto da Nota (NF-e)"},"pesoLiquido":{"multipleOf":0.01,"type":"number","description":"Peso Líquido da Nota (NF-e)"},"tipoFrete":{"type":"integer","description":"Tipo de Frete (1 - Contratação do Frete por conta do Remetente (CIF), 2 - Contratação do Frete por conta do Destinatário (FOB), 3 - Contratação do Frete por conta de Terceiros, 4 - Transporte Próprio por conta do Remetente, 5 - Transporte Próprio por conta do Destinatário, 9 - Sem Ocorrência de Transporte)","enum":[1,2,3,4,5,9]},"chaveNFe":{"maxLength":44,"type":"string","description":"Chave de Acesso da NF-e"},"valorIcmsOriginal":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Original"},"integradoServicoTerc":{"type":"integer","description":"Integrado com Serviço Terceirizado? (0 - Não, 1 - Sim)","enum":[0,1]},"baseRetencaoISS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção ISS"},"baseRetencaoIRRF":{"multipleOf":0.01,"type":"number","description":"Base de Retenção IRRF"},"baseRetencaoINSS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção INSS"},"baseRetencaoPIS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção PIS"},"baseRetencaoCOFINS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção COFINS"},"baseRetencaoCSLL":{"multipleOf":0.01,"type":"number","description":"Base de Retenção CSLL"},"indNaturezaFrete":{"type":"integer","description":"Indicador da Natureza de Frete (0 - Oper. vendas com ônus suportado vendedor, 1 - Oper. vendas com ônus suportado adquirente, 3 - Oper. compras com bens não geram crédito, 4 - Transf. acabados entre estabelecicmentos, 5 - Transf. elaboração entre estabelecimentos, 9 - Outras)","enum":[0,1,3,4,5,9]},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor de Seguro"},"valorFreteDestacado":{"multipleOf":0.01,"type":"number","description":"Valor do Frete Destacado"},"valorTotIcmsStInformado":{"multipleOf":0.01,"type":"number","description":"Valor total do ICMS-ST informado (Original)"},"baseICMSRetencao":{"multipleOf":0.01,"type":"number","description":"Base de ICMS Retenção"},"valorICMSRetencao":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS Retenção"},"inscricaoEstadual":{"maxLength":17,"type":"string","description":"Inscrição Estadual"},"codMunicipioOrigem":{"type":"string","description":"Código do Município Origem"},"codMunicipioDestino":{"type":"string","description":"Código do Município Destino"},"simplesFaturamento":{"type":"integer","description":"Nota Fiscal de Simples Faturamento Para Entrega Futura (0 - Não, 1 - Sim)","enum":[0,1]},"entradaEntregaFutura":{"type":"integer","description":"Nota Fiscal de Remessa da Entrega Futura (0 - Não, 1 - Sim)","enum":[0,1]},"finalidadeDocumento":{"type":"integer","description":"Finalidade Documento (1 - Normal, 2 - Substituição, 3 - Normal com Ajuste)","enum":[1,2,3]},"chaveNotaReferencia":{"type":"string","description":"Chave da Nota Referenciada"},"modeloDocumento":{"type":"string","description":"Modelo do Documento (01 - Nota Fiscal, 06 - Energia Elétrica, 08 - Conhecimento Transporte, 22 - Telecomunicações, 10 - Frete Aereo, 55 - Nota Fiscal Eletrônica, 57 - Conhecimento Transporte Eletrônico)","enum":["01","06","08","10","22","55","57"]},"valorDiferencaAliquota":{"multipleOf":0.01,"type":"number","description":"Valor da Diferença da Alíquota"},"baseDirfAliq":{"multipleOf":0.01,"type":"number","description":"Base da Diferença da Alíquota"},"condPgto":{"type":"string","description":"Condições de Pagamento"},"valorCreditoPresumidoICMS":{"multipleOf":0.01,"type":"number","description":"Valor Crédito presumido ICMS"},"baseICMSSub":{"multipleOf":0.01,"type":"number","description":"Base ICMS Substituição Tributária"},"valorICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária"},"baseICMSSubSC":{"multipleOf":0.01,"type":"number","description":"Base ICMS Substituição Tributária com Crédito"},"valorICMSSubSC":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária com Crédito"},"basePreICMS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo de Crédito Presumido ICMS"},"totalValorSTCalculado":{"multipleOf":0.01,"type":"number","description":"Valor Total do ICMS-ST Calculado"},"totalValorSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Valor Total de ICMS-ST Corrigido pelo Sistema (Diferença)"},"itensNotaFiscalEntrada":{"type":"array","description":"Itens da Nota Fiscal de Entrada","items":{"$ref":"#/components/schemas/ItemNotaFiscalEntrada"}},"dadosDevolucao":{"type":"array","description":"Dados de Devolução da Nota Fiscal de Entrada","items":{"$ref":"#/components/schemas/DadosDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalEntrada":{"required":["codItem","codSitTributariaCOFINS","codSitTributariaPIS"],"type":"object","properties":{"codItem":{"maximum":999999,"type":"integer","description":"Sequencia do Item na Nota"},"codMaterial":{"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS para o Item"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI para o Item"},"aliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota do ICMS"},"naturezaOperacao":{"maximum":999999,"type":"integer","description":"Código da Natureza de Operação"},"contaContabil":{"maximum":999999,"type":"integer","description":"Código da Conta Contábil"},"codClassifFiscal":{"maxLength":10,"type":"string","description":"Código da Classificação Fiscal do Material"},"valorReducaoICMS":{"multipleOf":0.01,"type":"number","description":"Valor de Redução do ICMS"},"valorReducaoIPI":{"multipleOf":0.01,"type":"number","description":"Valor de Redução do IPI"},"codigoICMS":{"type":"integer","description":"Código do ICMS (1 - C/ crédito, 2 - S/ crédito, 3 - Outros, 4 - Com crédito C/ custo)","enum":[1,2,3,4]},"codigoIPI":{"type":"integer","description":"Código do IPI (1 - C/ crédito, 2 - S/ crédito, 3 - Outro)","enum":[1,2,3]},"centroCustoValor":{"maxLength":50,"type":"string","description":"Centros de Custo e Valores (Centro de Custo;Valor)"},"valorFreteApropriado":{"multipleOf":0.001,"type":"number","description":"Valor do Frete Apropriado"},"valorICMSApropriado":{"multipleOf":0.001,"type":"number","description":"Valor do ICMS Apropriado"},"valorBaseCalcPisPasep":{"multipleOf":0.01,"type":"number","description":"Valor da Base de Cálculo do PIS/PASEP"},"valorPisPasepRec":{"multipleOf":0.01,"type":"number","description":"Valor do PIS/PASEP a Recuperar"},"quantidadeEstoque":{"multipleOf":0.001,"type":"number","description":"Quantidade de Estoque (Quando unidade de compra maior ou menor que unidade de estoque)"},"codigoServico":{"maximum":999,"type":"integer","description":"Código do serviço (IN68)"},"tipoOperacao":{"maximum":999,"type":"integer","description":"Tipo de operação (IN68)"},"baseCalculoICMS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do ICMS"},"baseCalculoCOFINS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do COFINS"},"valorCOFINS":{"multipleOf":0.01,"type":"number","description":"Valor de Cálculo do COFINS"},"valorPisPasepAprop":{"multipleOf":0.001,"type":"number","description":"Valor do PIS/PASEP Apropriado (Do frete)"},"valorCofinsAprop":{"multipleOf":0.001,"type":"number","description":"Valor do COFINS Apropriado (Do frete)"},"subTribICMS":{"multipleOf":0.01,"type":"number","description":"Valor Substituição Tributária ICMS (ICMS pago antecipado sem destaque na nota)"},"baseICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Substituição Tributária"},"valorICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária"},"sitICMSST":{"type":"integer","description":"Situação ICMS ST (0 - Não Possui, 1 - Com Crédito, 2 - Sem Crédito)","enum":[0,1,2]},"percPis":{"multipleOf":0.01,"type":"number","description":"Percentual de PIS/PASEP"},"percCof":{"multipleOf":0.01,"type":"number","description":"Percentual de COFINS"},"valorBaseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor Base IPI com Crédito"},"codSitTributariaICMS":{"type":"integer","description":"Código da Situação Tributária ICMS"},"valorIcmsOriginal":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Original"},"codSitTributariaPIS":{"maxLength":3,"type":"string","description":"Código Situação Tributária PIS"},"codSitTributariaCOFINS":{"maxLength":3,"type":"string","description":"Código Situação Tributária COFINS"},"unidadeCompra":{"maxLength":3,"type":"string","description":"Unidade de Medida de Compra"},"fatorConversao":{"maxLength":10,"type":"string","description":"Fator de Conversão da Unidade de Medida de Compra [Deprecated]"},"fatorConversaoQuantidade":{"multipleOf":0.01,"type":"number","description":"Quantidade Fator de Conversão da Unidade de Medida de Compra"},"fatorConversaoOperador":{"type":"integer","description":"Operador Fator de Conversão da Unidade de Medida de Compra (0 - Multiplicação / 1 - Divisão)","enum":[0,1]},"codListaServicos":{"type":"integer","description":"Código da Lista de Serviços"},"baseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor IPI Base de Cálculo com Crédito"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual Aliquota do IPI"},"CSTIpi":{"maxLength":2,"type":"string","description":"CST do IPI"},"tipoBaseCreditoPIS":{"type":"string","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"]},"tipoBaseCreditoCofins":{"type":"string","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"]},"valorSTInformado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS-ST Informado (Original)"},"valorSTCalculado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS-ST Calculado"},"baseSTInformado":{"multipleOf":0.01,"type":"number","description":"Base ICMS-ST Informado (Original)"},"baseSTCalculado":{"multipleOf":0.01,"type":"number","description":"Base ICMS-ST Calculado"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"tipoCSTICMS":{"type":"integer","description":"Tipo de CST de ICMS (0 - CST Normal, 1 - Simples)","enum":[0,1]},"valorICMSPartOrigem":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Diferencial de Alíquota Partilhado - UF Remetente"},"valorICMSPartDestino":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Diferencial de Alíquota Partilhado - UF Destinatário"},"valorICMSFCP":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS - Fundo Combate Pobreza"},"valorFCPICMS":{"multipleOf":0.01,"type":"number","description":"Valor FCP (Fundo Combate Pobreza) ICMS"},"valorFCPICMSST":{"multipleOf":0.01,"type":"number","description":"Valor FCP (Fundo Combate Pobreza) ICMS-ST"},"custoEntrada":{"multipleOf":0.01,"type":"number","description":"Custo Unitário de Entrada"},"baseContabilizacao":{"multipleOf":0.01,"type":"number","description":"Base para Contabilização"},"descricaoItem":{"maxLength":30,"type":"string","description":"Descrição do Item caso Código do Material não Seja Informado"},"unidadeMedida":{"maxLength":3,"type":"string","description":"Unidade de Medida caso Código do Material não Seja Informado"},"obsItemDespesa":{"maxLength":30,"type":"string","description":"Observação de Despesa do Item"},"credPresICMS":{"multipleOf":0.01,"type":"number","description":"Valor Crédito Presumido de ICMS"},"valorUniCCI":{"multipleOf":0.01,"type":"number","description":"Valor Unitário (utilizado no retorno de OPs com conta corrente de itens)"},"baseICMSTrib":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Tributado"},"baseICMSIsenta":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Isenta"},"baseICMSOutras":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Outras"},"valorSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS-ST Corrigido pelo Sistema (Diferença)"},"baseSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Base de ICMS-ST Corrigido pelo Sistema (Diferença)"}}},"DadosDevolucao":{"required":["chaveNFeSaidaReferencia"],"type":"object","properties":{"chaveNFeSaidaReferencia":{"maxLength":44,"minLength":44,"type":"string","description":"Chave da NF-e de Saída Referência"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaFiscalEntradaPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"NotaFiscalEntradaPut":{"required":["dataEntrada","especieDocumento","fornecedor","modeloDocumento","naturezaOperacao","numero","serie","simplesFaturamento","valorTotal"],"type":"object","properties":{"dataEntrada":{"type":"string","description":"Data de Entrada da Nota (YYYY-MM-DD)","format":"date"},"fornecedor":{"maximum":99999,"type":"integer","description":"Código do Fornecedor"},"serie":{"maxLength":3,"type":"string","description":"Código da Série Fiscal"},"numero":{"maximum":9999999999,"type":"integer","description":"Código Numérico da Nota"},"dataEmissao":{"type":"string","description":"Data da Emissão da Nota (YYYY-MM-DD)","format":"date"},"valorMercadoria":{"multipleOf":0.01,"type":"number","description":"Valor da Mercadoria"},"valorDespAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor das Despesas Acessórias"},"valorDespFinanceira":{"multipleOf":0.01,"type":"number","description":"Valor das Despesas Financeiras"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"descontosBonificacao":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto de Bonificação"},"valorTotal":{"multipleOf":0.01,"type":"number","description":"Valor Total da Nota"},"naturezaOperacao":{"maximum":999999,"type":"integer","description":"Código da Natureza de Operação"},"baseIcmsCredito":{"multipleOf":0.01,"type":"number","description":"Base de ICMS de Crédito"},"valorIcmsCredito":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS de Crédito"},"aliquotaIcmsCredito":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS de Crédito"},"valorIsentasIcms":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS Isentas"},"valorOutrasIcms":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS Outras"},"baseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Base de IPI de Crédito"},"valIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor de IPI de Crédito"},"valorIsentasIPI":{"multipleOf":0.01,"type":"number","description":"Valor de IPI Isentas"},"valorOutrasIPI":{"multipleOf":0.01,"type":"number","description":"Valor de IPI Outras"},"especieDocumento":{"type":"integer","description":"Espécie do Documento (1 - Nota Fiscal, 2 - Nota Fiscal com Conhecimento, 3 - Nota Fiscal de Devolução, 4 - Conhecimento, 5 - Fatura Energia Elétrica, 6 - Nota Serviço, 7 - Nota Fiscal Complementar, 8 - Nota Fiscal Retorno Industrialização, 10 - Nota Fiscal Retorno Industrialização com Conhecimento, 11 - Nota Fiscal com Serviço, 12 - Nota Fiscal com Serviço e Conhecimento, 13 - Nota Fiscal Retorno de Industrialização/Serviço, 14 - Nota Fiscal Retorno de Industrialização/Serviço/Conhecimento)","enum":[1,2,3,4,5,6,7,8,10,11,12,13,14]},"situacao":{"type":"integer","description":"Situação (0 - Normal, 1 - Uso futuro, 2 - Cancelada, 3 - Cancelada (Grãos))","enum":[0,1,2,3]},"basePisPasepCredito":{"multipleOf":0.01,"type":"number","description":"Base de PIS/PASEP (Crédito)"},"valorPisPasepCredito":{"multipleOf":0.01,"type":"number","description":"Valor de PIS/PASEP (Crédito)"},"valorISS":{"multipleOf":0.01,"type":"number","description":"Valor de ISS"},"valorINSS":{"multipleOf":0.01,"type":"number","description":"Valor de INSS"},"dataHoraLancamento":{"type":"string","description":"Data e Hora de Lançamento da Nota (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"baseCofinsCredito":{"multipleOf":0.01,"type":"number","description":"Base COFINS (Crédito)"},"valorCofinsCredito":{"multipleOf":0.01,"type":"number","description":"Valor do COFINS (Crédito)"},"valorCsllRetencao":{"multipleOf":0.01,"type":"number","description":"Valor CSLL - Retenção"},"valorPisPasepRetencao":{"multipleOf":0.01,"type":"number","description":"Valor PIS/PASEP (Retenção)"},"valorCofinsRetencao":{"multipleOf":0.01,"type":"number","description":"Valor COFINS (Retenção)"},"valorSubstituicaoTribICMS":{"multipleOf":0.01,"type":"number","description":"Valor Substituição Tributária ICMS a Recolher"},"UFTransportador":{"maxLength":2,"type":"string","description":"UF do Transportador (NF-e)"},"placaVeiculo":{"maxLength":10,"type":"string","description":"Placa do Veículo (NF-e)"},"qtdVolume":{"multipleOf":0.01,"type":"number","description":"Quantidade de Columes (NF-e)"},"pesoBruto":{"multipleOf":0.01,"type":"number","description":"Peso Bruto da Nota (NF-e)"},"pesoLiquido":{"multipleOf":0.01,"type":"number","description":"Peso Líquido da Nota (NF-e)"},"tipoFrete":{"type":"integer","description":"Tipo de Frete (1 - Contratação do Frete por conta do Remetente (CIF), 2 - Contratação do Frete por conta do Destinatário (FOB), 3 - Contratação do Frete por conta de Terceiros, 4 - Transporte Próprio por conta do Remetente, 5 - Transporte Próprio por conta do Destinatário, 9 - Sem Ocorrência de Transporte)","enum":[1,2,3,4,5,9]},"chaveNFe":{"maxLength":44,"type":"string","description":"Chave de Acesso da NF-e"},"valorIcmsOriginal":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Original"},"integradoServicoTerc":{"type":"integer","description":"Integrado com Serviço Terceirizado? (0 - Não, 1 - Sim)","enum":[0,1]},"baseRetencaoISS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção ISS"},"baseRetencaoIRRF":{"multipleOf":0.01,"type":"number","description":"Base de Retenção IRRF"},"baseRetencaoINSS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção INSS"},"baseRetencaoPIS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção PIS"},"baseRetencaoCOFINS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção COFINS"},"baseRetencaoCSLL":{"multipleOf":0.01,"type":"number","description":"Base de Retenção CSLL"},"indNaturezaFrete":{"type":"integer","description":"Indicador da Natureza de Frete (0 - Oper. vendas com ônus suportado vendedor, 1 - Oper. vendas com ônus suportado adquirente, 3 - Oper. compras com bens não geram crédito, 4 - Transf. acabados entre estabelecicmentos, 5 - Transf. elaboração entre estabelecimentos, 9 - Outras)","enum":[0,1,3,4,5,9]},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor de Seguro"},"valorFreteDestacado":{"multipleOf":0.01,"type":"number","description":"Valor do Frete Destacado"},"valorTotIcmsStInformado":{"multipleOf":0.01,"type":"number","description":"Valor total do ICMS-ST informado (Original)"},"baseICMSRetencao":{"multipleOf":0.01,"type":"number","description":"Base de ICMS Retenção"},"valorICMSRetencao":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS Retenção"},"inscricaoEstadual":{"maxLength":17,"type":"string","description":"Inscrição Estadual"},"codMunicipioOrigem":{"maxLength":7,"minLength":7,"type":"string","description":"Código do Município Origem"},"codMunicipioDestino":{"maxLength":7,"minLength":7,"type":"string","description":"Código do Município Destino"},"simplesFaturamento":{"type":"integer","description":"Nota Fiscal de Simples Faturamento Para Entrega Futura (0 - Não, 1 - Sim)","enum":[0,1]},"entradaEntregaFutura":{"type":"integer","description":"Nota Fiscal de Remessa da Entrega Futura (0 - Não, 1 - Sim)","enum":[0,1]},"finalidadeDocumento":{"type":"integer","description":"Finalidade Documento (1 - Normal, 2 - Substituição, 3 - Normal com Ajuste)","enum":[1,2,3]},"chaveNotaReferencia":{"maxLength":44,"minLength":44,"type":"string","description":"Chave da Nota Referenciada"},"modeloDocumento":{"type":"string","description":"Modelo do Documento (01 - Nota Fiscal, 06 - Energia Elétrica, 08 - Conhecimento Transporte, 22 - Telecomunicações, 10 - Frete Aereo, 55 - Nota Fiscal Eletrônica, 57 - Conhecimento Transporte Eletrônico)","enum":["01","06","08","10","22","55","57"]},"valorDiferencaAliquota":{"multipleOf":0.01,"type":"number","description":"Valor da Diferença da Alíquota"},"baseDirfAliq":{"multipleOf":0.01,"type":"number","description":"Base da Diferença da Alíquota"},"condPgto":{"type":"string","description":"Condições de Pagamento"},"valorCreditoPresumidoICMS":{"multipleOf":0.01,"type":"number","description":"Valor Crédito Presumido ICMS"},"baseICMSSub":{"multipleOf":0.01,"type":"number","description":"Base ICMS Substituição Tributária"},"valorICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária"},"baseICMSSubSC":{"multipleOf":0.01,"type":"number","description":"Base ICMS Substituição Tributária com Crédito"},"valorICMSSubSC":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária com Crédito"},"basePreICMS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo de Crédito Presumido ICMS"},"totalValorSTCalculado":{"multipleOf":0.01,"type":"number","description":"Valor Total do ICMS-ST Calculado"},"totalValorSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Valor Total de ICMS-ST Corrigido pelo Sistema (Diferença)"},"itensNotaFiscalEntrada":{"type":"array","description":"Itens da Nota Fiscal de Entrada","items":{"$ref":"#/components/schemas/ItemNotaFiscalEntrada"}},"dadosDevolucao":{"type":"array","description":"Dados de Devolução da Nota Fiscal de Entrada","items":{"$ref":"#/components/schemas/DadosDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalEntrada":{"required":["codItem","codSitTributariaCOFINS","codSitTributariaPIS"],"type":"object","properties":{"codItem":{"maximum":999999,"type":"integer","description":"Sequencia do Item na Nota"},"codMaterial":{"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS para o Item"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI para o Item"},"aliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota do ICMS"},"naturezaOperacao":{"maximum":999999,"type":"integer","description":"Código da Natureza de Operação"},"contaContabil":{"maximum":999999,"type":"integer","description":"Código da Conta Contábil"},"codClassifFiscal":{"maxLength":10,"type":"string","description":"Código da Classificação Fiscal do Material"},"valorReducaoICMS":{"multipleOf":0.01,"type":"number","description":"Valor de Redução do ICMS"},"valorReducaoIPI":{"multipleOf":0.01,"type":"number","description":"Valor de Redução do IPI"},"codigoICMS":{"type":"integer","description":"Código do ICMS (1 - C/ crédito, 2 - S/ crédito, 3 - Outros, 4 - Com crédito C/ custo)","enum":[1,2,3,4]},"codigoIPI":{"type":"integer","description":"Código do IPI (1 - C/ crédito, 2 - S/ crédito, 3 - Outro)","enum":[1,2,3]},"centroCustoValor":{"maxLength":50,"type":"string","description":"Centros de Custo e Valores (Centro de Custo;Valor)"},"valorFreteApropriado":{"multipleOf":0.001,"type":"number","description":"Valor do Frete Apropriado"},"valorICMSApropriado":{"multipleOf":0.001,"type":"number","description":"Valor do ICMS Apropriado"},"valorBaseCalcPisPasep":{"multipleOf":0.01,"type":"number","description":"Valor da Base de Cálculo do PIS/PASEP"},"valorPisPasepRec":{"multipleOf":0.01,"type":"number","description":"Valor do PIS/PASEP a Recuperar"},"quantidadeEstoque":{"multipleOf":0.001,"type":"number","description":"Quantidade de Estoque (Quando unidade de compra maior ou menor que unidade de estoque)"},"codigoServico":{"maximum":999,"type":"integer","description":"Código do serviço (IN68)"},"tipoOperacao":{"maximum":999,"type":"integer","description":"Tipo de operação (IN68)"},"baseCalculoICMS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do ICMS"},"baseCalculoCOFINS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do COFINS"},"valorCOFINS":{"multipleOf":0.01,"type":"number","description":"Valor de Cálculo do COFINS"},"valorPisPasepAprop":{"multipleOf":0.001,"type":"number","description":"Valor do PIS/PASEP Apropriado (Do frete)"},"valorCofinsAprop":{"multipleOf":0.001,"type":"number","description":"Valor do COFINS Apropriado (Do frete)"},"subTribICMS":{"multipleOf":0.01,"type":"number","description":"Valor Substituição Tributária ICMS (ICMS pago antecipado sem destaque na nota)"},"baseICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Substituição Tributária"},"valorICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária"},"sitICMSST":{"type":"integer","description":"Situação ICMS ST (0 - Não Possui, 1 - Com Crédito, 2 - Sem Crédito)","enum":[0,1,2]},"percPis":{"multipleOf":0.01,"type":"number","description":"Percentual de PIS/PASEP"},"percCof":{"multipleOf":0.01,"type":"number","description":"Percentual de COFINS"},"valorBaseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor Base IPI com Crédito"},"codSitTributariaICMS":{"type":"integer","description":"Código da Situação Tributária ICMS"},"valorIcmsOriginal":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Original"},"codSitTributariaPIS":{"maxLength":3,"type":"string","description":"Código Situação Tributária PIS"},"codSitTributariaCOFINS":{"maxLength":3,"type":"string","description":"Código Situação Tributária COFINS"},"unidadeCompra":{"maxLength":3,"type":"string","description":"Unidade de Medida de Compra"},"fatorConversao":{"maxLength":10,"type":"string","description":"Fator de Conversão da Unidade de Medida de Compra [Deprecated]"},"fatorConversaoQuantidade":{"multipleOf":0.01,"type":"number","description":"Quantidade Fator de Conversão da Unidade de Medida de Compra"},"fatorConversaoOperador":{"type":"integer","description":"Operador Fator de Conversão da Unidade de Medida de Compra (0 - Multiplicação / 1 - Divisão)","enum":[0,1]},"codListaServicos":{"type":"integer","description":"Código da Lista de Serviços"},"baseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor IPI Base de Cálculo com Crédito"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual Aliquota do IPI"},"CSTIpi":{"maxLength":2,"type":"string","description":"CST do IPI"},"tipoBaseCreditoPIS":{"type":"string","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"]},"tipoBaseCreditoCofins":{"type":"string","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"]},"valorSTInformado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS-ST Informado (Original)"},"valorSTCalculado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS-ST Calculado"},"baseSTInformado":{"multipleOf":0.01,"type":"number","description":"Base ICMS-ST Informado (Original)"},"baseSTCalculado":{"multipleOf":0.01,"type":"number","description":"Base ICMS-ST Calculado"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"tipoCSTICMS":{"type":"integer","description":"Tipo de CST de ICMS (0 - CST Normal, 1 - Simples)","enum":[0,1]},"valorICMSPartOrigem":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Diferencial de Alíquota Partilhado - UF Remetente"},"valorICMSPartDestino":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Diferencial de Alíquota Partilhado - UF Destinatário"},"valorICMSFCP":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS - Fundo Combate Pobreza"},"valorFCPICMS":{"multipleOf":0.01,"type":"number","description":"Valor FCP (Fundo Combate Pobreza) ICMS"},"valorFCPICMSST":{"multipleOf":0.01,"type":"number","description":"Valor FCP (Fundo Combate Pobreza) ICMS-ST"},"custoEntrada":{"multipleOf":0.01,"type":"number","description":"Custo Unitário de Entrada"},"baseContabilizacao":{"multipleOf":0.01,"type":"number","description":"Base para Contabilização"},"descricaoItem":{"maxLength":30,"type":"string","description":"Descrição do Item caso Código do Material não Seja Informado"},"unidadeMedida":{"maxLength":3,"type":"string","description":"Unidade de Medida caso Código do Material não Seja Informado"},"obsItemDespesa":{"maxLength":30,"type":"string","description":"Observação de Despesa do Item"},"credPresICMS":{"multipleOf":0.01,"type":"number","description":"Valor Crédito Presumido de ICMS"},"valorUniCCI":{"multipleOf":0.01,"type":"number","description":"Valor Unitário (utilizado no retorno de OPs com conta corrente de itens)"},"baseICMSTrib":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Tributado"},"baseICMSIsenta":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Isenta"},"baseICMSOutras":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Outras"},"valorSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS-ST Corrigido pelo Sistema (Diferença)"},"baseSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Base de ICMS-ST Corrigido pelo Sistema (Diferença)"}}},"DadosDevolucao":{"required":["chaveNFeSaidaReferencia"],"type":"object","properties":{"chaveNFeSaidaReferencia":{"maxLength":44,"minLength":44,"type":"string","description":"Chave da NF-e de Saída Referência"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaNotasFiscaisEntrada object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ListaNotasFiscaisEntrada":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/NotaFiscalEntrada"}}}},"NotaFiscalEntrada":{"type":"object","properties":{"dataEntrada":{"type":"string","description":"Data de Entrada da Nota (YYYY-MM-DD)","format":"date"},"fornecedor":{"type":"integer","description":"Código do Fornecedor"},"serie":{"type":"string","description":"Código da Série Fiscal"},"numero":{"type":"integer","description":"Código Numérico da Nota"},"dataEmissao":{"type":"string","description":"Data da Emissão da Nota (YYYY-MM-DD)","format":"date"},"valorMercadoria":{"multipleOf":0.01,"type":"number","description":"Valor da Mercadoria"},"valorDespAcessorias":{"multipleOf":0.01,"type":"number","description":"Valor das Despesas Acessórias"},"valorDespFinanceira":{"multipleOf":0.01,"type":"number","description":"Valor das Despesas Financeiras"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI"},"descontosBonificacao":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto de Bonificação"},"valorTotal":{"multipleOf":0.01,"type":"number","description":"Valor Total da Nota"},"naturezaOperacao":{"type":"string","description":"Código da Natureza de Operaçaõ"},"baseIcmsCredito":{"multipleOf":0.01,"type":"number","description":"Base de ICMS de Crédito"},"valorIcmsCredito":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS de Crédito"},"aliquotaIcmsCredito":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS de Crédito"},"valorIsentasIcms":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS Isentas"},"valorOutrasIcms":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS Outras"},"baseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Base de IPI de Crédito"},"valIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor de IPI de Crédito"},"valorIsentasIPI":{"multipleOf":0.01,"type":"number","description":"Valor de IPI Isentas"},"valorOutrasIPI":{"multipleOf":0.01,"type":"number","description":"Valor de IPI Outras"},"especieDocumento":{"type":"integer","description":"Espécie do Documento (1 - Nota Fiscal, 2 - Nota Fiscal com Conhecimento, 3 - Nota Fiscal de Devolução, 4 - Conhecimento, 5 - Fatura Energia Elétrica, 6 - Nota Serviço, 7 - Nota Fiscal Complementar, 8 - Nota Fiscal Retorno Industrialização, 10 - Nota Fiscal Retorno Industrialização com Conhecimento, 11 - Nota Fiscal com Serviço, 12 - Nota Fiscal com Serviço e Conhecimento, 13 - Nota Fiscal Retorno de Industrialização/Serviço, 14 - Nota Fiscal Retorno de Industrialização/Serviço/Conhecimento)","enum":[1,2,3,4,5,6,7,8,10,11,12,13,14]},"situacao":{"type":"integer","description":"Situação (0 - Normal, 1 - Uso futuro, 2 - Cancelada, 3 - Cancelada (Grãos))","enum":[0,1,2,3]},"basePisPasepCredito":{"multipleOf":0.01,"type":"number","description":"Base de PIS/PASEP (Crédito)"},"valorPisPasepCredito":{"multipleOf":0.01,"type":"number","description":"Valor de PIS/PASEP (Crédito)"},"valorISS":{"multipleOf":0.01,"type":"number","description":"Valor de ISS"},"valorINSS":{"multipleOf":0.01,"type":"number","description":"Valor de INSS"},"dataHoraLancamento":{"type":"string","description":"Data e Hora de Lançamento da Nota (YYYY-MM-DDTHH:mm:ss.sssZ)","format":"date-time"},"baseCofinsCredito":{"multipleOf":0.01,"type":"number","description":"Base COFINS (Crédito)"},"valorCofinsCredito":{"multipleOf":0.01,"type":"number","description":"Valor do COFINS (Crédito)"},"valorCsllRetencao":{"multipleOf":0.01,"type":"number","description":"Valor CSLL - Retenção"},"valorPisPasepRetencao":{"multipleOf":0.01,"type":"number","description":"Valor PIS/PASEP (Retenção)"},"valorCofinsRetencao":{"multipleOf":0.01,"type":"number","description":"Valor COFINS (Retenção)"},"valorSubstituicaoTribICMS":{"multipleOf":0.01,"type":"number","description":"Valor Substituição Tributária ICMS a Recolher"},"UFTransportador":{"maxLength":2,"type":"string","description":"UF do Transportador (NF-e)"},"placaVeiculo":{"maxLength":10,"type":"string","description":"Placa do Veículo (NF-e)"},"qtdVolume":{"multipleOf":0.01,"type":"number","description":"Quantidade de Columes (NF-e)"},"pesoBruto":{"multipleOf":0.01,"type":"number","description":"Peso Bruto da Nota (NF-e)"},"pesoLiquido":{"multipleOf":0.01,"type":"number","description":"Peso Líquido da Nota (NF-e)"},"tipoFrete":{"type":"integer","description":"Tipo de Frete (1 - Contratação do Frete por conta do Remetente (CIF), 2 - Contratação do Frete por conta do Destinatário (FOB), 3 - Contratação do Frete por conta de Terceiros, 4 - Transporte Próprio por conta do Remetente, 5 - Transporte Próprio por conta do Destinatário, 9 - Sem Ocorrência de Transporte)","enum":[1,2,3,4,5,9]},"chaveNFe":{"maxLength":44,"type":"string","description":"Chave de Acesso da NF-e"},"valorIcmsOriginal":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Original"},"integradoServicoTerc":{"type":"integer","description":"Integrado com Serviço Terceirizado? (0 - Não, 1 - Sim)","enum":[0,1]},"baseRetencaoISS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção ISS"},"baseRetencaoIRRF":{"multipleOf":0.01,"type":"number","description":"Base de Retenção IRRF"},"baseRetencaoINSS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção INSS"},"baseRetencaoPIS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção PIS"},"baseRetencaoCOFINS":{"multipleOf":0.01,"type":"number","description":"Base de Retenção COFINS"},"baseRetencaoCSLL":{"multipleOf":0.01,"type":"number","description":"Base de Retenção CSLL"},"indNaturezaFrete":{"type":"integer","description":"Indicador da Natureza de Frete (0 - Oper. vendas com ônus suportado vendedor, 1 - Oper. vendas com ônus suportado adquirente, 3 - Oper. compras com bens não geram crédito, 4 - Transf. acabados entre estabelecicmentos, 5 - Transf. elaboração entre estabelecimentos, 9 - Outras)","enum":[0,1,3,4,5,9]},"valorSeguro":{"multipleOf":0.01,"type":"number","description":"Valor de Seguro"},"valorFreteDestacado":{"multipleOf":0.01,"type":"number","description":"Valor do Frete Destacado"},"valorTotIcmsStInformado":{"multipleOf":0.01,"type":"number","description":"Valor total do ICMS-ST informado (Original)"},"baseICMSRetencao":{"multipleOf":0.01,"type":"number","description":"Base de ICMS Retenção"},"valorICMSRetencao":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS Retenção"},"inscricaoEstadual":{"maxLength":17,"type":"string","description":"Inscrição Estadual"},"codMunicipioOrigem":{"type":"string","description":"Código do Município Origem"},"codMunicipioDestino":{"type":"string","description":"Código do Município Destino"},"simplesFaturamento":{"type":"integer","description":"Nota Fiscal de Simples Faturamento Para Entrega Futura (0 - Não, 1 - Sim)","enum":[0,1]},"entradaEntregaFutura":{"type":"integer","description":"Nota Fiscal de Remessa da Entrega Futura (0 - Não, 1 - Sim)","enum":[0,1]},"finalidadeDocumento":{"type":"integer","description":"Finalidade Documento (1 - Normal, 2 - Substituição, 3 - Normal com Ajuste)","enum":[1,2,3]},"chaveNotaReferencia":{"type":"string","description":"Chave da Nota Referenciada"},"modeloDocumento":{"type":"string","description":"Modelo do Documento (01 - Nota Fiscal, 06 - Energia Elétrica, 08 - Conhecimento Transporte, 22 - Telecomunicações, 10 - Frete Aereo, 55 - Nota Fiscal Eletrônica, 57 - Conhecimento Transporte Eletrônico)","enum":["01","06","08","10","22","55","57"]},"valorDiferencaAliquota":{"multipleOf":0.01,"type":"number","description":"Valor da Diferença da Alíquota"},"baseDirfAliq":{"multipleOf":0.01,"type":"number","description":"Base da Diferença da Alíquota"},"condPgto":{"type":"string","description":"Condições de Pagamento"},"valorCreditoPresumidoICMS":{"multipleOf":0.01,"type":"number","description":"Valor Crédito presumido ICMS"},"baseICMSSub":{"multipleOf":0.01,"type":"number","description":"Base ICMS Substituição Tributária"},"valorICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária"},"baseICMSSubSC":{"multipleOf":0.01,"type":"number","description":"Base ICMS Substituição Tributária com Crédito"},"valorICMSSubSC":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária com Crédito"},"basePreICMS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo de Crédito Presumido ICMS"},"totalValorSTCalculado":{"multipleOf":0.01,"type":"number","description":"Valor Total do ICMS-ST Calculado"},"totalValorSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Valor Total de ICMS-ST Corrigido pelo Sistema (Diferença)"},"itensNotaFiscalEntrada":{"type":"array","description":"Itens da Nota Fiscal de Entrada","items":{"$ref":"#/components/schemas/ItemNotaFiscalEntrada"}},"dadosDevolucao":{"type":"array","description":"Dados de Devolução da Nota Fiscal de Entrada","items":{"$ref":"#/components/schemas/DadosDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItemNotaFiscalEntrada":{"required":["codItem","codSitTributariaCOFINS","codSitTributariaPIS"],"type":"object","properties":{"codItem":{"maximum":999999,"type":"integer","description":"Sequencia do Item na Nota"},"codMaterial":{"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS para o Item"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI para o Item"},"aliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota do ICMS"},"naturezaOperacao":{"maximum":999999,"type":"integer","description":"Código da Natureza de Operação"},"contaContabil":{"maximum":999999,"type":"integer","description":"Código da Conta Contábil"},"codClassifFiscal":{"maxLength":10,"type":"string","description":"Código da Classificação Fiscal do Material"},"valorReducaoICMS":{"multipleOf":0.01,"type":"number","description":"Valor de Redução do ICMS"},"valorReducaoIPI":{"multipleOf":0.01,"type":"number","description":"Valor de Redução do IPI"},"codigoICMS":{"type":"integer","description":"Código do ICMS (1 - C/ crédito, 2 - S/ crédito, 3 - Outros, 4 - Com crédito C/ custo)","enum":[1,2,3,4]},"codigoIPI":{"type":"integer","description":"Código do IPI (1 - C/ crédito, 2 - S/ crédito, 3 - Outro)","enum":[1,2,3]},"centroCustoValor":{"maxLength":50,"type":"string","description":"Centros de Custo e Valores (Centro de Custo;Valor)"},"valorFreteApropriado":{"multipleOf":0.001,"type":"number","description":"Valor do Frete Apropriado"},"valorICMSApropriado":{"multipleOf":0.001,"type":"number","description":"Valor do ICMS Apropriado"},"valorBaseCalcPisPasep":{"multipleOf":0.01,"type":"number","description":"Valor da Base de Cálculo do PIS/PASEP"},"valorPisPasepRec":{"multipleOf":0.01,"type":"number","description":"Valor do PIS/PASEP a Recuperar"},"quantidadeEstoque":{"multipleOf":0.001,"type":"number","description":"Quantidade de Estoque (Quando unidade de compra maior ou menor que unidade de estoque)"},"codigoServico":{"maximum":999,"type":"integer","description":"Código do serviço (IN68)"},"tipoOperacao":{"maximum":999,"type":"integer","description":"Tipo de operação (IN68)"},"baseCalculoICMS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do ICMS"},"baseCalculoCOFINS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do COFINS"},"valorCOFINS":{"multipleOf":0.01,"type":"number","description":"Valor de Cálculo do COFINS"},"valorPisPasepAprop":{"multipleOf":0.001,"type":"number","description":"Valor do PIS/PASEP Apropriado (Do frete)"},"valorCofinsAprop":{"multipleOf":0.001,"type":"number","description":"Valor do COFINS Apropriado (Do frete)"},"subTribICMS":{"multipleOf":0.01,"type":"number","description":"Valor Substituição Tributária ICMS (ICMS pago antecipado sem destaque na nota)"},"baseICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Substituição Tributária"},"valorICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária"},"sitICMSST":{"type":"integer","description":"Situação ICMS ST (0 - Não Possui, 1 - Com Crédito, 2 - Sem Crédito)","enum":[0,1,2]},"percPis":{"multipleOf":0.01,"type":"number","description":"Percentual de PIS/PASEP"},"percCof":{"multipleOf":0.01,"type":"number","description":"Percentual de COFINS"},"valorBaseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor Base IPI com Crédito"},"codSitTributariaICMS":{"type":"integer","description":"Código da Situação Tributária ICMS"},"valorIcmsOriginal":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Original"},"codSitTributariaPIS":{"maxLength":3,"type":"string","description":"Código Situação Tributária PIS"},"codSitTributariaCOFINS":{"maxLength":3,"type":"string","description":"Código Situação Tributária COFINS"},"unidadeCompra":{"maxLength":3,"type":"string","description":"Unidade de Medida de Compra"},"fatorConversao":{"maxLength":10,"type":"string","description":"Fator de Conversão da Unidade de Medida de Compra [Deprecated]"},"fatorConversaoQuantidade":{"multipleOf":0.01,"type":"number","description":"Quantidade Fator de Conversão da Unidade de Medida de Compra"},"fatorConversaoOperador":{"type":"integer","description":"Operador Fator de Conversão da Unidade de Medida de Compra (0 - Multiplicação / 1 - Divisão)","enum":[0,1]},"codListaServicos":{"type":"integer","description":"Código da Lista de Serviços"},"baseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor IPI Base de Cálculo com Crédito"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual Aliquota do IPI"},"CSTIpi":{"maxLength":2,"type":"string","description":"CST do IPI"},"tipoBaseCreditoPIS":{"type":"string","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"]},"tipoBaseCreditoCofins":{"type":"string","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"]},"valorSTInformado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS-ST Informado (Original)"},"valorSTCalculado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS-ST Calculado"},"baseSTInformado":{"multipleOf":0.01,"type":"number","description":"Base ICMS-ST Informado (Original)"},"baseSTCalculado":{"multipleOf":0.01,"type":"number","description":"Base ICMS-ST Calculado"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"tipoCSTICMS":{"type":"integer","description":"Tipo de CST de ICMS (0 - CST Normal, 1 - Simples)","enum":[0,1]},"valorICMSPartOrigem":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Diferencial de Alíquota Partilhado - UF Remetente"},"valorICMSPartDestino":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Diferencial de Alíquota Partilhado - UF Destinatário"},"valorICMSFCP":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS - Fundo Combate Pobreza"},"valorFCPICMS":{"multipleOf":0.01,"type":"number","description":"Valor FCP (Fundo Combate Pobreza) ICMS"},"valorFCPICMSST":{"multipleOf":0.01,"type":"number","description":"Valor FCP (Fundo Combate Pobreza) ICMS-ST"},"custoEntrada":{"multipleOf":0.01,"type":"number","description":"Custo Unitário de Entrada"},"baseContabilizacao":{"multipleOf":0.01,"type":"number","description":"Base para Contabilização"},"descricaoItem":{"maxLength":30,"type":"string","description":"Descrição do Item caso Código do Material não Seja Informado"},"unidadeMedida":{"maxLength":3,"type":"string","description":"Unidade de Medida caso Código do Material não Seja Informado"},"obsItemDespesa":{"maxLength":30,"type":"string","description":"Observação de Despesa do Item"},"credPresICMS":{"multipleOf":0.01,"type":"number","description":"Valor Crédito Presumido de ICMS"},"valorUniCCI":{"multipleOf":0.01,"type":"number","description":"Valor Unitário (utilizado no retorno de OPs com conta corrente de itens)"},"baseICMSTrib":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Tributado"},"baseICMSIsenta":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Isenta"},"baseICMSOutras":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Outras"},"valorSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS-ST Corrigido pelo Sistema (Diferença)"},"baseSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Base de ICMS-ST Corrigido pelo Sistema (Diferença)"}}},"DadosDevolucao":{"required":["chaveNFeSaidaReferencia"],"type":"object","properties":{"chaveNFeSaidaReferencia":{"maxLength":44,"minLength":44,"type":"string","description":"Chave da NF-e de Saída Referência"}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItemNotaFiscalEntrada object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ItemNotaFiscalEntrada":{"required":["codItem","codSitTributariaCOFINS","codSitTributariaPIS"],"type":"object","properties":{"codItem":{"maximum":999999,"type":"integer","description":"Sequencia do Item na Nota"},"codMaterial":{"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"type":"number","description":"Quantidade do Produto"},"valorTotalItem":{"multipleOf":0.01,"type":"number","description":"Valor Total do Item"},"valorICMS":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS para o Item"},"valorIPI":{"multipleOf":0.01,"type":"number","description":"Valor do IPI para o Item"},"aliquotaICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota do ICMS"},"naturezaOperacao":{"maximum":999999,"type":"integer","description":"Código da Natureza de Operação"},"contaContabil":{"maximum":999999,"type":"integer","description":"Código da Conta Contábil"},"codClassifFiscal":{"maxLength":10,"type":"string","description":"Código da Classificação Fiscal do Material"},"valorReducaoICMS":{"multipleOf":0.01,"type":"number","description":"Valor de Redução do ICMS"},"valorReducaoIPI":{"multipleOf":0.01,"type":"number","description":"Valor de Redução do IPI"},"codigoICMS":{"type":"integer","description":"Código do ICMS (1 - C/ crédito, 2 - S/ crédito, 3 - Outros, 4 - Com crédito C/ custo)","enum":[1,2,3,4]},"codigoIPI":{"type":"integer","description":"Código do IPI (1 - C/ crédito, 2 - S/ crédito, 3 - Outro)","enum":[1,2,3]},"centroCustoValor":{"maxLength":50,"type":"string","description":"Centros de Custo e Valores (Centro de Custo;Valor)"},"valorFreteApropriado":{"multipleOf":0.001,"type":"number","description":"Valor do Frete Apropriado"},"valorICMSApropriado":{"multipleOf":0.001,"type":"number","description":"Valor do ICMS Apropriado"},"valorBaseCalcPisPasep":{"multipleOf":0.01,"type":"number","description":"Valor da Base de Cálculo do PIS/PASEP"},"valorPisPasepRec":{"multipleOf":0.01,"type":"number","description":"Valor do PIS/PASEP a Recuperar"},"quantidadeEstoque":{"multipleOf":0.001,"type":"number","description":"Quantidade de Estoque (Quando unidade de compra maior ou menor que unidade de estoque)"},"codigoServico":{"maximum":999,"type":"integer","description":"Código do serviço (IN68)"},"tipoOperacao":{"maximum":999,"type":"integer","description":"Tipo de operação (IN68)"},"baseCalculoICMS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do ICMS"},"baseCalculoCOFINS":{"multipleOf":0.01,"type":"number","description":"Base de Cálculo do COFINS"},"valorCOFINS":{"multipleOf":0.01,"type":"number","description":"Valor de Cálculo do COFINS"},"valorPisPasepAprop":{"multipleOf":0.001,"type":"number","description":"Valor do PIS/PASEP Apropriado (Do frete)"},"valorCofinsAprop":{"multipleOf":0.001,"type":"number","description":"Valor do COFINS Apropriado (Do frete)"},"subTribICMS":{"multipleOf":0.01,"type":"number","description":"Valor Substituição Tributária ICMS (ICMS pago antecipado sem destaque na nota)"},"baseICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Substituição Tributária"},"valorICMSSub":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Substituição Tributária"},"sitICMSST":{"type":"integer","description":"Situação ICMS ST (0 - Não Possui, 1 - Com Crédito, 2 - Sem Crédito)","enum":[0,1,2]},"percPis":{"multipleOf":0.01,"type":"number","description":"Percentual de PIS/PASEP"},"percCof":{"multipleOf":0.01,"type":"number","description":"Percentual de COFINS"},"valorBaseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor Base IPI com Crédito"},"codSitTributariaICMS":{"type":"integer","description":"Código da Situação Tributária ICMS"},"valorIcmsOriginal":{"multipleOf":0.01,"type":"number","description":"Valor ICMS Original"},"codSitTributariaPIS":{"maxLength":3,"type":"string","description":"Código Situação Tributária PIS"},"codSitTributariaCOFINS":{"maxLength":3,"type":"string","description":"Código Situação Tributária COFINS"},"unidadeCompra":{"maxLength":3,"type":"string","description":"Unidade de Medida de Compra"},"fatorConversao":{"maxLength":10,"type":"string","description":"Fator de Conversão da Unidade de Medida de Compra [Deprecated]"},"fatorConversaoQuantidade":{"multipleOf":0.01,"type":"number","description":"Quantidade Fator de Conversão da Unidade de Medida de Compra"},"fatorConversaoOperador":{"type":"integer","description":"Operador Fator de Conversão da Unidade de Medida de Compra (0 - Multiplicação / 1 - Divisão)","enum":[0,1]},"codListaServicos":{"type":"integer","description":"Código da Lista de Serviços"},"baseIpiCredito":{"multipleOf":0.01,"type":"number","description":"Valor IPI Base de Cálculo com Crédito"},"percIPI":{"multipleOf":0.01,"type":"number","description":"Percentual Aliquota do IPI"},"CSTIpi":{"maxLength":2,"type":"string","description":"CST do IPI"},"tipoBaseCreditoPIS":{"type":"string","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"]},"tipoBaseCreditoCofins":{"type":"string","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"]},"valorSTInformado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS-ST Informado (Original)"},"valorSTCalculado":{"multipleOf":0.01,"type":"number","description":"Valor ICMS-ST Calculado"},"baseSTInformado":{"multipleOf":0.01,"type":"number","description":"Base ICMS-ST Informado (Original)"},"baseSTCalculado":{"multipleOf":0.01,"type":"number","description":"Base ICMS-ST Calculado"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor do Desconto"},"tipoCSTICMS":{"type":"integer","description":"Tipo de CST de ICMS (0 - CST Normal, 1 - Simples)","enum":[0,1]},"valorICMSPartOrigem":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Diferencial de Alíquota Partilhado - UF Remetente"},"valorICMSPartDestino":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS Diferencial de Alíquota Partilhado - UF Destinatário"},"valorICMSFCP":{"multipleOf":0.01,"type":"number","description":"Valor do ICMS - Fundo Combate Pobreza"},"valorFCPICMS":{"multipleOf":0.01,"type":"number","description":"Valor FCP (Fundo Combate Pobreza) ICMS"},"valorFCPICMSST":{"multipleOf":0.01,"type":"number","description":"Valor FCP (Fundo Combate Pobreza) ICMS-ST"},"custoEntrada":{"multipleOf":0.01,"type":"number","description":"Custo Unitário de Entrada"},"baseContabilizacao":{"multipleOf":0.01,"type":"number","description":"Base para Contabilização"},"descricaoItem":{"maxLength":30,"type":"string","description":"Descrição do Item caso Código do Material não Seja Informado"},"unidadeMedida":{"maxLength":3,"type":"string","description":"Unidade de Medida caso Código do Material não Seja Informado"},"obsItemDespesa":{"maxLength":30,"type":"string","description":"Observação de Despesa do Item"},"credPresICMS":{"multipleOf":0.01,"type":"number","description":"Valor Crédito Presumido de ICMS"},"valorUniCCI":{"multipleOf":0.01,"type":"number","description":"Valor Unitário (utilizado no retorno de OPs com conta corrente de itens)"},"baseICMSTrib":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Tributado"},"baseICMSIsenta":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Isenta"},"baseICMSOutras":{"multipleOf":0.01,"type":"number","description":"Valor Base ICMS Outras"},"valorSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Valor de ICMS-ST Corrigido pelo Sistema (Diferença)"},"baseSTDiferenca":{"multipleOf":0.01,"type":"number","description":"Base de ICMS-ST Corrigido pelo Sistema (Diferença)"}}}}}} ``` ## The DadosDevolucao object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"DadosDevolucao":{"required":["chaveNFeSaidaReferencia"],"type":"object","properties":{"chaveNFeSaidaReferencia":{"maxLength":44,"minLength":44,"type":"string","description":"Chave da NF-e de Saída Referência"}}}}}} ``` ## The SolicitacaoCompraPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"SolicitacaoCompraPut":{"required":["codFinalidade","codPerfilSolicitante","dataSolicitacao","ratearCusto","solicitarLiberacao","tipoSolicitacao"],"type":"object","properties":{"codPerfilSolicitante":{"maximum":999999,"type":"integer","description":"Perfil do Solicitante"},"tipoSolicitacao":{"type":"integer","description":"Tipo da Solicitação (1-Compra, 2-Orçamento)","enum":[1,2]},"ratearCusto":{"type":"boolean","description":"Ratear Custo (0-Não, 1-Sim)"},"centroCustosSolCompra":{"maxLength":25,"type":"string","description":"Centro de Custos"},"codSolicitante":{"maximum":99999,"type":"integer","description":"Operador que Cadastrou a Solicitação de Compra"},"dataSolicitacao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"codFinalidade":{"maximum":999,"type":"integer","description":"Código da Finalidade"},"codUrgencia":{"maximum":999,"type":"integer","description":"Código da Urgência de Entrega dos Itens"},"solicitarLiberacao":{"type":"boolean","description":"Solicitar Liberação da Solicitação de Compras? (0-Não, 1-Sim)"},"solicitacaoCentrosCustosRateio":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/SolicitacaoCentrosCustosRateioPut"}},"itensSolicitacaoCompras":{"type":"array","description":"Itens da Solicitação de Compra","items":{"$ref":"#/components/schemas/ItensSolCompraPut"}}}},"SolicitacaoCentrosCustosRateioPut":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"ItensSolCompraPut":{"required":["prazoEntrega"],"type":"object","properties":{"seqItem":{"maximum":9999,"type":"integer","description":"Sequência do Item"},"codProduto":{"type":"string","description":"Código do Produto"},"descProduto":{"maxLength":150,"type":"string","description":"Descrição do Produto ( Caso codProduto for nulo)"},"unidadeCompra":{"maxLength":6,"type":"string","description":"Unidade de Compra"},"qtdEstoque":{"multipleOf":0.001,"type":"number","description":"Quantidade para Estoque"},"qtdCompra":{"multipleOf":0.001,"type":"number","description":"Quantidade Compras"},"ratearCusto":{"type":"boolean","description":"Ratear Custo (0-Não, 1-Sim)"},"centroCustosItemSolCompra":{"maxLength":25,"type":"string","description":"Centro de Custos"},"itensSolicitacaoCentrosCustosRateio":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/ItensSolicitacaoCentrosCustosRateioPut"}},"itensSolicitacaoContaContabilCentrosCustosRateio":{"type":"array","description":"Conta(s) Contabil(eis) para Rateio","items":{"$ref":"#/components/schemas/RateioContaContabil"}},"prazoEntrega":{"type":"string","description":"Prazo de Entrega (YYYY-MM-DD)","format":"date"},"marcaPreferencial":{"maxLength":20,"type":"string","description":"Marca Preferencial"},"fornecedorPrincipal":{"maxLength":30,"type":"string","description":"Fornecedor Principal"},"contaContabil":{"maximum":99999,"type":"integer","description":"Conta Contábil"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"codUrgencia":{"maximum":99999,"type":"integer","description":"Nível de Urgência"},"valorEstimado":{"multipleOf":0.01,"type":"number","description":"Valor Estimado"},"itensSolicitacaoObservacao":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/ItensSolicitacaoObservacaoPut"}}}},"ItensSolicitacaoCentrosCustosRateioPut":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"ItensSolicitacaoObservacaoPut":{"type":"object","properties":{"observacao":{"maxLength":1000,"type":"string","description":"Observação"}}}}}} ``` ## The SolicitacaoCentrosCustosRateioPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"SolicitacaoCentrosCustosRateioPut":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}}}}} ``` ## The ItensSolCompraPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ItensSolCompraPut":{"required":["prazoEntrega"],"type":"object","properties":{"seqItem":{"maximum":9999,"type":"integer","description":"Sequência do Item"},"codProduto":{"type":"string","description":"Código do Produto"},"descProduto":{"maxLength":150,"type":"string","description":"Descrição do Produto ( Caso codProduto for nulo)"},"unidadeCompra":{"maxLength":6,"type":"string","description":"Unidade de Compra"},"qtdEstoque":{"multipleOf":0.001,"type":"number","description":"Quantidade para Estoque"},"qtdCompra":{"multipleOf":0.001,"type":"number","description":"Quantidade Compras"},"ratearCusto":{"type":"boolean","description":"Ratear Custo (0-Não, 1-Sim)"},"centroCustosItemSolCompra":{"maxLength":25,"type":"string","description":"Centro de Custos"},"itensSolicitacaoCentrosCustosRateio":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/ItensSolicitacaoCentrosCustosRateioPut"}},"itensSolicitacaoContaContabilCentrosCustosRateio":{"type":"array","description":"Conta(s) Contabil(eis) para Rateio","items":{"$ref":"#/components/schemas/RateioContaContabil"}},"prazoEntrega":{"type":"string","description":"Prazo de Entrega (YYYY-MM-DD)","format":"date"},"marcaPreferencial":{"maxLength":20,"type":"string","description":"Marca Preferencial"},"fornecedorPrincipal":{"maxLength":30,"type":"string","description":"Fornecedor Principal"},"contaContabil":{"maximum":99999,"type":"integer","description":"Conta Contábil"},"numOS":{"maximum":999999,"type":"integer","description":"Número da Ordem de Serviço"},"codUrgencia":{"maximum":99999,"type":"integer","description":"Nível de Urgência"},"valorEstimado":{"multipleOf":0.01,"type":"number","description":"Valor Estimado"},"itensSolicitacaoObservacao":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/ItensSolicitacaoObservacaoPut"}}}},"ItensSolicitacaoCentrosCustosRateioPut":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"ItensSolicitacaoObservacaoPut":{"type":"object","properties":{"observacao":{"maxLength":1000,"type":"string","description":"Observação"}}}}}} ``` ## The ItensSolicitacaoCentrosCustosRateioPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ItensSolicitacaoCentrosCustosRateioPut":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}}}}} ``` ## The RateioContaContabil object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}}}}} ``` ## The RateioCentroCustoContaContabil object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}}}}} ``` ## The ItensSolicitacaoObservacaoPut object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ItensSolicitacaoObservacaoPut":{"type":"object","properties":{"observacao":{"maxLength":1000,"type":"string","description":"Observação"}}}}}} ``` ## The ListaSolicitacaoCompraGerada object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ListaSolicitacaoCompraGerada":{"type":"object","properties":{"codSolicitacao":{"type":"integer","description":"Código da Solicitação de Compras"}}}}}} ``` ## The ListaSolicitacoesCompra object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ListaSolicitacoesCompra":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"solicitacoesCompra":{"type":"array","items":{"$ref":"#/components/schemas/SolicitacoesCompra"}}}},"SolicitacoesCompra":{"type":"object","properties":{"codSolicitacao":{"type":"integer","description":"Código da Solicitação de Compras"},"tipoSolicitacao":{"type":"integer","description":"Tipo da Solicitação (1-Compra, 2-Orçamento)","enum":[1,2]},"codPerfilSolicitante":{"type":"integer","description":"Perfil do Solicitante"},"codSolicitante":{"type":"integer","description":"Operador que Cadastrou a Solicitação de Compras"},"dataSolicitacao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"}}}}}} ``` ## The SolicitacoesCompra object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"SolicitacoesCompra":{"type":"object","properties":{"codSolicitacao":{"type":"integer","description":"Código da Solicitação de Compras"},"tipoSolicitacao":{"type":"integer","description":"Tipo da Solicitação (1-Compra, 2-Orçamento)","enum":[1,2]},"codPerfilSolicitante":{"type":"integer","description":"Perfil do Solicitante"},"codSolicitante":{"type":"integer","description":"Operador que Cadastrou a Solicitação de Compras"},"dataSolicitacao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"}}}}}} ``` ## The ListaSolicitacaoCompra object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ListaSolicitacaoCompra":{"type":"object","properties":{"codSolicitacao":{"type":"integer","description":"Código da Solicitação de Compras"},"tipoSolicitacao":{"type":"integer","description":"Tipo da Solicitação (1-Compra, 2-Orçamento)","enum":[1,2]},"codPerfilSolicitante":{"type":"integer","description":"Perfil do Solicitante"},"codSolicitante":{"type":"integer","description":"Operador que Cadastrou a Solicitação de Compras"},"dataSolicitacao":{"type":"string","description":"Data da Emissão (YYYY-MM-DD)","format":"date"},"ratearCusto":{"type":"boolean","description":"Ratear Custo (0-Não, 1-Sim)"},"solicitacaoCentrosCustos":{"maxLength":25,"type":"string","description":"Centro de Custos da Solicitação de Compras"},"solicitacaoCentrosCustosRateio":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/SolicitacaoCentrosCustosRateioGet"}},"itensSolicitacaoCompras":{"type":"array","description":"Itens da Solicitação de Compras","items":{"$ref":"#/components/schemas/ItensSolCompraGet"}}}},"SolicitacaoCentrosCustosRateioGet":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"ItensSolCompraGet":{"type":"object","properties":{"seqItem":{"type":"integer","description":"Sequência do Item"},"codProduto":{"type":"string","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"qtdSolicitada":{"multipleOf":0.001,"type":"number","description":"Quantidade Solicitada"},"unidadeCompra":{"type":"string","description":"Unidade de Compra"},"unidadeEstoque":{"type":"string","description":"Unidade de Estoque"},"situacaoCompra":{"type":"integer","description":"Situação da Solicitação no Processo de Compra do Item (1-Em Aberto, 2-Em Cotação, 3-Cotada, 4-Realizada, 5-Atendida, 6 Cancelada)","enum":[1,2,3,4,5,6]},"situacaoBloqueio":{"type":"integer","description":"Situação Ref. Bloqueio de Itens de Despesa (0-Liberada, 1-Bloqueada, 2-Digitado, 3-Retornado)","enum":[0,1,2,3]},"prazoEntrega":{"type":"string","description":"Prazo de Entrega (YYYY-MM-DD)","format":"date"},"centroCustosItemSolCompra":{"maxLength":25,"type":"string","description":"Centro de Custos"},"ratearCusto":{"type":"boolean","description":"Ratear Custo (0-Não, 1-Sim)"},"itensSolicitacaoCentrosCustosRateio":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/ItensSolicitacaoCentrosCustosRateioGet"}},"itensContaContabilCentroCustosRateio":{"type":"array","description":"Conta(s) Contabil(eis) para Rateio","items":{"$ref":"#/components/schemas/RateioContaContabil"}},"marcaPrincipal":{"type":"string","description":"Marca Principal"},"fornecedorPrincipal":{"type":"string","description":"Fornecedor Principal"},"contaContabil":{"type":"string","description":"Conta Contábil"},"numOS":{"type":"integer","description":"Número da Ordem de Serviço"},"valorEstimado":{"multipleOf":0.01,"type":"number","description":"Valor Estimado"},"precoUltimaCompra":{"multipleOf":0.01,"type":"number","description":"Preço Última Compra"},"codFamiliaProduto":{"type":"integer","description":"Código da Família de Produto"},"urgencia":{"type":"integer","description":"Nível de Urgência"},"itensSolicitacaoObservacao":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/ItensSolicitacaoObservacaoGet"}}}},"ItensSolicitacaoCentrosCustosRateioGet":{"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"ItensSolicitacaoObservacaoGet":{"type":"object","properties":{"observacao":{"maxLength":1000,"type":"string","description":"Observação"}}}}}} ``` ## The SolicitacaoCentrosCustosRateioGet object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"SolicitacaoCentrosCustosRateioGet":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}}}}} ``` ## The ItensSolCompraGet object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ItensSolCompraGet":{"type":"object","properties":{"seqItem":{"type":"integer","description":"Sequência do Item"},"codProduto":{"type":"string","description":"Código do Produto"},"descProduto":{"type":"string","description":"Descrição do Produto"},"qtdSolicitada":{"multipleOf":0.001,"type":"number","description":"Quantidade Solicitada"},"unidadeCompra":{"type":"string","description":"Unidade de Compra"},"unidadeEstoque":{"type":"string","description":"Unidade de Estoque"},"situacaoCompra":{"type":"integer","description":"Situação da Solicitação no Processo de Compra do Item (1-Em Aberto, 2-Em Cotação, 3-Cotada, 4-Realizada, 5-Atendida, 6 Cancelada)","enum":[1,2,3,4,5,6]},"situacaoBloqueio":{"type":"integer","description":"Situação Ref. Bloqueio de Itens de Despesa (0-Liberada, 1-Bloqueada, 2-Digitado, 3-Retornado)","enum":[0,1,2,3]},"prazoEntrega":{"type":"string","description":"Prazo de Entrega (YYYY-MM-DD)","format":"date"},"centroCustosItemSolCompra":{"maxLength":25,"type":"string","description":"Centro de Custos"},"ratearCusto":{"type":"boolean","description":"Ratear Custo (0-Não, 1-Sim)"},"itensSolicitacaoCentrosCustosRateio":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/ItensSolicitacaoCentrosCustosRateioGet"}},"itensContaContabilCentroCustosRateio":{"type":"array","description":"Conta(s) Contabil(eis) para Rateio","items":{"$ref":"#/components/schemas/RateioContaContabil"}},"marcaPrincipal":{"type":"string","description":"Marca Principal"},"fornecedorPrincipal":{"type":"string","description":"Fornecedor Principal"},"contaContabil":{"type":"string","description":"Conta Contábil"},"numOS":{"type":"integer","description":"Número da Ordem de Serviço"},"valorEstimado":{"multipleOf":0.01,"type":"number","description":"Valor Estimado"},"precoUltimaCompra":{"multipleOf":0.01,"type":"number","description":"Preço Última Compra"},"codFamiliaProduto":{"type":"integer","description":"Código da Família de Produto"},"urgencia":{"type":"integer","description":"Nível de Urgência"},"itensSolicitacaoObservacao":{"type":"array","description":"Centro(s) de Custos para Rateio","items":{"$ref":"#/components/schemas/ItensSolicitacaoObservacaoGet"}}}},"ItensSolicitacaoCentrosCustosRateioGet":{"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"RateioContaContabil":{"required":["contaContabil","percentualProporcao"],"type":"object","properties":{"contaContabil":{"maximum":9999,"type":"integer"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"},"contaContabilCentroCusto":{"type":"array","description":"Rateio de Centro(s) de Custo(s) por Conta(s) Contabil(eis)","items":{"$ref":"#/components/schemas/RateioCentroCustoContaContabil"}}}},"RateioCentroCustoContaContabil":{"required":["centroCustos","percentualProporcao"],"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}},"ItensSolicitacaoObservacaoGet":{"type":"object","properties":{"observacao":{"maxLength":1000,"type":"string","description":"Observação"}}}}}} ``` ## The ItensSolicitacaoObservacaoGet object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ItensSolicitacaoObservacaoGet":{"type":"object","properties":{"observacao":{"maxLength":1000,"type":"string","description":"Observação"}}}}}} ``` ## The ItensSolicitacaoCentrosCustosRateioGet object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.0"},"components":{"schemas":{"ItensSolicitacaoCentrosCustosRateioGet":{"type":"object","properties":{"centroCustos":{"maxLength":25,"type":"string","description":"Centro de Custos"},"percentualProporcao":{"multipleOf":0.01,"type":"number","description":"Percentual Proporção do Rateio"}}}}}} ``` ## The MsgStatusRequisicao object ```json {"openapi":"3.0.1","info":{"title":"Compras","version":"1.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":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/entradas/compras-v1.0/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.