Serviços ·
ContratoContrato de Serviço
2consultas
4alterações
Claude 6 de 6 · ChatGPT 1 de 6 · MCP 6 de 6pelos assistentes de IA
JSON · XMLformato
Alterar um Contrato
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 10Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cabecalho | objeto | |
cabecalho.cCodIntCtr | texto · até 20 | Código de integração do contrato de serviços. (Utilizado em contratos criados via API, não é visualizado na tela) |
cabecalho.cCodSit | texto · até 2 | Código da situação do contrato de serviços. Pode ser: 00 - Em Elaboração 10 - Ativo 90 - Suspenso 99 - Cancelado |
cabecalho.cNumCtr | texto · até 60 | Número do contrato de serviços. (Informado pelo usuário / visualizado na tela) |
cabecalho.cTipoFat | texto · até 2 | Tipo de Faturamento do Contrato. Pode ser: 01 - Todo Mês (mensal) 02 - A cada 2 meses (bimestral) 03 - A cada 3 meses (trimestral) 06 - A cada 6 meses (semestral) 12 - A cada 12 meses (anual) |
cabecalho.dVigFinal | texto · até 10 | Data de vigência final do contrato de serviços. |
cabecalho.dVigInicial | texto · até 10 | Data da vigência inicial do contrato de serviços. |
cabecalho.nCodCli | número inteiro | Código do cliente a que se refere o contrato de serviços. (Gerado internamente, não é visualizado na tela) |
cabecalho.nCodCtr | número inteiro | Código do contrato de serviços. (Gerado internamente, não é visualizado na tela) |
cabecalho.nDiaFat | número inteiro | Dia de faturamento. |
cabecalho.nValTotMes | número | Valor total mensal do contrato de serviços. (Calculado automaticamente) |
departamentos | lista de objetos | Distribuição por departamento |
departamentos[].cCodDep | texto · até 40 | Código do Departamento |
departamentos[].cDesDep | texto · até 50 | Descrição do Departamento |
departamentos[].nPerDep | número | Percentual do rateio |
departamentos[].nValDep | número | Valor do rateio |
despesasReembolsaveis | objeto | Despesas reembolsáveis |
despesasReembolsaveis.cCodCategReemb | texto · até 20 | Código da categoria para reembolso |
despesasReembolsaveis.despesaReembolsavel | lista de objetos | Despesa reembolsável |
despesasReembolsaveis.despesaReembolsavel[].cAcaoReemb | texto · até 1 | Ação para o reembolso, pode ser: I - Inclusão A - Alteração E - Exclusão |
despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto · até 200 | Descrição do reembolso |
despesasReembolsaveis.despesaReembolsavel[].cRecorrenteReemb | texto · até 1 | Indica se o reembolso é recorrente. [S/N] |
despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto · até 10 | Data do reembolso |
despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso |
despesasReembolsaveis.despesaReembolsavel[].nValorReemb | número | Valor do Reembolso |
emailCliente | objeto | Dados do envio de e-mail do cliente |
emailCliente.cEnvViaUnica | texto · até 1 | Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não |
emailCliente.cEnviarBoleto | texto · até 1 | Enviar também o(s) boleto(s) de cobrança |
emailCliente.cEnviarLinkNfse | texto · até 1 | Enviar o link da NFS-e gerada na Prefeitura |
emailCliente.cEnviarPix | texto · até 1 | Enviar também o(s) PIX(s) de cobrança |
emailCliente.cEnviarRecibo | texto · até 1 | Enviar um recibo de prestação de serviço (ao invés de NFS-e) |
emailCliente.cUtilizarEmails | texto | Utilizar os seguintes endereços de e-mail |
infAdic | objeto | |
infAdic.cCidPrestServ | texto · até 40 | Cidade da Prestação do Serviço e Estado |
infAdic.cCodART | texto · até 20 | Código ART |
infAdic.cCodCateg | texto · até 20 | Código da Categoria |
infAdic.cCodObra | texto · até 15 | Código da Obra |
infAdic.cContato | texto · até 100 | Nome do Contato |
infAdic.cDadosAdicNF | texto | Dados Adicionais para a Nota Fiscal |
infAdic.cNumEncap | texto · até 15 | Código de Encapsulamento de notas dedutoras |
infAdic.cUsoConsumo | texto · até 1 | Uso e consumo pessoal. (0=Não, 1=Sim). |
infAdic.nCodCC | número inteiro | Código da Conta Corrente |
infAdic.nCodProj | número inteiro | Código do Projeto |
infAdic.nCodVend | número inteiro | Código do Vendedor |
infAdic.nIdDestinatario | número inteiro | ID Cliente para o Destinatário. |
infoCadastro | objeto | Informações complementares do contrato. |
infoCadastro.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
infoCadastro.cOrigem | texto · até 3 | Origem do Contrato de Serviço. Informado na Inclusão. |
infoCadastro.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
itensContrato | lista de objetos | |
itensContrato[].itemCabecalho | objeto | |
itensContrato[].itemCabecalho.aliqDesconto | número | Aliquota do Desconto. |
itensContrato[].itemCabecalho.cCodCategItem | texto · até 20 | Código da Categoria. |
itensContrato[].itemCabecalho.cNaoGerarFinanceiro | texto · até 1 | Não gerar conta a receber para este item. Informar "S" para não gerar movimento financeiro. Informar "N" para gerar movimento financeiro. |
itensContrato[].itemCabecalho.cTpDesconto | texto · até 1 | Tipo de Desconto. Pode ser: P - Percentual V - Valor |
itensContrato[].itemCabecalho.codIntItem | texto · até 30 | Código de integração do item do contrato. |
itensContrato[].itemCabecalho.codItem | número inteiro | Identificação do Item do Contrato. (Gerado automaticamente na Inclusão do item do contrato) |
itensContrato[].itemCabecalho.codLC116 | texto · até 10 | Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Tabela única para todos os municípios. |
itensContrato[].itemCabecalho.codNBS | texto · até 9 | Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag "codServico" irá assumir o valor informado no cadastro do respectivo serviço. |
itensContrato[].itemCabecalho.codServMunic | texto · até 20 | Código do Serviço Municipal ou CNAE. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis. |
itensContrato[].itemCabecalho.codServico | número inteiro | Código Interno do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API. |
itensContrato[].itemCabecalho.natOperacao | texto · até 2 | Natureza da Operação ou Tipo de Tributação dos Serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis. |
itensContrato[].itemCabecalho.quant | número | Quantidade de serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor padrão 1. |
itensContrato[].itemCabecalho.seq | número inteiro | Sequência do Item do Contrato. |
itensContrato[].itemCabecalho.valorAcrescimo | número | Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.) |
itensContrato[].itemCabecalho.valorDed | número | Valor de Deduções. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemCabecalho.valorDesconto | número | Valor do Desconto. |
itensContrato[].itemCabecalho.valorOutrasRetencoes | número | Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.) |
itensContrato[].itemCabecalho.valorTotal | número | Valor total do item. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemCabecalho.valorUnit | número | Valor Unitário do serviço. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
itensContrato[].itemDescrServ | objeto | |
itensContrato[].itemDescrServ.descrCompleta | texto | Informe a descrição completa do serviço prestado |
itensContrato[].itemImpostos | objeto | |
itensContrato[].itemImpostos.aliqCOFINS | número | Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemImpostos.aliqCSLLobrigatório | número | Alíquota de CSLL. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.aliqCbs | número | Alíquota da CBS Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.aliqINSSobrigatório | número | Alíquota de INSS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.aliqIRobrigatório | número | Alíquota de IR. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.aliqISS | número | Alíquota de ISS. |
itensContrato[].itemImpostos.aliqIbsMun | número | Alíquota do Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.aliqIbsUf | número | Alíquota do IBS Estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.aliqPISobrigatório | número | Alíquota de PIS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.cUtilizaValorImposto | texto · até 1 | Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota. Assim: Caso seja informado "N", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo. Caso seja informado "S", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo. |
itensContrato[].itemImpostos.classTrib | texto · até 6 | Código de Classificação Tributária. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.cstIbsCbs | texto · até 3 | Código da Situação Tributária IBS/CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.indOper | texto · até 6 | Código Indicador de Operação. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.lDeduzISS | sim/não | Deduz o ISS da Base de Cálculo de PIS e COFINS |
itensContrato[].itemImpostos.manCbs | texto · até 1 | Indica que houve alteração manual da alíquota de CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.manIbsMun | texto · até 1 | Indica que houve alteração manual da alíquota de IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.manIbsUf | texto · até 1 | Indica que houve alteração manual da alíquota de IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.percReducaoCbs | número | Percentual redução CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.percReducaoIbsMun | número | Percentual redução IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.percReducaoIbsUf | número | Percentual redução IBS municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.redBaseCOFINS | número | Percentual de Redução da Base de Cálculo do COFINS. |
itensContrato[].itemImpostos.redBaseINSS | número | Percentual de Redução da Base de Cálculo do INSS. |
itensContrato[].itemImpostos.redBasePIS | número | Percentual de Redução da Base de Cálculo do PIS. |
itensContrato[].itemImpostos.retCOFINS | texto · até 1 | Retém COFINS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retCSLL | texto · até 1 | Retém CSLL (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retINSS | texto · até 1 | Retém INSS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retIR | texto · até 1 | Retém IR (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retISS | texto · até 1 | Retém ISS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retPIS | texto · até 1 | Retém PIS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.valorCOFINSobrigatório | número | Alíquota de COFINS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.valorCSLL | número | Valor de CSLL. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemImpostos.valorCbs | número | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.valorINSS | número | Valor de INSS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemImpostos.valorIR | número | Valor do IR. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemImpostos.valorISS | número | Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemImpostos.valorIbsMun | número | Valor do IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.valorIbsUf | número | Valor do IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.valorPIS | número | Valor do PIS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemLeiTranspImp | objeto | |
itensContrato[].itemLeiTranspImp.aliMunicipal | número | Alíquota Carga Trib. Aprox. Municipal |
itensContrato[].itemLeiTranspImp.aliqEstadual | número | Alíquota Carga Trib. Aprox. Estadual |
itensContrato[].itemLeiTranspImp.aliqFederal | número | Alíquota da Carga Tributária Aprox. Federal |
itensContrato[].itemLeiTranspImp.chave | texto · até 6 | Chave do IBPT |
itensContrato[].itemLeiTranspImp.fonte | texto · até 34 | Fonte do IBPT |
itensContrato[].itemOutrasInf | objeto | Outras informações do item do contrato de serviços |
itensContrato[].itemOutrasInf.dItVigFinal | texto · até 10 | Data da vigência final do item do contrato de serviços |
itensContrato[].itemOutrasInf.dItVigInicial | texto · até 10 | Data da vigência inicial do item do contrato de serviços |
itensContrato[].itemOutrasInf.nTipoItVigFinal | número inteiro | Tipo da vigência final do item do contrato de serviços. Valores possiveis: 1 - Data especifica 2 - Segue a vigência final do contrato 3 - Apenas para o proximo faturamento |
itensContrato[].itemViaUnica | objeto | Informações referente ao serviço da NF modelo 21 ou 22. |
itensContrato[].itemViaUnica.cCFOP | texto · até 10 | Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação. |
itensContrato[].itemViaUnica.cClassifServico | texto · até 4 | Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação. |
itensContrato[].itemViaUnica.cModeloNF | texto · até 2 | Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação |
itensContrato[].itemViaUnica.cTipoReceita | texto · até 1 | Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros |
itensContrato[].itemViaUnica.cTipoUtilizacao | texto · até 1 | Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação. |
observacoes | objeto | Observações do contrato |
observacoes.cObsContrato | texto | Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal). |
produtosUtilizados | objeto | Produtos Utilizados no contrato. |
produtosUtilizados.cAcaoProdUtilizados | texto · até 3 | Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. PED - Será gerado um pedido de venda. Obrigatório na inclusão. |
produtosUtilizados.cCodCategRem | texto · até 20 | Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'. |
produtosUtilizados.produtoUtilizado | lista de objetos | Produtos utilizados no serviço. |
produtosUtilizados.produtoUtilizado[].cAcaoItemPU | texto · até 1 | Pode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração. |
produtosUtilizados.produtoUtilizado[].codigo_local_estoque | número inteiro | Código do Local do Estoque. |
produtosUtilizados.produtoUtilizado[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
produtosUtilizados.produtoUtilizado[].lote_validade[].nIdLote | número inteiro | Id do lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
produtosUtilizados.produtoUtilizado[].lote_validade[].nQtdLoteobrigatório | número | Informe aqui a quantidade do lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
produtosUtilizados.produtoUtilizado[].nCodProdutoPU | número inteiro | Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie. |
produtosUtilizados.produtoUtilizado[].nIdItemPU | número inteiro | (Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie. |
produtosUtilizados.produtoUtilizado[].nQtdePU | número | Quantidade. |
vencTextos | objeto | |
vencTextos.cAdContrato | texto · até 1 | Adicionar o "Nº do Contrato" à descrição dos serviços na NFS-e |
vencTextos.cAdPeriodo | texto · até 1 | Adicionar o período de referência associado ao faturamento |
vencTextos.cAdVenc | texto · até 1 | Adicionar o vencimento da parcela à descrição dos serviços na NFS-e |
vencTextos.cAntecipar | texto · até 1 | Define se deve antecipar o vencimento ao considerar apenas dias úteis |
vencTextos.cCodPerRef | texto · até 3 | Período de Referência - Código do período de referência para o faturamento. Pode ser: 001 Mês do faturamento 002 Mês Anterior ao faturamento 003 Mês Posterior ao faturamento 004 Período Anterior ao faturamento 005 Período Posterior ao faturamento 006 Período Anterior específico 007 Número da Parcela 008 Período Posterior específico 009 Período Atual específico |
vencTextos.cDiaFim | texto · até 2 | Dia Final - Dia para a data final do período de referência associado ao faturamento |
vencTextos.cDiaIni | texto · até 2 | Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial |
vencTextos.cPostergar | texto · até 1 | Postergar Sábados, Domingos e Feriados Nacionais |
vencTextos.cProxMes | texto · até 1 | Define se o vencimento ocorrerá somente no mês seguinte. |
vencTextos.cTpVenc | texto · até 3 | Tipo de Vencimento. Pode ser: 001-Número de dias após faturar. 002-Fixar dia do mês (1 a 31). |
vencTextos.nDiaFixo | número inteiro | Dia de vencimento fixo para a gerar o contas a receber |
vencTextos.nDias | número inteiro | Número de Dias para a gerar o contas a receber |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntCtr | texto | Código de Integração do Contrato de Serviço |
cCodStatus | texto | Código do Status |
cDescStatus | texto | Descrição do Status |
nCodCtr | número inteiro | Código da Contrato de Serviço |
POST /api/v1/servicos/contrato/
curl -s https://app.omie.com.br/api/v1/servicos/contrato/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AlterarContrato", "param": [{"cabecalho": {"cCodIntCtr": "019289Tb2", "cCodSit": "10", "cNumCtr": "2020/01001", "cTipoFat": "01", "dVigFinal": "30/03/2022", "dVigInicial": "29/03/2020", "nCodCli": 2370765, "nDiaFat": 30, "nValTotMes": 3302}, "departamentos": [], "emailCliente": {"cEnviarBoleto": "", "cEnviarLinkNfse": "", "cEnviarRecibo": "", "cUtilizarEmails": ""}, "infAdic": {"cCidPrestServ": "PETROPOLIS (RJ)", "cCodART": "", "cCodCateg": "1.01.02", "cCodObra": "", "cContato": "", "cDadosAdicNF": "", "nCodCC": 1208238, "nCodProj": 0, "nCodVend": 0}, "itensContrato": [{"itemCabecalho": {"codIntItem": "1", "cCodCategItem": "", "cNaoGerarFinanceiro": "N", "codLC116": "3.05", "codNBS": "", "codServMunic": "01292", "codServico": 0, "natOperacao": "01", "quant": 1, "seq": 1, "valorDed": 0, "valorTotal": 3002, "valorUnit": 3002}, "itemDescrServ": {"descrCompleta": "Serviços prestados"}, "itemImpostos": {"aliqCOFINS": 0, "aliqCSLL": 0, "aliqINSS": 0, "aliqIR": 0, "aliqISS": 5, "aliqPIS": 0, "redBaseINSS": 0, "retCOFINS": "", "retCSLL": "", "retINSS": "", "retIR": "", "retISS": "N", "retPIS": "", "valorCOFINS": 0, "valorCSLL": 0, "valorINSS": 0, "valorIR": 0, "valorISS": 150.1, "valorPIS": 0}, "itemLeiTranspImp": {"aliMunicipal": 0, "aliqEstadual": 0, "aliqFederal": 0, "chave": "", "fonte": ""}}, {"itemCabecalho": {"codIntItem": "2", "cCodCategItem": "", "cNaoGerarFinanceiro": "N", "codLC116": "17.01", "codNBS": "", "codServMunic": "0162-8/99", "codServico": 3412648, "natOperacao": "01", "quant": 1, "seq": 2, "valorDed": 0, "valorTotal": 300, "valorUnit": 300}, "itemDescrServ": {"descrCompleta": "Homologação de processo contábil"}, "itemImpostos": {"aliqCOFINS": 0, "aliqCSLL": 0, "aliqINSS": 0, "aliqIR": 0, "aliqISS": 3, "aliqPIS": 0, "redBaseINSS": 0, "retCOFINS": "", "retCSLL": "", "retINSS": "", "retIR": "", "retISS": "N", "retPIS": "", "valorCOFINS": 0, "valorCSLL": 0, "valorINSS": 0, "valorIR": 0, "valorISS": 9, "valorPIS": 0}, "itemLeiTranspImp": {"aliMunicipal": 0, "aliqEstadual": 0, "aliqFederal": 0, "chave": "", "fonte": ""}}], "observacoes": {"cObsContrato": ""}, "vencTextos": {"cAdContrato": "N", "cAdPeriodo": "N", "cAdVenc": " ", "cAntecipar": "", "cCodPerRef": "001", "cDiaFim": 0, "cDiaIni": 0, "cPostergar": "", "cProxMes": "", "cTpVenc": "001", "nDiaFixo": 0, "nDias": 5}}]}'import os
import requests
corpo = {'call': 'AlterarContrato',
'param': [{'cabecalho': {'cCodIntCtr': '019289Tb2',
'cCodSit': '10',
'cNumCtr': '2020/01001',
'cTipoFat': '01',
'dVigFinal': '30/03/2022',
'dVigInicial': '29/03/2020',
'nCodCli': 2370765,
'nDiaFat': 30,
'nValTotMes': 3302},
'departamentos': [],
'emailCliente': {'cEnviarBoleto': '',
'cEnviarLinkNfse': '',
'cEnviarRecibo': '',
'cUtilizarEmails': ''},
'infAdic': {'cCidPrestServ': 'PETROPOLIS (RJ)',
'cCodART': '',
'cCodCateg': '1.01.02',
'cCodObra': '',
'cContato': '',
'cDadosAdicNF': '',
'nCodCC': 1208238,
'nCodProj': 0,
'nCodVend': 0},
'itensContrato': [{'itemCabecalho': {'codIntItem': '1',
'cCodCategItem': '',
'cNaoGerarFinanceiro': 'N',
'codLC116': '3.05',
'codNBS': '',
'codServMunic': '01292',
'codServico': 0,
'natOperacao': '01',
'quant': 1,
'seq': 1,
'valorDed': 0,
'valorTotal': 3002,
'valorUnit': 3002},
'itemDescrServ': {'descrCompleta': 'Serviços prestados'},
'itemImpostos': {'aliqCOFINS': 0,
'aliqCSLL': 0,
'aliqINSS': 0,
'aliqIR': 0,
'aliqISS': 5,
'aliqPIS': 0,
'redBaseINSS': 0,
'retCOFINS': '',
'retCSLL': '',
'retINSS': '',
'retIR': '',
'retISS': 'N',
'retPIS': '',
'valorCOFINS': 0,
'valorCSLL': 0,
'valorINSS': 0,
'valorIR': 0,
'valorISS': 150.1,
'valorPIS': 0},
'itemLeiTranspImp': {'aliMunicipal': 0,
'aliqEstadual': 0,
'aliqFederal': 0,
'chave': '',
'fonte': ''}},
{'itemCabecalho': {'codIntItem': '2',
'cCodCategItem': '',
'cNaoGerarFinanceiro': 'N',
'codLC116': '17.01',
'codNBS': '',
'codServMunic': '0162-8/99',
'codServico': 3412648,
'natOperacao': '01',
'quant': 1,
'seq': 2,
'valorDed': 0,
'valorTotal': 300,
'valorUnit': 300},
'itemDescrServ': {'descrCompleta': 'Homologação de '
'processo contábil'},
'itemImpostos': {'aliqCOFINS': 0,
'aliqCSLL': 0,
'aliqINSS': 0,
'aliqIR': 0,
'aliqISS': 3,
'aliqPIS': 0,
'redBaseINSS': 0,
'retCOFINS': '',
'retCSLL': '',
'retINSS': '',
'retIR': '',
'retISS': 'N',
'retPIS': '',
'valorCOFINS': 0,
'valorCSLL': 0,
'valorINSS': 0,
'valorIR': 0,
'valorISS': 9,
'valorPIS': 0},
'itemLeiTranspImp': {'aliMunicipal': 0,
'aliqEstadual': 0,
'aliqFederal': 0,
'chave': '',
'fonte': ''}}],
'observacoes': {'cObsContrato': ''},
'vencTextos': {'cAdContrato': 'N',
'cAdPeriodo': 'N',
'cAdVenc': ' ',
'cAntecipar': '',
'cCodPerRef': '001',
'cDiaFim': 0,
'cDiaIni': 0,
'cPostergar': '',
'cProxMes': '',
'cTpVenc': '001',
'nDiaFixo': 0,
'nDias': 5}}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/contrato/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/contrato/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/contrato/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "AlterarContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/contrato/")
corpo = <<~'JSON'
{
"call": "AlterarContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "AlterarContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/contrato/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/contrato/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarContrato"", ""param"": [{""cabecalho"": {""cCodIntCtr"": ""019289Tb2"", ""cCodSit"": ""10"", ""cNumCtr"": ""2020/01001"", ""cTipoFat"": ""01"", ""dVigFinal"": ""30/03/2022"", ""dVigInicial"": ""29/03/2020"", ""nCodCli"": 2370765, ""nDiaFat"": 30, ""nValTotMes"": 3302}, ""departamentos"": [], ""emailCliente"": {""cEnviarBoleto"": """", ""cEnviarLinkNfse"": """", ""cEnviarRecibo"": """", ""cUtilizarEmails"": """"}, ""infAdic"": {""cCidPrestServ"": ""PETROPOLIS (RJ)"", ""cCodART"": """", ""cCodCateg"": ""1.01.02"", ""cCodObra"": """", ""cContato"": """", ""cDadosAdicNF"": """", ""nCodCC"": 1208238, ""nCodProj"": 0, ""nCodVend"": 0}, ""itensContrato"": [{""itemCabecalho"": {""codIntItem"": ""1"", ""cCodCategItem"": """", ""cNaoGerarFinanceiro"": ""N"", ""codLC116"": ""3.05"", ""codNBS"": """", ""codServMunic"": ""01292"", ""codServico"": 0, ""natOperacao"": ""01"", ""quant"": 1, ""seq"": 1, ""valorDed"": 0, ""valorTotal"": 3002, ""valorUnit"": 3002}, ""itemDescrServ"": {""descrCompleta"": ""Serviços prestados""}, ""itemImpostos"": {""aliqCOFINS"": 0, ""aliqCSLL"": 0, ""aliqINSS"": 0, ""aliqIR"": 0, ""aliqISS"": 5, ""aliqPIS"": 0, ""redBaseINSS"": 0, ""retCOFINS"": """", ""retCSLL"": """", ""retINSS"": """", ""retIR"": """", ""retISS"": ""N"", ""retPIS"": """", ""valorCOFINS"": 0, ""valorCSLL"": 0, ""valorINSS"": 0, ""valorIR"": 0, ""valorISS"": 150.1, ""valorPIS"": 0}, ""itemLeiTranspImp"": {""aliMunicipal"": 0, ""aliqEstadual"": 0, ""aliqFederal"": 0, ""chave"": """", ""fonte"": """"}}, {""itemCabecalho"": {""codIntItem"": ""2"", ""cCodCategItem"": """", ""cNaoGerarFinanceiro"": ""N"", ""codLC116"": ""17.01"", ""codNBS"": """", ""codServMunic"": ""0162-8/99"", ""codServico"": 3412648, ""natOperacao"": ""01"", ""quant"": 1, ""seq"": 2, ""valorDed"": 0, ""valorTotal"": 300, ""valorUnit"": 300}, ""itemDescrServ"": {""descrCompleta"": ""Homologação de processo contábil""}, ""itemImpostos"": {""aliqCOFINS"": 0, ""aliqCSLL"": 0, ""aliqINSS"": 0, ""aliqIR"": 0, ""aliqISS"": 3, ""aliqPIS"": 0, ""redBaseINSS"": 0, ""retCOFINS"": """", ""retCSLL"": """", ""retINSS"": """", ""retIR"": """", ""retISS"": ""N"", ""retPIS"": """", ""valorCOFINS"": 0, ""valorCSLL"": 0, ""valorINSS"": 0, ""valorIR"": 0, ""valorISS"": 9, ""valorPIS"": 0}, ""itemLeiTranspImp"": {""aliMunicipal"": 0, ""aliqEstadual"": 0, ""aliqFederal"": 0, ""chave"": """", ""fonte"": """"}}], ""observacoes"": {""cObsContrato"": """"}, ""vencTextos"": {""cAdContrato"": ""N"", ""cAdPeriodo"": ""N"", ""cAdVenc"": "" "", ""cAntecipar"": """", ""cCodPerRef"": ""001"", ""cDiaFim"": 0, ""cDiaIni"": 0, ""cPostergar"": """", ""cProxMes"": """", ""cTpVenc"": ""001"", ""nDiaFixo"": 0, ""nDias"": 5}}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosConsulta o Contrato de Serviço
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 1Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
contratoChave | objeto | Chave de Pesquisa do Contrato de Serviço. |
contratoChave.cCodIntCtr | texto · até 20 | Código de Integração do contrato de serviços. (Utilizado em contratos de serviços criados a partir de API, não é visualizado na tela) |
contratoChave.nCodCtr | número inteiro | Código do contrato de serviços. (Gerado internamente, não é visualizado na tela) |
Retorno 1O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
contratoCadastro | objeto | Cadastro de Contrato de Serviço |
contratoCadastro.cabecalho | objeto | |
contratoCadastro.cabecalho.cCodIntCtr | texto | Código de integração do contrato de serviços. (Utilizado em contratos criados via API, não é visualizado na tela) |
contratoCadastro.cabecalho.cCodSit | texto | Código da situação do contrato de serviços. Pode ser: 00 - Em Elaboração 10 - Ativo 90 - Suspenso 99 - Cancelado |
contratoCadastro.cabecalho.cNumCtr | texto | Número do contrato de serviços. (Informado pelo usuário / visualizado na tela) |
contratoCadastro.cabecalho.cTipoFat | texto | Tipo de Faturamento do Contrato. Pode ser: 01 - Todo Mês (mensal) 02 - A cada 2 meses (bimestral) 03 - A cada 3 meses (trimestral) 06 - A cada 6 meses (semestral) 12 - A cada 12 meses (anual) |
contratoCadastro.cabecalho.dVigFinal | texto | Data de vigência final do contrato de serviços. |
contratoCadastro.cabecalho.dVigInicial | texto | Data da vigência inicial do contrato de serviços. |
contratoCadastro.cabecalho.nCodCli | número inteiro | Código do cliente a que se refere o contrato de serviços. (Gerado internamente, não é visualizado na tela) |
contratoCadastro.cabecalho.nCodCtr | número inteiro | Código do contrato de serviços. (Gerado internamente, não é visualizado na tela) |
contratoCadastro.cabecalho.nDiaFat | número inteiro | Dia de faturamento. |
contratoCadastro.cabecalho.nValTotMes | decimal | Valor total mensal do contrato de serviços. (Calculado automaticamente) |
contratoCadastro.departamentos | lista de objetos | Distribuição por departamento |
contratoCadastro.departamentos[].cCodDep | texto | Código do Departamento |
contratoCadastro.departamentos[].cDesDep | texto | Descrição do Departamento |
contratoCadastro.departamentos[].nPerDep | decimal | Percentual do rateio |
contratoCadastro.departamentos[].nValDep | decimal | Valor do rateio |
contratoCadastro.despesasReembolsaveis | objeto | Despesas reembolsáveis |
contratoCadastro.despesasReembolsaveis.cCodCategReemb | texto | Código da categoria para reembolso |
contratoCadastro.despesasReembolsaveis.despesaReembolsavel | lista de objetos | Despesa reembolsável |
contratoCadastro.despesasReembolsaveis.despesaReembolsavel[].cAcaoReemb | texto | Ação para o reembolso, pode ser: I - Inclusão A - Alteração E - Exclusão |
contratoCadastro.despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto | Descrição do reembolso |
contratoCadastro.despesasReembolsaveis.despesaReembolsavel[].cRecorrenteReemb | texto | Indica se o reembolso é recorrente. [S/N] |
contratoCadastro.despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto | Data do reembolso |
contratoCadastro.despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso |
contratoCadastro.despesasReembolsaveis.despesaReembolsavel[].nValorReemb | decimal | Valor do Reembolso |
contratoCadastro.emailCliente | objeto | Dados do envio de e-mail do cliente |
contratoCadastro.emailCliente.cEnvViaUnica | texto | Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não |
contratoCadastro.emailCliente.cEnviarBoleto | texto | Enviar também o(s) boleto(s) de cobrança |
contratoCadastro.emailCliente.cEnviarLinkNfse | texto | Enviar o link da NFS-e gerada na Prefeitura |
contratoCadastro.emailCliente.cEnviarPix | texto | Enviar também o(s) PIX(s) de cobrança |
contratoCadastro.emailCliente.cEnviarRecibo | texto | Enviar um recibo de prestação de serviço (ao invés de NFS-e) |
contratoCadastro.emailCliente.cUtilizarEmails | texto | Utilizar os seguintes endereços de e-mail |
contratoCadastro.infAdic | objeto | |
contratoCadastro.infAdic.cCidPrestServ | texto | Cidade da Prestação do Serviço e Estado |
contratoCadastro.infAdic.cCodART | texto | Código ART |
contratoCadastro.infAdic.cCodCateg | texto | Código da Categoria |
contratoCadastro.infAdic.cCodObra | texto | Código da Obra |
contratoCadastro.infAdic.cContato | texto | Nome do Contato |
contratoCadastro.infAdic.cDadosAdicNF | texto | Dados Adicionais para a Nota Fiscal |
contratoCadastro.infAdic.cNumEncap | texto | Código de Encapsulamento de notas dedutoras |
contratoCadastro.infAdic.cUsoConsumo | texto | Uso e consumo pessoal. (0=Não, 1=Sim). |
contratoCadastro.infAdic.nCodCC | número inteiro | Código da Conta Corrente |
contratoCadastro.infAdic.nCodProj | número inteiro | Código do Projeto |
contratoCadastro.infAdic.nCodVend | número inteiro | Código do Vendedor |
contratoCadastro.infAdic.nIdDestinatario | número inteiro | ID Cliente para o Destinatário. |
contratoCadastro.infoCadastro | objeto | Informações complementares do contrato. |
contratoCadastro.infoCadastro.cImpAPI | texto | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
contratoCadastro.infoCadastro.cOrigem | texto | Origem do Contrato de Serviço. Informado na Inclusão. |
contratoCadastro.infoCadastro.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro.infoCadastro.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro.infoCadastro.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro.infoCadastro.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro.infoCadastro.uAlt | texto | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro.infoCadastro.uInc | texto | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro.itensContrato | lista de objetos | |
contratoCadastro.itensContrato[].itemCabecalho | objeto | |
contratoCadastro.itensContrato[].itemCabecalho.aliqDesconto | decimal | Aliquota do Desconto. |
contratoCadastro.itensContrato[].itemCabecalho.cCodCategItem | texto | Código da Categoria. |
contratoCadastro.itensContrato[].itemCabecalho.cNaoGerarFinanceiro | texto | Não gerar conta a receber para este item. Informar "S" para não gerar movimento financeiro. Informar "N" para gerar movimento financeiro. |
contratoCadastro.itensContrato[].itemCabecalho.cTpDesconto | texto | Tipo de Desconto. Pode ser: P - Percentual V - Valor |
contratoCadastro.itensContrato[].itemCabecalho.codIntItem | texto | Código de integração do item do contrato. |
contratoCadastro.itensContrato[].itemCabecalho.codItem | número inteiro | Identificação do Item do Contrato. (Gerado automaticamente na Inclusão do item do contrato) |
contratoCadastro.itensContrato[].itemCabecalho.codLC116 | texto | Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Tabela única para todos os municípios. |
contratoCadastro.itensContrato[].itemCabecalho.codNBS | texto | Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag "codServico" irá assumir o valor informado no cadastro do respectivo serviço. |
contratoCadastro.itensContrato[].itemCabecalho.codServMunic | texto | Código do Serviço Municipal ou CNAE. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis. |
contratoCadastro.itensContrato[].itemCabecalho.codServico | número inteiro | Código Interno do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API. |
contratoCadastro.itensContrato[].itemCabecalho.natOperacao | texto | Natureza da Operação ou Tipo de Tributação dos Serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis. |
contratoCadastro.itensContrato[].itemCabecalho.quant | decimal | Quantidade de serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor padrão 1. |
contratoCadastro.itensContrato[].itemCabecalho.seq | número inteiro | Sequência do Item do Contrato. |
contratoCadastro.itensContrato[].itemCabecalho.valorAcrescimo | decimal | Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.) |
contratoCadastro.itensContrato[].itemCabecalho.valorDed | decimal | Valor de Deduções. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
contratoCadastro.itensContrato[].itemCabecalho.valorDesconto | decimal | Valor do Desconto. |
contratoCadastro.itensContrato[].itemCabecalho.valorOutrasRetencoes | decimal | Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.) |
contratoCadastro.itensContrato[].itemCabecalho.valorTotal | decimal | Valor total do item. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
contratoCadastro.itensContrato[].itemCabecalho.valorUnit | decimal | Valor Unitário do serviço. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
contratoCadastro.itensContrato[].itemDescrServ | objeto | |
contratoCadastro.itensContrato[].itemDescrServ.descrCompleta | texto | Informe a descrição completa do serviço prestado |
contratoCadastro.itensContrato[].itemImpostos | objeto | |
contratoCadastro.itensContrato[].itemImpostos.aliqCOFINS | decimal | Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
contratoCadastro.itensContrato[].itemImpostos.aliqCSLL | decimal | Alíquota de CSLL. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro.itensContrato[].itemImpostos.aliqCbs | decimal | Alíquota da CBS Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro.itensContrato[].itemImpostos.aliqINSS | decimal | Alíquota de INSS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro.itensContrato[].itemImpostos.aliqIR | decimal | Alíquota de IR. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro.itensContrato[].itemImpostos.aliqISS | decimal | Alíquota de ISS. |
contratoCadastro.itensContrato[].itemImpostos.aliqIbsMun | decimal | Alíquota do Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro.itensContrato[].itemImpostos.aliqIbsUf | decimal | Alíquota do IBS Estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro.itensContrato[].itemImpostos.aliqPIS | decimal | Alíquota de PIS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro.itensContrato[].itemImpostos.cUtilizaValorImposto | texto | Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota. Assim: Caso seja informado "N", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo. Caso seja informado "S", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo. |
contratoCadastro.itensContrato[].itemImpostos.classTrib | texto | Código de Classificação Tributária. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro.itensContrato[].itemImpostos.cstIbsCbs | texto | Código da Situação Tributária IBS/CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro.itensContrato[].itemImpostos.indOper | texto | Código Indicador de Operação. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro.itensContrato[].itemImpostos.lDeduzISS | sim/não | Deduz o ISS da Base de Cálculo de PIS e COFINS |
contratoCadastro.itensContrato[].itemImpostos.manCbs | texto | Indica que houve alteração manual da alíquota de CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro.itensContrato[].itemImpostos.manIbsMun | texto | Indica que houve alteração manual da alíquota de IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro.itensContrato[].itemImpostos.manIbsUf | texto | Indica que houve alteração manual da alíquota de IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro.itensContrato[].itemImpostos.percReducaoCbs | decimal | Percentual redução CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro.itensContrato[].itemImpostos.percReducaoIbsMun | decimal | Percentual redução IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro.itensContrato[].itemImpostos.percReducaoIbsUf | decimal | Percentual redução IBS municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro.itensContrato[].itemImpostos.redBaseCOFINS | decimal | Percentual de Redução da Base de Cálculo do COFINS. |
contratoCadastro.itensContrato[].itemImpostos.redBaseINSS | decimal | Percentual de Redução da Base de Cálculo do INSS. |
contratoCadastro.itensContrato[].itemImpostos.redBasePIS | decimal | Percentual de Redução da Base de Cálculo do PIS. |
contratoCadastro.itensContrato[].itemImpostos.retCOFINS | texto | Retém COFINS (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro.itensContrato[].itemImpostos.retCSLL | texto | Retém CSLL (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro.itensContrato[].itemImpostos.retINSS | texto | Retém INSS (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro.itensContrato[].itemImpostos.retIR | texto | Retém IR (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro.itensContrato[].itemImpostos.retISS | texto | Retém ISS (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro.itensContrato[].itemImpostos.retPIS | texto | Retém PIS (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro.itensContrato[].itemImpostos.valorCOFINS | decimal | Alíquota de COFINS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro.itensContrato[].itemImpostos.valorCSLL | decimal | Valor de CSLL. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
contratoCadastro.itensContrato[].itemImpostos.valorCbs | decimal | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro.itensContrato[].itemImpostos.valorINSS | decimal | Valor de INSS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
contratoCadastro.itensContrato[].itemImpostos.valorIR | decimal | Valor do IR. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
contratoCadastro.itensContrato[].itemImpostos.valorISS | decimal | Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
contratoCadastro.itensContrato[].itemImpostos.valorIbsMun | decimal | Valor do IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro.itensContrato[].itemImpostos.valorIbsUf | decimal | Valor do IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro.itensContrato[].itemImpostos.valorPIS | decimal | Valor do PIS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
contratoCadastro.itensContrato[].itemLeiTranspImp | objeto | |
contratoCadastro.itensContrato[].itemLeiTranspImp.aliMunicipal | decimal | Alíquota Carga Trib. Aprox. Municipal |
contratoCadastro.itensContrato[].itemLeiTranspImp.aliqEstadual | decimal | Alíquota Carga Trib. Aprox. Estadual |
contratoCadastro.itensContrato[].itemLeiTranspImp.aliqFederal | decimal | Alíquota da Carga Tributária Aprox. Federal |
contratoCadastro.itensContrato[].itemLeiTranspImp.chave | texto | Chave do IBPT |
contratoCadastro.itensContrato[].itemLeiTranspImp.fonte | texto | Fonte do IBPT |
contratoCadastro.itensContrato[].itemOutrasInf | objeto | Outras informações do item do contrato de serviços |
contratoCadastro.itensContrato[].itemOutrasInf.dItVigFinal | texto | Data da vigência final do item do contrato de serviços |
contratoCadastro.itensContrato[].itemOutrasInf.dItVigInicial | texto | Data da vigência inicial do item do contrato de serviços |
contratoCadastro.itensContrato[].itemOutrasInf.nTipoItVigFinal | número inteiro | Tipo da vigência final do item do contrato de serviços. Valores possiveis: 1 - Data especifica 2 - Segue a vigência final do contrato 3 - Apenas para o proximo faturamento |
contratoCadastro.itensContrato[].itemViaUnica | objeto | Informações referente ao serviço da NF modelo 21 ou 22. |
contratoCadastro.itensContrato[].itemViaUnica.cCFOP | texto | Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação. |
contratoCadastro.itensContrato[].itemViaUnica.cClassifServico | texto | Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação. |
contratoCadastro.itensContrato[].itemViaUnica.cModeloNF | texto | Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação |
contratoCadastro.itensContrato[].itemViaUnica.cTipoReceita | texto | Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros |
contratoCadastro.itensContrato[].itemViaUnica.cTipoUtilizacao | texto | Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação. |
contratoCadastro.observacoes | objeto | Observações do contrato |
contratoCadastro.observacoes.cObsContrato | texto | Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal). |
contratoCadastro.produtosUtilizados | objeto | Produtos Utilizados no contrato. |
contratoCadastro.produtosUtilizados.cAcaoProdUtilizados | texto | Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. PED - Será gerado um pedido de venda. Obrigatório na inclusão. |
contratoCadastro.produtosUtilizados.cCodCategRem | texto | Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'. |
contratoCadastro.produtosUtilizados.produtoUtilizado | lista de objetos | Produtos utilizados no serviço. |
contratoCadastro.produtosUtilizados.produtoUtilizado[].cAcaoItemPU | texto | Pode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração. |
contratoCadastro.produtosUtilizados.produtoUtilizado[].codigo_local_estoque | número inteiro | Código do Local do Estoque. |
contratoCadastro.produtosUtilizados.produtoUtilizado[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
contratoCadastro.produtosUtilizados.produtoUtilizado[].lote_validade[].nIdLote | número inteiro | Id do lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
contratoCadastro.produtosUtilizados.produtoUtilizado[].lote_validade[].nQtdLote | decimal | Informe aqui a quantidade do lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
contratoCadastro.produtosUtilizados.produtoUtilizado[].nCodProdutoPU | número inteiro | Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie. |
contratoCadastro.produtosUtilizados.produtoUtilizado[].nIdItemPU | número inteiro | (Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie. |
contratoCadastro.produtosUtilizados.produtoUtilizado[].nQtdePU | decimal | Quantidade. |
contratoCadastro.vencTextos | objeto | |
contratoCadastro.vencTextos.cAdContrato | texto | Adicionar o "Nº do Contrato" à descrição dos serviços na NFS-e |
contratoCadastro.vencTextos.cAdPeriodo | texto | Adicionar o período de referência associado ao faturamento |
contratoCadastro.vencTextos.cAdVenc | texto | Adicionar o vencimento da parcela à descrição dos serviços na NFS-e |
contratoCadastro.vencTextos.cAntecipar | texto | Define se deve antecipar o vencimento ao considerar apenas dias úteis |
contratoCadastro.vencTextos.cCodPerRef | texto | Período de Referência - Código do período de referência para o faturamento. Pode ser: 001 Mês do faturamento 002 Mês Anterior ao faturamento 003 Mês Posterior ao faturamento 004 Período Anterior ao faturamento 005 Período Posterior ao faturamento 006 Período Anterior específico 007 Número da Parcela 008 Período Posterior específico 009 Período Atual específico |
contratoCadastro.vencTextos.cDiaFim | número inteiro | Dia Final - Dia para a data final do período de referência associado ao faturamento |
contratoCadastro.vencTextos.cDiaIni | número inteiro | Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial |
contratoCadastro.vencTextos.cPostergar | texto | Postergar Sábados, Domingos e Feriados Nacionais |
contratoCadastro.vencTextos.cProxMes | texto | Define se o vencimento ocorrerá somente no mês seguinte. |
contratoCadastro.vencTextos.cTpVenc | texto | Tipo de Vencimento. Pode ser: 001-Número de dias após faturar. 002-Fixar dia do mês (1 a 31). |
contratoCadastro.vencTextos.nDiaFixo | número inteiro | Dia de vencimento fixo para a gerar o contas a receber |
contratoCadastro.vencTextos.nDias | número inteiro | Número de Dias para a gerar o contas a receber |
POST /api/v1/servicos/contrato/
curl -s https://app.omie.com.br/api/v1/servicos/contrato/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ConsultarContrato", "param": [{"contratoChave": {"nCodCtr": 2203958}}]}'import os
import requests
corpo = {'call': 'ConsultarContrato', 'param': [{'contratoChave': {'nCodCtr': 2203958}}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/contrato/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/contrato/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarContrato",
"param": [
{
"contratoChave": {
"nCodCtr": 2203958
}
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/contrato/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ConsultarContrato",
"param": [
{
"contratoChave": {
"nCodCtr": 2203958
}
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/contrato/")
corpo = <<~'JSON'
{
"call": "ConsultarContrato",
"param": [
{
"contratoChave": {
"nCodCtr": 2203958
}
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ConsultarContrato",
"param": [
{
"contratoChave": {
"nCodCtr": 2203958
}
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/contrato/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/contrato/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarContrato"", ""param"": [{""contratoChave"": {""nCodCtr"": 2203958}}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosExclui itens do contrato de serviços.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
ItensExclusao | lista de objetos | Itens a serem excluídos do contrato. |
ItensExclusao[].codIntItem | texto · até 30 | Código de integração do item do contrato (Utilizado em contratos de serviços criados a partir de API, não é visualizado na tela) |
ItensExclusao[].codItem | número inteiro | Código do Item. |
contratoChave | objeto | Chave de Pesquisa do Contrato de Serviço. |
contratoChave.cCodIntCtr | texto · até 20 | Código de Integração do contrato de serviços. (Utilizado em contratos de serviços criados a partir de API, não é visualizado na tela) |
contratoChave.nCodCtr | número inteiro | Código do contrato de serviços. (Gerado internamente, não é visualizado na tela) |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntCtr | texto | Código de Integração do Contrato de Serviço |
cCodStatus | texto | Código do Status |
cDescStatus | texto | Descrição do Status |
nCodCtr | número inteiro | Código da Contrato de Serviço |
POST /api/v1/servicos/contrato/
curl -s https://app.omie.com.br/api/v1/servicos/contrato/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ExcluirItem", "param": [{"contratoChave": {"nCodCtr": 0, "cCodIntCtr": ""}, "ItensExclusao": [{"codItem": 0, "codIntItem": ""}]}]}'import os
import requests
corpo = {'call': 'ExcluirItem',
'param': [{'contratoChave': {'nCodCtr': 0, 'cCodIntCtr': ''},
'ItensExclusao': [{'codItem': 0, 'codIntItem': ''}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/contrato/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/contrato/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirItem",
"param": [
{
"contratoChave": {
"nCodCtr": 0,
"cCodIntCtr": ""
},
"ItensExclusao": [
{
"codItem": 0,
"codIntItem": ""
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/contrato/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ExcluirItem",
"param": [
{
"contratoChave": {
"nCodCtr": 0,
"cCodIntCtr": ""
},
"ItensExclusao": [
{
"codItem": 0,
"codIntItem": ""
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/contrato/")
corpo = <<~'JSON'
{
"call": "ExcluirItem",
"param": [
{
"contratoChave": {
"nCodCtr": 0,
"cCodIntCtr": ""
},
"ItensExclusao": [
{
"codItem": 0,
"codIntItem": ""
}
]
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ExcluirItem",
"param": [
{
"contratoChave": {
"nCodCtr": 0,
"cCodIntCtr": ""
},
"ItensExclusao": [
{
"codItem": 0,
"codIntItem": ""
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/contrato/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/contrato/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirItem"", ""param"": [{""contratoChave"": {""nCodCtr"": 0, ""cCodIntCtr"": """"}, ""ItensExclusao"": [{""codItem"": 0, ""codIntItem"": """"}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInclusão de Contrato
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 10Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cabecalho | objeto | |
cabecalho.cCodIntCtr | texto · até 20 | Código de integração do contrato de serviços. (Utilizado em contratos criados via API, não é visualizado na tela) |
cabecalho.cCodSit | texto · até 2 | Código da situação do contrato de serviços. Pode ser: 00 - Em Elaboração 10 - Ativo 90 - Suspenso 99 - Cancelado |
cabecalho.cNumCtr | texto · até 60 | Número do contrato de serviços. (Informado pelo usuário / visualizado na tela) |
cabecalho.cTipoFat | texto · até 2 | Tipo de Faturamento do Contrato. Pode ser: 01 - Todo Mês (mensal) 02 - A cada 2 meses (bimestral) 03 - A cada 3 meses (trimestral) 06 - A cada 6 meses (semestral) 12 - A cada 12 meses (anual) |
cabecalho.dVigFinal | texto · até 10 | Data de vigência final do contrato de serviços. |
cabecalho.dVigInicial | texto · até 10 | Data da vigência inicial do contrato de serviços. |
cabecalho.nCodCli | número inteiro | Código do cliente a que se refere o contrato de serviços. (Gerado internamente, não é visualizado na tela) |
cabecalho.nCodCtr | número inteiro | Código do contrato de serviços. (Gerado internamente, não é visualizado na tela) |
cabecalho.nDiaFat | número inteiro | Dia de faturamento. |
cabecalho.nValTotMes | número | Valor total mensal do contrato de serviços. (Calculado automaticamente) |
departamentos | lista de objetos | Distribuição por departamento |
departamentos[].cCodDep | texto · até 40 | Código do Departamento |
departamentos[].cDesDep | texto · até 50 | Descrição do Departamento |
departamentos[].nPerDep | número | Percentual do rateio |
departamentos[].nValDep | número | Valor do rateio |
despesasReembolsaveis | objeto | Despesas reembolsáveis |
despesasReembolsaveis.cCodCategReemb | texto · até 20 | Código da categoria para reembolso |
despesasReembolsaveis.despesaReembolsavel | lista de objetos | Despesa reembolsável |
despesasReembolsaveis.despesaReembolsavel[].cAcaoReemb | texto · até 1 | Ação para o reembolso, pode ser: I - Inclusão A - Alteração E - Exclusão |
despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto · até 200 | Descrição do reembolso |
despesasReembolsaveis.despesaReembolsavel[].cRecorrenteReemb | texto · até 1 | Indica se o reembolso é recorrente. [S/N] |
despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto · até 10 | Data do reembolso |
despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso |
despesasReembolsaveis.despesaReembolsavel[].nValorReemb | número | Valor do Reembolso |
emailCliente | objeto | Dados do envio de e-mail do cliente |
emailCliente.cEnvViaUnica | texto · até 1 | Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não |
emailCliente.cEnviarBoleto | texto · até 1 | Enviar também o(s) boleto(s) de cobrança |
emailCliente.cEnviarLinkNfse | texto · até 1 | Enviar o link da NFS-e gerada na Prefeitura |
emailCliente.cEnviarPix | texto · até 1 | Enviar também o(s) PIX(s) de cobrança |
emailCliente.cEnviarRecibo | texto · até 1 | Enviar um recibo de prestação de serviço (ao invés de NFS-e) |
emailCliente.cUtilizarEmails | texto | Utilizar os seguintes endereços de e-mail |
infAdic | objeto | |
infAdic.cCidPrestServ | texto · até 40 | Cidade da Prestação do Serviço e Estado |
infAdic.cCodART | texto · até 20 | Código ART |
infAdic.cCodCateg | texto · até 20 | Código da Categoria |
infAdic.cCodObra | texto · até 15 | Código da Obra |
infAdic.cContato | texto · até 100 | Nome do Contato |
infAdic.cDadosAdicNF | texto | Dados Adicionais para a Nota Fiscal |
infAdic.cNumEncap | texto · até 15 | Código de Encapsulamento de notas dedutoras |
infAdic.cUsoConsumo | texto · até 1 | Uso e consumo pessoal. (0=Não, 1=Sim). |
infAdic.nCodCC | número inteiro | Código da Conta Corrente |
infAdic.nCodProj | número inteiro | Código do Projeto |
infAdic.nCodVend | número inteiro | Código do Vendedor |
infAdic.nIdDestinatario | número inteiro | ID Cliente para o Destinatário. |
infoCadastro | objeto | Informações complementares do contrato. |
infoCadastro.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
infoCadastro.cOrigem | texto · até 3 | Origem do Contrato de Serviço. Informado na Inclusão. |
infoCadastro.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
itensContrato | lista de objetos | |
itensContrato[].itemCabecalho | objeto | |
itensContrato[].itemCabecalho.aliqDesconto | número | Aliquota do Desconto. |
itensContrato[].itemCabecalho.cCodCategItem | texto · até 20 | Código da Categoria. |
itensContrato[].itemCabecalho.cNaoGerarFinanceiro | texto · até 1 | Não gerar conta a receber para este item. Informar "S" para não gerar movimento financeiro. Informar "N" para gerar movimento financeiro. |
itensContrato[].itemCabecalho.cTpDesconto | texto · até 1 | Tipo de Desconto. Pode ser: P - Percentual V - Valor |
itensContrato[].itemCabecalho.codIntItem | texto · até 30 | Código de integração do item do contrato. |
itensContrato[].itemCabecalho.codItem | número inteiro | Identificação do Item do Contrato. (Gerado automaticamente na Inclusão do item do contrato) |
itensContrato[].itemCabecalho.codLC116 | texto · até 10 | Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Tabela única para todos os municípios. |
itensContrato[].itemCabecalho.codNBS | texto · até 9 | Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag "codServico" irá assumir o valor informado no cadastro do respectivo serviço. |
itensContrato[].itemCabecalho.codServMunic | texto · até 20 | Código do Serviço Municipal ou CNAE. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis. |
itensContrato[].itemCabecalho.codServico | número inteiro | Código Interno do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API. |
itensContrato[].itemCabecalho.natOperacao | texto · até 2 | Natureza da Operação ou Tipo de Tributação dos Serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis. |
itensContrato[].itemCabecalho.quant | número | Quantidade de serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor padrão 1. |
itensContrato[].itemCabecalho.seq | número inteiro | Sequência do Item do Contrato. |
itensContrato[].itemCabecalho.valorAcrescimo | número | Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.) |
itensContrato[].itemCabecalho.valorDed | número | Valor de Deduções. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemCabecalho.valorDesconto | número | Valor do Desconto. |
itensContrato[].itemCabecalho.valorOutrasRetencoes | número | Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.) |
itensContrato[].itemCabecalho.valorTotal | número | Valor total do item. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemCabecalho.valorUnit | número | Valor Unitário do serviço. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
itensContrato[].itemDescrServ | objeto | |
itensContrato[].itemDescrServ.descrCompleta | texto | Informe a descrição completa do serviço prestado |
itensContrato[].itemImpostos | objeto | |
itensContrato[].itemImpostos.aliqCOFINS | número | Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemImpostos.aliqCSLLobrigatório | número | Alíquota de CSLL. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.aliqCbs | número | Alíquota da CBS Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.aliqINSSobrigatório | número | Alíquota de INSS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.aliqIRobrigatório | número | Alíquota de IR. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.aliqISS | número | Alíquota de ISS. |
itensContrato[].itemImpostos.aliqIbsMun | número | Alíquota do Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.aliqIbsUf | número | Alíquota do IBS Estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.aliqPISobrigatório | número | Alíquota de PIS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.cUtilizaValorImposto | texto · até 1 | Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota. Assim: Caso seja informado "N", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo. Caso seja informado "S", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo. |
itensContrato[].itemImpostos.classTrib | texto · até 6 | Código de Classificação Tributária. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.cstIbsCbs | texto · até 3 | Código da Situação Tributária IBS/CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.indOper | texto · até 6 | Código Indicador de Operação. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.lDeduzISS | sim/não | Deduz o ISS da Base de Cálculo de PIS e COFINS |
itensContrato[].itemImpostos.manCbs | texto · até 1 | Indica que houve alteração manual da alíquota de CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.manIbsMun | texto · até 1 | Indica que houve alteração manual da alíquota de IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.manIbsUf | texto · até 1 | Indica que houve alteração manual da alíquota de IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.percReducaoCbs | número | Percentual redução CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.percReducaoIbsMun | número | Percentual redução IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.percReducaoIbsUf | número | Percentual redução IBS municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.redBaseCOFINS | número | Percentual de Redução da Base de Cálculo do COFINS. |
itensContrato[].itemImpostos.redBaseINSS | número | Percentual de Redução da Base de Cálculo do INSS. |
itensContrato[].itemImpostos.redBasePIS | número | Percentual de Redução da Base de Cálculo do PIS. |
itensContrato[].itemImpostos.retCOFINS | texto · até 1 | Retém COFINS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retCSLL | texto · até 1 | Retém CSLL (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retINSS | texto · até 1 | Retém INSS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retIR | texto · até 1 | Retém IR (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retISS | texto · até 1 | Retém ISS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retPIS | texto · até 1 | Retém PIS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.valorCOFINSobrigatório | número | Alíquota de COFINS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.valorCSLL | número | Valor de CSLL. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemImpostos.valorCbs | número | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.valorINSS | número | Valor de INSS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemImpostos.valorIR | número | Valor do IR. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemImpostos.valorISS | número | Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemImpostos.valorIbsMun | número | Valor do IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.valorIbsUf | número | Valor do IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.valorPIS | número | Valor do PIS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemLeiTranspImp | objeto | |
itensContrato[].itemLeiTranspImp.aliMunicipal | número | Alíquota Carga Trib. Aprox. Municipal |
itensContrato[].itemLeiTranspImp.aliqEstadual | número | Alíquota Carga Trib. Aprox. Estadual |
itensContrato[].itemLeiTranspImp.aliqFederal | número | Alíquota da Carga Tributária Aprox. Federal |
itensContrato[].itemLeiTranspImp.chave | texto · até 6 | Chave do IBPT |
itensContrato[].itemLeiTranspImp.fonte | texto · até 34 | Fonte do IBPT |
itensContrato[].itemOutrasInf | objeto | Outras informações do item do contrato de serviços |
itensContrato[].itemOutrasInf.dItVigFinal | texto · até 10 | Data da vigência final do item do contrato de serviços |
itensContrato[].itemOutrasInf.dItVigInicial | texto · até 10 | Data da vigência inicial do item do contrato de serviços |
itensContrato[].itemOutrasInf.nTipoItVigFinal | número inteiro | Tipo da vigência final do item do contrato de serviços. Valores possiveis: 1 - Data especifica 2 - Segue a vigência final do contrato 3 - Apenas para o proximo faturamento |
itensContrato[].itemViaUnica | objeto | Informações referente ao serviço da NF modelo 21 ou 22. |
itensContrato[].itemViaUnica.cCFOP | texto · até 10 | Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação. |
itensContrato[].itemViaUnica.cClassifServico | texto · até 4 | Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação. |
itensContrato[].itemViaUnica.cModeloNF | texto · até 2 | Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação |
itensContrato[].itemViaUnica.cTipoReceita | texto · até 1 | Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros |
itensContrato[].itemViaUnica.cTipoUtilizacao | texto · até 1 | Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação. |
observacoes | objeto | Observações do contrato |
observacoes.cObsContrato | texto | Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal). |
produtosUtilizados | objeto | Produtos Utilizados no contrato. |
produtosUtilizados.cAcaoProdUtilizados | texto · até 3 | Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. PED - Será gerado um pedido de venda. Obrigatório na inclusão. |
produtosUtilizados.cCodCategRem | texto · até 20 | Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'. |
produtosUtilizados.produtoUtilizado | lista de objetos | Produtos utilizados no serviço. |
produtosUtilizados.produtoUtilizado[].cAcaoItemPU | texto · até 1 | Pode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração. |
produtosUtilizados.produtoUtilizado[].codigo_local_estoque | número inteiro | Código do Local do Estoque. |
produtosUtilizados.produtoUtilizado[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
produtosUtilizados.produtoUtilizado[].lote_validade[].nIdLote | número inteiro | Id do lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
produtosUtilizados.produtoUtilizado[].lote_validade[].nQtdLoteobrigatório | número | Informe aqui a quantidade do lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
produtosUtilizados.produtoUtilizado[].nCodProdutoPU | número inteiro | Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie. |
produtosUtilizados.produtoUtilizado[].nIdItemPU | número inteiro | (Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie. |
produtosUtilizados.produtoUtilizado[].nQtdePU | número | Quantidade. |
vencTextos | objeto | |
vencTextos.cAdContrato | texto · até 1 | Adicionar o "Nº do Contrato" à descrição dos serviços na NFS-e |
vencTextos.cAdPeriodo | texto · até 1 | Adicionar o período de referência associado ao faturamento |
vencTextos.cAdVenc | texto · até 1 | Adicionar o vencimento da parcela à descrição dos serviços na NFS-e |
vencTextos.cAntecipar | texto · até 1 | Define se deve antecipar o vencimento ao considerar apenas dias úteis |
vencTextos.cCodPerRef | texto · até 3 | Período de Referência - Código do período de referência para o faturamento. Pode ser: 001 Mês do faturamento 002 Mês Anterior ao faturamento 003 Mês Posterior ao faturamento 004 Período Anterior ao faturamento 005 Período Posterior ao faturamento 006 Período Anterior específico 007 Número da Parcela 008 Período Posterior específico 009 Período Atual específico |
vencTextos.cDiaFim | texto · até 2 | Dia Final - Dia para a data final do período de referência associado ao faturamento |
vencTextos.cDiaIni | texto · até 2 | Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial |
vencTextos.cPostergar | texto · até 1 | Postergar Sábados, Domingos e Feriados Nacionais |
vencTextos.cProxMes | texto · até 1 | Define se o vencimento ocorrerá somente no mês seguinte. |
vencTextos.cTpVenc | texto · até 3 | Tipo de Vencimento. Pode ser: 001-Número de dias após faturar. 002-Fixar dia do mês (1 a 31). |
vencTextos.nDiaFixo | número inteiro | Dia de vencimento fixo para a gerar o contas a receber |
vencTextos.nDias | número inteiro | Número de Dias para a gerar o contas a receber |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntCtr | texto | Código de Integração do Contrato de Serviço |
cCodStatus | texto | Código do Status |
cDescStatus | texto | Descrição do Status |
nCodCtr | número inteiro | Código da Contrato de Serviço |
POST /api/v1/servicos/contrato/
curl -s https://app.omie.com.br/api/v1/servicos/contrato/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirContrato", "param": [{"cabecalho": {"cCodIntCtr": "019289Tb2", "cCodSit": "10", "cNumCtr": "2020/01001", "cTipoFat": "01", "dVigFinal": "30/03/2022", "dVigInicial": "29/03/2020", "nCodCli": 2370765, "nDiaFat": 30, "nValTotMes": 3302}, "departamentos": [], "emailCliente": {"cEnviarBoleto": "", "cEnviarLinkNfse": "", "cEnviarRecibo": "", "cUtilizarEmails": ""}, "infAdic": {"cCidPrestServ": "PETROPOLIS (RJ)", "cCodART": "", "cCodCateg": "1.01.02", "cCodObra": "", "cContato": "", "cDadosAdicNF": "", "nCodCC": 1208238, "nCodProj": 0, "nCodVend": 0}, "itensContrato": [{"itemCabecalho": {"codIntItem": "1", "cCodCategItem": "", "cNaoGerarFinanceiro": "N", "codLC116": "3.05", "codNBS": "", "codServMunic": "01292", "codServico": 0, "natOperacao": "01", "quant": 1, "seq": 1, "valorDed": 0, "valorTotal": 3002, "valorUnit": 3002}, "itemDescrServ": {"descrCompleta": "Serviços prestados"}, "itemImpostos": {"aliqCOFINS": 0, "aliqCSLL": 0, "aliqINSS": 0, "aliqIR": 0, "aliqISS": 5, "aliqPIS": 0, "redBaseINSS": 0, "retCOFINS": "", "retCSLL": "", "retINSS": "", "retIR": "", "retISS": "N", "retPIS": "", "valorCOFINS": 0, "valorCSLL": 0, "valorINSS": 0, "valorIR": 0, "valorISS": 150.1, "valorPIS": 0}, "itemLeiTranspImp": {"aliMunicipal": 0, "aliqEstadual": 0, "aliqFederal": 0, "chave": "", "fonte": ""}}, {"itemCabecalho": {"codIntItem": "2", "cCodCategItem": "", "cNaoGerarFinanceiro": "N", "codLC116": "17.01", "codNBS": "", "codServMunic": "0162-8/99", "codServico": 3412648, "natOperacao": "01", "quant": 1, "seq": 2, "valorDed": 0, "valorTotal": 300, "valorUnit": 300}, "itemDescrServ": {"descrCompleta": "Homologação de processo contábil"}, "itemImpostos": {"aliqCOFINS": 0, "aliqCSLL": 0, "aliqINSS": 0, "aliqIR": 0, "aliqISS": 3, "aliqPIS": 0, "redBaseINSS": 0, "retCOFINS": "", "retCSLL": "", "retINSS": "", "retIR": "", "retISS": "N", "retPIS": "", "valorCOFINS": 0, "valorCSLL": 0, "valorINSS": 0, "valorIR": 0, "valorISS": 9, "valorPIS": 0}, "itemLeiTranspImp": {"aliMunicipal": 0, "aliqEstadual": 0, "aliqFederal": 0, "chave": "", "fonte": ""}}], "observacoes": {"cObsContrato": ""}, "vencTextos": {"cAdContrato": "N", "cAdPeriodo": "N", "cAdVenc": " ", "cAntecipar": "", "cCodPerRef": "001", "cDiaFim": 0, "cDiaIni": 0, "cPostergar": "", "cProxMes": "", "cTpVenc": "001", "nDiaFixo": 0, "nDias": 5}}]}'import os
import requests
corpo = {'call': 'IncluirContrato',
'param': [{'cabecalho': {'cCodIntCtr': '019289Tb2',
'cCodSit': '10',
'cNumCtr': '2020/01001',
'cTipoFat': '01',
'dVigFinal': '30/03/2022',
'dVigInicial': '29/03/2020',
'nCodCli': 2370765,
'nDiaFat': 30,
'nValTotMes': 3302},
'departamentos': [],
'emailCliente': {'cEnviarBoleto': '',
'cEnviarLinkNfse': '',
'cEnviarRecibo': '',
'cUtilizarEmails': ''},
'infAdic': {'cCidPrestServ': 'PETROPOLIS (RJ)',
'cCodART': '',
'cCodCateg': '1.01.02',
'cCodObra': '',
'cContato': '',
'cDadosAdicNF': '',
'nCodCC': 1208238,
'nCodProj': 0,
'nCodVend': 0},
'itensContrato': [{'itemCabecalho': {'codIntItem': '1',
'cCodCategItem': '',
'cNaoGerarFinanceiro': 'N',
'codLC116': '3.05',
'codNBS': '',
'codServMunic': '01292',
'codServico': 0,
'natOperacao': '01',
'quant': 1,
'seq': 1,
'valorDed': 0,
'valorTotal': 3002,
'valorUnit': 3002},
'itemDescrServ': {'descrCompleta': 'Serviços prestados'},
'itemImpostos': {'aliqCOFINS': 0,
'aliqCSLL': 0,
'aliqINSS': 0,
'aliqIR': 0,
'aliqISS': 5,
'aliqPIS': 0,
'redBaseINSS': 0,
'retCOFINS': '',
'retCSLL': '',
'retINSS': '',
'retIR': '',
'retISS': 'N',
'retPIS': '',
'valorCOFINS': 0,
'valorCSLL': 0,
'valorINSS': 0,
'valorIR': 0,
'valorISS': 150.1,
'valorPIS': 0},
'itemLeiTranspImp': {'aliMunicipal': 0,
'aliqEstadual': 0,
'aliqFederal': 0,
'chave': '',
'fonte': ''}},
{'itemCabecalho': {'codIntItem': '2',
'cCodCategItem': '',
'cNaoGerarFinanceiro': 'N',
'codLC116': '17.01',
'codNBS': '',
'codServMunic': '0162-8/99',
'codServico': 3412648,
'natOperacao': '01',
'quant': 1,
'seq': 2,
'valorDed': 0,
'valorTotal': 300,
'valorUnit': 300},
'itemDescrServ': {'descrCompleta': 'Homologação de '
'processo contábil'},
'itemImpostos': {'aliqCOFINS': 0,
'aliqCSLL': 0,
'aliqINSS': 0,
'aliqIR': 0,
'aliqISS': 3,
'aliqPIS': 0,
'redBaseINSS': 0,
'retCOFINS': '',
'retCSLL': '',
'retINSS': '',
'retIR': '',
'retISS': 'N',
'retPIS': '',
'valorCOFINS': 0,
'valorCSLL': 0,
'valorINSS': 0,
'valorIR': 0,
'valorISS': 9,
'valorPIS': 0},
'itemLeiTranspImp': {'aliMunicipal': 0,
'aliqEstadual': 0,
'aliqFederal': 0,
'chave': '',
'fonte': ''}}],
'observacoes': {'cObsContrato': ''},
'vencTextos': {'cAdContrato': 'N',
'cAdPeriodo': 'N',
'cAdVenc': ' ',
'cAntecipar': '',
'cCodPerRef': '001',
'cDiaFim': 0,
'cDiaIni': 0,
'cPostergar': '',
'cProxMes': '',
'cTpVenc': '001',
'nDiaFixo': 0,
'nDias': 5}}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/contrato/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/contrato/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/contrato/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "IncluirContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/contrato/")
corpo = <<~'JSON'
{
"call": "IncluirContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "IncluirContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/contrato/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/contrato/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirContrato"", ""param"": [{""cabecalho"": {""cCodIntCtr"": ""019289Tb2"", ""cCodSit"": ""10"", ""cNumCtr"": ""2020/01001"", ""cTipoFat"": ""01"", ""dVigFinal"": ""30/03/2022"", ""dVigInicial"": ""29/03/2020"", ""nCodCli"": 2370765, ""nDiaFat"": 30, ""nValTotMes"": 3302}, ""departamentos"": [], ""emailCliente"": {""cEnviarBoleto"": """", ""cEnviarLinkNfse"": """", ""cEnviarRecibo"": """", ""cUtilizarEmails"": """"}, ""infAdic"": {""cCidPrestServ"": ""PETROPOLIS (RJ)"", ""cCodART"": """", ""cCodCateg"": ""1.01.02"", ""cCodObra"": """", ""cContato"": """", ""cDadosAdicNF"": """", ""nCodCC"": 1208238, ""nCodProj"": 0, ""nCodVend"": 0}, ""itensContrato"": [{""itemCabecalho"": {""codIntItem"": ""1"", ""cCodCategItem"": """", ""cNaoGerarFinanceiro"": ""N"", ""codLC116"": ""3.05"", ""codNBS"": """", ""codServMunic"": ""01292"", ""codServico"": 0, ""natOperacao"": ""01"", ""quant"": 1, ""seq"": 1, ""valorDed"": 0, ""valorTotal"": 3002, ""valorUnit"": 3002}, ""itemDescrServ"": {""descrCompleta"": ""Serviços prestados""}, ""itemImpostos"": {""aliqCOFINS"": 0, ""aliqCSLL"": 0, ""aliqINSS"": 0, ""aliqIR"": 0, ""aliqISS"": 5, ""aliqPIS"": 0, ""redBaseINSS"": 0, ""retCOFINS"": """", ""retCSLL"": """", ""retINSS"": """", ""retIR"": """", ""retISS"": ""N"", ""retPIS"": """", ""valorCOFINS"": 0, ""valorCSLL"": 0, ""valorINSS"": 0, ""valorIR"": 0, ""valorISS"": 150.1, ""valorPIS"": 0}, ""itemLeiTranspImp"": {""aliMunicipal"": 0, ""aliqEstadual"": 0, ""aliqFederal"": 0, ""chave"": """", ""fonte"": """"}}, {""itemCabecalho"": {""codIntItem"": ""2"", ""cCodCategItem"": """", ""cNaoGerarFinanceiro"": ""N"", ""codLC116"": ""17.01"", ""codNBS"": """", ""codServMunic"": ""0162-8/99"", ""codServico"": 3412648, ""natOperacao"": ""01"", ""quant"": 1, ""seq"": 2, ""valorDed"": 0, ""valorTotal"": 300, ""valorUnit"": 300}, ""itemDescrServ"": {""descrCompleta"": ""Homologação de processo contábil""}, ""itemImpostos"": {""aliqCOFINS"": 0, ""aliqCSLL"": 0, ""aliqINSS"": 0, ""aliqIR"": 0, ""aliqISS"": 3, ""aliqPIS"": 0, ""redBaseINSS"": 0, ""retCOFINS"": """", ""retCSLL"": """", ""retINSS"": """", ""retIR"": """", ""retISS"": ""N"", ""retPIS"": """", ""valorCOFINS"": 0, ""valorCSLL"": 0, ""valorINSS"": 0, ""valorIR"": 0, ""valorISS"": 9, ""valorPIS"": 0}, ""itemLeiTranspImp"": {""aliMunicipal"": 0, ""aliqEstadual"": 0, ""aliqFederal"": 0, ""chave"": """", ""fonte"": """"}}], ""observacoes"": {""cObsContrato"": """"}, ""vencTextos"": {""cAdContrato"": ""N"", ""cAdPeriodo"": ""N"", ""cAdVenc"": "" "", ""cAntecipar"": """", ""cCodPerRef"": ""001"", ""cDiaFim"": 0, ""cDiaIni"": 0, ""cPostergar"": """", ""cProxMes"": """", ""cTpVenc"": ""001"", ""nDiaFixo"": 0, ""nDias"": 5}}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosLista os contratos cadastrados.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 14Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | texto · até 1 | |
cExibeObs | texto · até 1 | (S/N) Indica se a "Observação / Dados Adicionais" serão retornados na listagem. |
cExibirInfoCadastro | texto · até 1 | Exibir as informações complementares do contrato (S/N). Preencher com "S" ou "N". |
cExibirProdutos | texto · até 1 | Exibir os produtos utilizados (S/N). Preencher com "S" ou "N". |
filtrar_apenas_alteracao | texto · até 1 | |
filtrar_apenas_inclusao | texto · até 1 | |
filtrar_cliente | número inteiro | |
filtrar_cnpj_cpf | texto · até 20 | Filtrar os contratos por CNPJ/CPF. |
filtrar_por_data_ate | texto · até 10 | |
filtrar_por_data_de | texto · até 10 | |
ordem_descrescente | texto · até 1 | |
ordenar_por | texto · até 100 | Ordem de exibição dos dados. Padrão: Código. |
pagina | número inteiro | |
registros_por_pagina | número inteiro |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
contratoCadastro | lista de objetos | Cadastro de Contrato de Serviço |
contratoCadastro[].cabecalho | objeto | |
contratoCadastro[].cabecalho.cCodIntCtr | texto | Código de integração do contrato de serviços. (Utilizado em contratos criados via API, não é visualizado na tela) |
contratoCadastro[].cabecalho.cCodSit | texto | Código da situação do contrato de serviços. Pode ser: 00 - Em Elaboração 10 - Ativo 90 - Suspenso 99 - Cancelado |
contratoCadastro[].cabecalho.cNumCtr | texto | Número do contrato de serviços. (Informado pelo usuário / visualizado na tela) |
contratoCadastro[].cabecalho.cTipoFat | texto | Tipo de Faturamento do Contrato. Pode ser: 01 - Todo Mês (mensal) 02 - A cada 2 meses (bimestral) 03 - A cada 3 meses (trimestral) 06 - A cada 6 meses (semestral) 12 - A cada 12 meses (anual) |
contratoCadastro[].cabecalho.dVigFinal | texto | Data de vigência final do contrato de serviços. |
contratoCadastro[].cabecalho.dVigInicial | texto | Data da vigência inicial do contrato de serviços. |
contratoCadastro[].cabecalho.nCodCli | número inteiro | Código do cliente a que se refere o contrato de serviços. (Gerado internamente, não é visualizado na tela) |
contratoCadastro[].cabecalho.nCodCtr | número inteiro | Código do contrato de serviços. (Gerado internamente, não é visualizado na tela) |
contratoCadastro[].cabecalho.nDiaFat | número inteiro | Dia de faturamento. |
contratoCadastro[].cabecalho.nValTotMes | decimal | Valor total mensal do contrato de serviços. (Calculado automaticamente) |
contratoCadastro[].departamentos | lista de objetos | Distribuição por departamento |
contratoCadastro[].departamentos[].cCodDep | texto | Código do Departamento |
contratoCadastro[].departamentos[].cDesDep | texto | Descrição do Departamento |
contratoCadastro[].departamentos[].nPerDep | decimal | Percentual do rateio |
contratoCadastro[].departamentos[].nValDep | decimal | Valor do rateio |
contratoCadastro[].despesasReembolsaveis | objeto | Despesas reembolsáveis |
contratoCadastro[].despesasReembolsaveis.cCodCategReemb | texto | Código da categoria para reembolso |
contratoCadastro[].despesasReembolsaveis.despesaReembolsavel | lista de objetos | Despesa reembolsável |
contratoCadastro[].despesasReembolsaveis.despesaReembolsavel[].cAcaoReemb | texto | Ação para o reembolso, pode ser: I - Inclusão A - Alteração E - Exclusão |
contratoCadastro[].despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto | Descrição do reembolso |
contratoCadastro[].despesasReembolsaveis.despesaReembolsavel[].cRecorrenteReemb | texto | Indica se o reembolso é recorrente. [S/N] |
contratoCadastro[].despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto | Data do reembolso |
contratoCadastro[].despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso |
contratoCadastro[].despesasReembolsaveis.despesaReembolsavel[].nValorReemb | decimal | Valor do Reembolso |
contratoCadastro[].emailCliente | objeto | Dados do envio de e-mail do cliente |
contratoCadastro[].emailCliente.cEnvViaUnica | texto | Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não |
contratoCadastro[].emailCliente.cEnviarBoleto | texto | Enviar também o(s) boleto(s) de cobrança |
contratoCadastro[].emailCliente.cEnviarLinkNfse | texto | Enviar o link da NFS-e gerada na Prefeitura |
contratoCadastro[].emailCliente.cEnviarPix | texto | Enviar também o(s) PIX(s) de cobrança |
contratoCadastro[].emailCliente.cEnviarRecibo | texto | Enviar um recibo de prestação de serviço (ao invés de NFS-e) |
contratoCadastro[].emailCliente.cUtilizarEmails | texto | Utilizar os seguintes endereços de e-mail |
contratoCadastro[].infAdic | objeto | |
contratoCadastro[].infAdic.cCidPrestServ | texto | Cidade da Prestação do Serviço e Estado |
contratoCadastro[].infAdic.cCodART | texto | Código ART |
contratoCadastro[].infAdic.cCodCateg | texto | Código da Categoria |
contratoCadastro[].infAdic.cCodObra | texto | Código da Obra |
contratoCadastro[].infAdic.cContato | texto | Nome do Contato |
contratoCadastro[].infAdic.cDadosAdicNF | texto | Dados Adicionais para a Nota Fiscal |
contratoCadastro[].infAdic.cNumEncap | texto | Código de Encapsulamento de notas dedutoras |
contratoCadastro[].infAdic.cUsoConsumo | texto | Uso e consumo pessoal. (0=Não, 1=Sim). |
contratoCadastro[].infAdic.nCodCC | número inteiro | Código da Conta Corrente |
contratoCadastro[].infAdic.nCodProj | número inteiro | Código do Projeto |
contratoCadastro[].infAdic.nCodVend | número inteiro | Código do Vendedor |
contratoCadastro[].infAdic.nIdDestinatario | número inteiro | ID Cliente para o Destinatário. |
contratoCadastro[].infoCadastro | objeto | Informações complementares do contrato. |
contratoCadastro[].infoCadastro.cImpAPI | texto | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
contratoCadastro[].infoCadastro.cOrigem | texto | Origem do Contrato de Serviço. Informado na Inclusão. |
contratoCadastro[].infoCadastro.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro[].infoCadastro.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro[].infoCadastro.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro[].infoCadastro.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro[].infoCadastro.uAlt | texto | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro[].infoCadastro.uInc | texto | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
contratoCadastro[].itensContrato | lista de objetos | |
contratoCadastro[].itensContrato[].itemCabecalho | objeto | |
contratoCadastro[].itensContrato[].itemCabecalho.aliqDesconto | decimal | Aliquota do Desconto. |
contratoCadastro[].itensContrato[].itemCabecalho.cCodCategItem | texto | Código da Categoria. |
contratoCadastro[].itensContrato[].itemCabecalho.cNaoGerarFinanceiro | texto | Não gerar conta a receber para este item. Informar "S" para não gerar movimento financeiro. Informar "N" para gerar movimento financeiro. |
contratoCadastro[].itensContrato[].itemCabecalho.cTpDesconto | texto | Tipo de Desconto. Pode ser: P - Percentual V - Valor |
contratoCadastro[].itensContrato[].itemCabecalho.codIntItem | texto | Código de integração do item do contrato. |
contratoCadastro[].itensContrato[].itemCabecalho.codItem | número inteiro | Identificação do Item do Contrato. (Gerado automaticamente na Inclusão do item do contrato) |
contratoCadastro[].itensContrato[].itemCabecalho.codLC116 | texto | Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Tabela única para todos os municípios. |
contratoCadastro[].itensContrato[].itemCabecalho.codNBS | texto | Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag "codServico" irá assumir o valor informado no cadastro do respectivo serviço. |
contratoCadastro[].itensContrato[].itemCabecalho.codServMunic | texto | Código do Serviço Municipal ou CNAE. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis. |
contratoCadastro[].itensContrato[].itemCabecalho.codServico | número inteiro | Código Interno do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API. |
contratoCadastro[].itensContrato[].itemCabecalho.natOperacao | texto | Natureza da Operação ou Tipo de Tributação dos Serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis. |
contratoCadastro[].itensContrato[].itemCabecalho.quant | decimal | Quantidade de serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor padrão 1. |
contratoCadastro[].itensContrato[].itemCabecalho.seq | número inteiro | Sequência do Item do Contrato. |
contratoCadastro[].itensContrato[].itemCabecalho.valorAcrescimo | decimal | Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.) |
contratoCadastro[].itensContrato[].itemCabecalho.valorDed | decimal | Valor de Deduções. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
contratoCadastro[].itensContrato[].itemCabecalho.valorDesconto | decimal | Valor do Desconto. |
contratoCadastro[].itensContrato[].itemCabecalho.valorOutrasRetencoes | decimal | Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.) |
contratoCadastro[].itensContrato[].itemCabecalho.valorTotal | decimal | Valor total do item. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
contratoCadastro[].itensContrato[].itemCabecalho.valorUnit | decimal | Valor Unitário do serviço. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
contratoCadastro[].itensContrato[].itemDescrServ | objeto | |
contratoCadastro[].itensContrato[].itemDescrServ.descrCompleta | texto | Informe a descrição completa do serviço prestado |
contratoCadastro[].itensContrato[].itemImpostos | objeto | |
contratoCadastro[].itensContrato[].itemImpostos.aliqCOFINS | decimal | Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
contratoCadastro[].itensContrato[].itemImpostos.aliqCSLL | decimal | Alíquota de CSLL. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro[].itensContrato[].itemImpostos.aliqCbs | decimal | Alíquota da CBS Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.aliqINSS | decimal | Alíquota de INSS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro[].itensContrato[].itemImpostos.aliqIR | decimal | Alíquota de IR. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro[].itensContrato[].itemImpostos.aliqISS | decimal | Alíquota de ISS. |
contratoCadastro[].itensContrato[].itemImpostos.aliqIbsMun | decimal | Alíquota do Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.aliqIbsUf | decimal | Alíquota do IBS Estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.aliqPIS | decimal | Alíquota de PIS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro[].itensContrato[].itemImpostos.cUtilizaValorImposto | texto | Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota. Assim: Caso seja informado "N", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo. Caso seja informado "S", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo. |
contratoCadastro[].itensContrato[].itemImpostos.classTrib | texto | Código de Classificação Tributária. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.cstIbsCbs | texto | Código da Situação Tributária IBS/CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.indOper | texto | Código Indicador de Operação. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.lDeduzISS | sim/não | Deduz o ISS da Base de Cálculo de PIS e COFINS |
contratoCadastro[].itensContrato[].itemImpostos.manCbs | texto | Indica que houve alteração manual da alíquota de CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.manIbsMun | texto | Indica que houve alteração manual da alíquota de IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.manIbsUf | texto | Indica que houve alteração manual da alíquota de IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.percReducaoCbs | decimal | Percentual redução CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.percReducaoIbsMun | decimal | Percentual redução IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.percReducaoIbsUf | decimal | Percentual redução IBS municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.redBaseCOFINS | decimal | Percentual de Redução da Base de Cálculo do COFINS. |
contratoCadastro[].itensContrato[].itemImpostos.redBaseINSS | decimal | Percentual de Redução da Base de Cálculo do INSS. |
contratoCadastro[].itensContrato[].itemImpostos.redBasePIS | decimal | Percentual de Redução da Base de Cálculo do PIS. |
contratoCadastro[].itensContrato[].itemImpostos.retCOFINS | texto | Retém COFINS (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro[].itensContrato[].itemImpostos.retCSLL | texto | Retém CSLL (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro[].itensContrato[].itemImpostos.retINSS | texto | Retém INSS (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro[].itensContrato[].itemImpostos.retIR | texto | Retém IR (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro[].itensContrato[].itemImpostos.retISS | texto | Retém ISS (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro[].itensContrato[].itemImpostos.retPIS | texto | Retém PIS (S/N). Indica se o imposto deve ser retido ou não. |
contratoCadastro[].itensContrato[].itemImpostos.valorCOFINS | decimal | Alíquota de COFINS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
contratoCadastro[].itensContrato[].itemImpostos.valorCSLL | decimal | Valor de CSLL. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
contratoCadastro[].itensContrato[].itemImpostos.valorCbs | decimal | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.valorINSS | decimal | Valor de INSS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
contratoCadastro[].itensContrato[].itemImpostos.valorIR | decimal | Valor do IR. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
contratoCadastro[].itensContrato[].itemImpostos.valorISS | decimal | Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
contratoCadastro[].itensContrato[].itemImpostos.valorIbsMun | decimal | Valor do IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.valorIbsUf | decimal | Valor do IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
contratoCadastro[].itensContrato[].itemImpostos.valorPIS | decimal | Valor do PIS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
contratoCadastro[].itensContrato[].itemLeiTranspImp | objeto | |
contratoCadastro[].itensContrato[].itemLeiTranspImp.aliMunicipal | decimal | Alíquota Carga Trib. Aprox. Municipal |
contratoCadastro[].itensContrato[].itemLeiTranspImp.aliqEstadual | decimal | Alíquota Carga Trib. Aprox. Estadual |
contratoCadastro[].itensContrato[].itemLeiTranspImp.aliqFederal | decimal | Alíquota da Carga Tributária Aprox. Federal |
contratoCadastro[].itensContrato[].itemLeiTranspImp.chave | texto | Chave do IBPT |
contratoCadastro[].itensContrato[].itemLeiTranspImp.fonte | texto | Fonte do IBPT |
contratoCadastro[].itensContrato[].itemOutrasInf | objeto | Outras informações do item do contrato de serviços |
contratoCadastro[].itensContrato[].itemOutrasInf.dItVigFinal | texto | Data da vigência final do item do contrato de serviços |
contratoCadastro[].itensContrato[].itemOutrasInf.dItVigInicial | texto | Data da vigência inicial do item do contrato de serviços |
contratoCadastro[].itensContrato[].itemOutrasInf.nTipoItVigFinal | número inteiro | Tipo da vigência final do item do contrato de serviços. Valores possiveis: 1 - Data especifica 2 - Segue a vigência final do contrato 3 - Apenas para o proximo faturamento |
contratoCadastro[].itensContrato[].itemViaUnica | objeto | Informações referente ao serviço da NF modelo 21 ou 22. |
contratoCadastro[].itensContrato[].itemViaUnica.cCFOP | texto | Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação. |
contratoCadastro[].itensContrato[].itemViaUnica.cClassifServico | texto | Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação. |
contratoCadastro[].itensContrato[].itemViaUnica.cModeloNF | texto | Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação |
contratoCadastro[].itensContrato[].itemViaUnica.cTipoReceita | texto | Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros |
contratoCadastro[].itensContrato[].itemViaUnica.cTipoUtilizacao | texto | Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação. |
contratoCadastro[].observacoes | objeto | Observações do contrato |
contratoCadastro[].observacoes.cObsContrato | texto | Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal). |
contratoCadastro[].produtosUtilizados | objeto | Produtos Utilizados no contrato. |
contratoCadastro[].produtosUtilizados.cAcaoProdUtilizados | texto | Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. PED - Será gerado um pedido de venda. Obrigatório na inclusão. |
contratoCadastro[].produtosUtilizados.cCodCategRem | texto | Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'. |
contratoCadastro[].produtosUtilizados.produtoUtilizado | lista de objetos | Produtos utilizados no serviço. |
contratoCadastro[].produtosUtilizados.produtoUtilizado[].cAcaoItemPU | texto | Pode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração. |
contratoCadastro[].produtosUtilizados.produtoUtilizado[].codigo_local_estoque | número inteiro | Código do Local do Estoque. |
contratoCadastro[].produtosUtilizados.produtoUtilizado[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
contratoCadastro[].produtosUtilizados.produtoUtilizado[].lote_validade[].nIdLote | número inteiro | Id do lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
contratoCadastro[].produtosUtilizados.produtoUtilizado[].lote_validade[].nQtdLote | decimal | Informe aqui a quantidade do lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
contratoCadastro[].produtosUtilizados.produtoUtilizado[].nCodProdutoPU | número inteiro | Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie. |
contratoCadastro[].produtosUtilizados.produtoUtilizado[].nIdItemPU | número inteiro | (Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie. |
contratoCadastro[].produtosUtilizados.produtoUtilizado[].nQtdePU | decimal | Quantidade. |
contratoCadastro[].vencTextos | objeto | |
contratoCadastro[].vencTextos.cAdContrato | texto | Adicionar o "Nº do Contrato" à descrição dos serviços na NFS-e |
contratoCadastro[].vencTextos.cAdPeriodo | texto | Adicionar o período de referência associado ao faturamento |
contratoCadastro[].vencTextos.cAdVenc | texto | Adicionar o vencimento da parcela à descrição dos serviços na NFS-e |
contratoCadastro[].vencTextos.cAntecipar | texto | Define se deve antecipar o vencimento ao considerar apenas dias úteis |
contratoCadastro[].vencTextos.cCodPerRef | texto | Período de Referência - Código do período de referência para o faturamento. Pode ser: 001 Mês do faturamento 002 Mês Anterior ao faturamento 003 Mês Posterior ao faturamento 004 Período Anterior ao faturamento 005 Período Posterior ao faturamento 006 Período Anterior específico 007 Número da Parcela 008 Período Posterior específico 009 Período Atual específico |
contratoCadastro[].vencTextos.cDiaFim | número inteiro | Dia Final - Dia para a data final do período de referência associado ao faturamento |
contratoCadastro[].vencTextos.cDiaIni | número inteiro | Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial |
contratoCadastro[].vencTextos.cPostergar | texto | Postergar Sábados, Domingos e Feriados Nacionais |
contratoCadastro[].vencTextos.cProxMes | texto | Define se o vencimento ocorrerá somente no mês seguinte. |
contratoCadastro[].vencTextos.cTpVenc | texto | Tipo de Vencimento. Pode ser: 001-Número de dias após faturar. 002-Fixar dia do mês (1 a 31). |
contratoCadastro[].vencTextos.nDiaFixo | número inteiro | Dia de vencimento fixo para a gerar o contas a receber |
contratoCadastro[].vencTextos.nDias | número inteiro | Número de Dias para a gerar o contas a receber |
pagina | número inteiro | |
registros | número inteiro | |
total_de_paginas | número inteiro | |
total_de_registros | número inteiro |
POST /api/v1/servicos/contrato/
curl -s https://app.omie.com.br/api/v1/servicos/contrato/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarContratos", "param": [{"pagina": 1, "registros_por_pagina": 50, "apenas_importado_api": "N"}]}'import os
import requests
corpo = {'call': 'ListarContratos',
'param': [{'pagina': 1, 'registros_por_pagina': 50, 'apenas_importado_api': 'N'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/contrato/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/contrato/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarContratos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/contrato/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ListarContratos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/contrato/")
corpo = <<~'JSON'
{
"call": "ListarContratos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ListarContratos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/contrato/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/contrato/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarContratos"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 50, ""apenas_importado_api"": ""N""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInclui / Altera um contrato
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 10Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cabecalho | objeto | |
cabecalho.cCodIntCtr | texto · até 20 | Código de integração do contrato de serviços. (Utilizado em contratos criados via API, não é visualizado na tela) |
cabecalho.cCodSit | texto · até 2 | Código da situação do contrato de serviços. Pode ser: 00 - Em Elaboração 10 - Ativo 90 - Suspenso 99 - Cancelado |
cabecalho.cNumCtr | texto · até 60 | Número do contrato de serviços. (Informado pelo usuário / visualizado na tela) |
cabecalho.cTipoFat | texto · até 2 | Tipo de Faturamento do Contrato. Pode ser: 01 - Todo Mês (mensal) 02 - A cada 2 meses (bimestral) 03 - A cada 3 meses (trimestral) 06 - A cada 6 meses (semestral) 12 - A cada 12 meses (anual) |
cabecalho.dVigFinal | texto · até 10 | Data de vigência final do contrato de serviços. |
cabecalho.dVigInicial | texto · até 10 | Data da vigência inicial do contrato de serviços. |
cabecalho.nCodCli | número inteiro | Código do cliente a que se refere o contrato de serviços. (Gerado internamente, não é visualizado na tela) |
cabecalho.nCodCtr | número inteiro | Código do contrato de serviços. (Gerado internamente, não é visualizado na tela) |
cabecalho.nDiaFat | número inteiro | Dia de faturamento. |
cabecalho.nValTotMes | número | Valor total mensal do contrato de serviços. (Calculado automaticamente) |
departamentos | lista de objetos | Distribuição por departamento |
departamentos[].cCodDep | texto · até 40 | Código do Departamento |
departamentos[].cDesDep | texto · até 50 | Descrição do Departamento |
departamentos[].nPerDep | número | Percentual do rateio |
departamentos[].nValDep | número | Valor do rateio |
despesasReembolsaveis | objeto | Despesas reembolsáveis |
despesasReembolsaveis.cCodCategReemb | texto · até 20 | Código da categoria para reembolso |
despesasReembolsaveis.despesaReembolsavel | lista de objetos | Despesa reembolsável |
despesasReembolsaveis.despesaReembolsavel[].cAcaoReemb | texto · até 1 | Ação para o reembolso, pode ser: I - Inclusão A - Alteração E - Exclusão |
despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto · até 200 | Descrição do reembolso |
despesasReembolsaveis.despesaReembolsavel[].cRecorrenteReemb | texto · até 1 | Indica se o reembolso é recorrente. [S/N] |
despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto · até 10 | Data do reembolso |
despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso |
despesasReembolsaveis.despesaReembolsavel[].nValorReemb | número | Valor do Reembolso |
emailCliente | objeto | Dados do envio de e-mail do cliente |
emailCliente.cEnvViaUnica | texto · até 1 | Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não |
emailCliente.cEnviarBoleto | texto · até 1 | Enviar também o(s) boleto(s) de cobrança |
emailCliente.cEnviarLinkNfse | texto · até 1 | Enviar o link da NFS-e gerada na Prefeitura |
emailCliente.cEnviarPix | texto · até 1 | Enviar também o(s) PIX(s) de cobrança |
emailCliente.cEnviarRecibo | texto · até 1 | Enviar um recibo de prestação de serviço (ao invés de NFS-e) |
emailCliente.cUtilizarEmails | texto | Utilizar os seguintes endereços de e-mail |
infAdic | objeto | |
infAdic.cCidPrestServ | texto · até 40 | Cidade da Prestação do Serviço e Estado |
infAdic.cCodART | texto · até 20 | Código ART |
infAdic.cCodCateg | texto · até 20 | Código da Categoria |
infAdic.cCodObra | texto · até 15 | Código da Obra |
infAdic.cContato | texto · até 100 | Nome do Contato |
infAdic.cDadosAdicNF | texto | Dados Adicionais para a Nota Fiscal |
infAdic.cNumEncap | texto · até 15 | Código de Encapsulamento de notas dedutoras |
infAdic.cUsoConsumo | texto · até 1 | Uso e consumo pessoal. (0=Não, 1=Sim). |
infAdic.nCodCC | número inteiro | Código da Conta Corrente |
infAdic.nCodProj | número inteiro | Código do Projeto |
infAdic.nCodVend | número inteiro | Código do Vendedor |
infAdic.nIdDestinatario | número inteiro | ID Cliente para o Destinatário. |
infoCadastro | objeto | Informações complementares do contrato. |
infoCadastro.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
infoCadastro.cOrigem | texto · até 3 | Origem do Contrato de Serviço. Informado na Inclusão. |
infoCadastro.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
infoCadastro.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
itensContrato | lista de objetos | |
itensContrato[].itemCabecalho | objeto | |
itensContrato[].itemCabecalho.aliqDesconto | número | Aliquota do Desconto. |
itensContrato[].itemCabecalho.cCodCategItem | texto · até 20 | Código da Categoria. |
itensContrato[].itemCabecalho.cNaoGerarFinanceiro | texto · até 1 | Não gerar conta a receber para este item. Informar "S" para não gerar movimento financeiro. Informar "N" para gerar movimento financeiro. |
itensContrato[].itemCabecalho.cTpDesconto | texto · até 1 | Tipo de Desconto. Pode ser: P - Percentual V - Valor |
itensContrato[].itemCabecalho.codIntItem | texto · até 30 | Código de integração do item do contrato. |
itensContrato[].itemCabecalho.codItem | número inteiro | Identificação do Item do Contrato. (Gerado automaticamente na Inclusão do item do contrato) |
itensContrato[].itemCabecalho.codLC116 | texto · até 10 | Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Tabela única para todos os municípios. |
itensContrato[].itemCabecalho.codNBS | texto · até 9 | Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag "codServico" irá assumir o valor informado no cadastro do respectivo serviço. |
itensContrato[].itemCabecalho.codServMunic | texto · até 20 | Código do Serviço Municipal ou CNAE. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis. |
itensContrato[].itemCabecalho.codServico | número inteiro | Código Interno do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API. |
itensContrato[].itemCabecalho.natOperacao | texto · até 2 | Natureza da Operação ou Tipo de Tributação dos Serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis. |
itensContrato[].itemCabecalho.quant | número | Quantidade de serviços. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor padrão 1. |
itensContrato[].itemCabecalho.seq | número inteiro | Sequência do Item do Contrato. |
itensContrato[].itemCabecalho.valorAcrescimo | número | Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.) |
itensContrato[].itemCabecalho.valorDed | número | Valor de Deduções. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemCabecalho.valorDesconto | número | Valor do Desconto. |
itensContrato[].itemCabecalho.valorOutrasRetencoes | número | Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.) |
itensContrato[].itemCabecalho.valorTotal | número | Valor total do item. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemCabecalho.valorUnit | número | Valor Unitário do serviço. Caso tenha informado a tag "codServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
itensContrato[].itemDescrServ | objeto | |
itensContrato[].itemDescrServ.descrCompleta | texto | Informe a descrição completa do serviço prestado |
itensContrato[].itemImpostos | objeto | |
itensContrato[].itemImpostos.aliqCOFINS | número | Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemImpostos.aliqCSLLobrigatório | número | Alíquota de CSLL. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.aliqCbs | número | Alíquota da CBS Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.aliqINSSobrigatório | número | Alíquota de INSS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.aliqIRobrigatório | número | Alíquota de IR. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.aliqISS | número | Alíquota de ISS. |
itensContrato[].itemImpostos.aliqIbsMun | número | Alíquota do Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.aliqIbsUf | número | Alíquota do IBS Estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.aliqPISobrigatório | número | Alíquota de PIS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.cUtilizaValorImposto | texto · até 1 | Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota. Assim: Caso seja informado "N", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo. Caso seja informado "S", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo. |
itensContrato[].itemImpostos.classTrib | texto · até 6 | Código de Classificação Tributária. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.cstIbsCbs | texto · até 3 | Código da Situação Tributária IBS/CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.indOper | texto · até 6 | Código Indicador de Operação. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.lDeduzISS | sim/não | Deduz o ISS da Base de Cálculo de PIS e COFINS |
itensContrato[].itemImpostos.manCbs | texto · até 1 | Indica que houve alteração manual da alíquota de CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.manIbsMun | texto · até 1 | Indica que houve alteração manual da alíquota de IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.manIbsUf | texto · até 1 | Indica que houve alteração manual da alíquota de IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.percReducaoCbs | número | Percentual redução CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.percReducaoIbsMun | número | Percentual redução IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.percReducaoIbsUf | número | Percentual redução IBS municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie. |
itensContrato[].itemImpostos.redBaseCOFINS | número | Percentual de Redução da Base de Cálculo do COFINS. |
itensContrato[].itemImpostos.redBaseINSS | número | Percentual de Redução da Base de Cálculo do INSS. |
itensContrato[].itemImpostos.redBasePIS | número | Percentual de Redução da Base de Cálculo do PIS. |
itensContrato[].itemImpostos.retCOFINS | texto · até 1 | Retém COFINS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retCSLL | texto · até 1 | Retém CSLL (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retINSS | texto · até 1 | Retém INSS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retIR | texto · até 1 | Retém IR (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retISS | texto · até 1 | Retém ISS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.retPIS | texto · até 1 | Retém PIS (S/N). Indica se o imposto deve ser retido ou não. |
itensContrato[].itemImpostos.valorCOFINSobrigatório | número | Alíquota de COFINS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de "S". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente. |
itensContrato[].itemImpostos.valorCSLL | número | Valor de CSLL. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemImpostos.valorCbs | número | Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.valorINSS | número | Valor de INSS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemImpostos.valorIR | número | Valor do IR. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemImpostos.valorISS | número | Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
itensContrato[].itemImpostos.valorIbsMun | número | Valor do IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.valorIbsUf | número | Valor do IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie. |
itensContrato[].itemImpostos.valorPIS | número | Valor do PIS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de "S". Caso a tag [cUtilizarValorImposto] seja preenchida com "S", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada. |
itensContrato[].itemLeiTranspImp | objeto | |
itensContrato[].itemLeiTranspImp.aliMunicipal | número | Alíquota Carga Trib. Aprox. Municipal |
itensContrato[].itemLeiTranspImp.aliqEstadual | número | Alíquota Carga Trib. Aprox. Estadual |
itensContrato[].itemLeiTranspImp.aliqFederal | número | Alíquota da Carga Tributária Aprox. Federal |
itensContrato[].itemLeiTranspImp.chave | texto · até 6 | Chave do IBPT |
itensContrato[].itemLeiTranspImp.fonte | texto · até 34 | Fonte do IBPT |
itensContrato[].itemOutrasInf | objeto | Outras informações do item do contrato de serviços |
itensContrato[].itemOutrasInf.dItVigFinal | texto · até 10 | Data da vigência final do item do contrato de serviços |
itensContrato[].itemOutrasInf.dItVigInicial | texto · até 10 | Data da vigência inicial do item do contrato de serviços |
itensContrato[].itemOutrasInf.nTipoItVigFinal | número inteiro | Tipo da vigência final do item do contrato de serviços. Valores possiveis: 1 - Data especifica 2 - Segue a vigência final do contrato 3 - Apenas para o proximo faturamento |
itensContrato[].itemViaUnica | objeto | Informações referente ao serviço da NF modelo 21 ou 22. |
itensContrato[].itemViaUnica.cCFOP | texto · até 10 | Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação. |
itensContrato[].itemViaUnica.cClassifServico | texto · até 4 | Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação. |
itensContrato[].itemViaUnica.cModeloNF | texto · até 2 | Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação |
itensContrato[].itemViaUnica.cTipoReceita | texto · até 1 | Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros |
itensContrato[].itemViaUnica.cTipoUtilizacao | texto · até 1 | Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação. |
observacoes | objeto | Observações do contrato |
observacoes.cObsContrato | texto | Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal). |
produtosUtilizados | objeto | Produtos Utilizados no contrato. |
produtosUtilizados.cAcaoProdUtilizados | texto · até 3 | Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. PED - Será gerado um pedido de venda. Obrigatório na inclusão. |
produtosUtilizados.cCodCategRem | texto · até 20 | Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'. |
produtosUtilizados.produtoUtilizado | lista de objetos | Produtos utilizados no serviço. |
produtosUtilizados.produtoUtilizado[].cAcaoItemPU | texto · até 1 | Pode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração. |
produtosUtilizados.produtoUtilizado[].codigo_local_estoque | número inteiro | Código do Local do Estoque. |
produtosUtilizados.produtoUtilizado[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
produtosUtilizados.produtoUtilizado[].lote_validade[].nIdLote | número inteiro | Id do lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.. |
produtosUtilizados.produtoUtilizado[].lote_validade[].nQtdLoteobrigatório | número | Informe aqui a quantidade do lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações. |
produtosUtilizados.produtoUtilizado[].nCodProdutoPU | número inteiro | Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie. |
produtosUtilizados.produtoUtilizado[].nIdItemPU | número inteiro | (Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie. |
produtosUtilizados.produtoUtilizado[].nQtdePU | número | Quantidade. |
vencTextos | objeto | |
vencTextos.cAdContrato | texto · até 1 | Adicionar o "Nº do Contrato" à descrição dos serviços na NFS-e |
vencTextos.cAdPeriodo | texto · até 1 | Adicionar o período de referência associado ao faturamento |
vencTextos.cAdVenc | texto · até 1 | Adicionar o vencimento da parcela à descrição dos serviços na NFS-e |
vencTextos.cAntecipar | texto · até 1 | Define se deve antecipar o vencimento ao considerar apenas dias úteis |
vencTextos.cCodPerRef | texto · até 3 | Período de Referência - Código do período de referência para o faturamento. Pode ser: 001 Mês do faturamento 002 Mês Anterior ao faturamento 003 Mês Posterior ao faturamento 004 Período Anterior ao faturamento 005 Período Posterior ao faturamento 006 Período Anterior específico 007 Número da Parcela 008 Período Posterior específico 009 Período Atual específico |
vencTextos.cDiaFim | texto · até 2 | Dia Final - Dia para a data final do período de referência associado ao faturamento |
vencTextos.cDiaIni | texto · até 2 | Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial |
vencTextos.cPostergar | texto · até 1 | Postergar Sábados, Domingos e Feriados Nacionais |
vencTextos.cProxMes | texto · até 1 | Define se o vencimento ocorrerá somente no mês seguinte. |
vencTextos.cTpVenc | texto · até 3 | Tipo de Vencimento. Pode ser: 001-Número de dias após faturar. 002-Fixar dia do mês (1 a 31). |
vencTextos.nDiaFixo | número inteiro | Dia de vencimento fixo para a gerar o contas a receber |
vencTextos.nDias | número inteiro | Número de Dias para a gerar o contas a receber |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntCtr | texto | Código de Integração do Contrato de Serviço |
cCodStatus | texto | Código do Status |
cDescStatus | texto | Descrição do Status |
nCodCtr | número inteiro | Código da Contrato de Serviço |
POST /api/v1/servicos/contrato/
curl -s https://app.omie.com.br/api/v1/servicos/contrato/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "UpsertContrato", "param": [{"cabecalho": {"cCodIntCtr": "019289Tb2", "cCodSit": "10", "cNumCtr": "2020/01001", "cTipoFat": "01", "dVigFinal": "30/03/2022", "dVigInicial": "29/03/2020", "nCodCli": 2370765, "nDiaFat": 30, "nValTotMes": 3302}, "departamentos": [], "emailCliente": {"cEnviarBoleto": "", "cEnviarLinkNfse": "", "cEnviarRecibo": "", "cUtilizarEmails": ""}, "infAdic": {"cCidPrestServ": "PETROPOLIS (RJ)", "cCodART": "", "cCodCateg": "1.01.02", "cCodObra": "", "cContato": "", "cDadosAdicNF": "", "nCodCC": 1208238, "nCodProj": 0, "nCodVend": 0}, "itensContrato": [{"itemCabecalho": {"codIntItem": "1", "cCodCategItem": "", "cNaoGerarFinanceiro": "N", "codLC116": "3.05", "codNBS": "", "codServMunic": "01292", "codServico": 0, "natOperacao": "01", "quant": 1, "seq": 1, "valorDed": 0, "valorTotal": 3002, "valorUnit": 3002}, "itemDescrServ": {"descrCompleta": "Serviços prestados"}, "itemImpostos": {"aliqCOFINS": 0, "aliqCSLL": 0, "aliqINSS": 0, "aliqIR": 0, "aliqISS": 5, "aliqPIS": 0, "redBaseINSS": 0, "retCOFINS": "", "retCSLL": "", "retINSS": "", "retIR": "", "retISS": "N", "retPIS": "", "valorCOFINS": 0, "valorCSLL": 0, "valorINSS": 0, "valorIR": 0, "valorISS": 150.1, "valorPIS": 0}, "itemLeiTranspImp": {"aliMunicipal": 0, "aliqEstadual": 0, "aliqFederal": 0, "chave": "", "fonte": ""}}, {"itemCabecalho": {"codIntItem": "2", "cCodCategItem": "", "cNaoGerarFinanceiro": "N", "codLC116": "17.01", "codNBS": "", "codServMunic": "0162-8/99", "codServico": 3412648, "natOperacao": "01", "quant": 1, "seq": 2, "valorDed": 0, "valorTotal": 300, "valorUnit": 300}, "itemDescrServ": {"descrCompleta": "Homologação de processo contábil"}, "itemImpostos": {"aliqCOFINS": 0, "aliqCSLL": 0, "aliqINSS": 0, "aliqIR": 0, "aliqISS": 3, "aliqPIS": 0, "redBaseINSS": 0, "retCOFINS": "", "retCSLL": "", "retINSS": "", "retIR": "", "retISS": "N", "retPIS": "", "valorCOFINS": 0, "valorCSLL": 0, "valorINSS": 0, "valorIR": 0, "valorISS": 9, "valorPIS": 0}, "itemLeiTranspImp": {"aliMunicipal": 0, "aliqEstadual": 0, "aliqFederal": 0, "chave": "", "fonte": ""}}], "observacoes": {"cObsContrato": ""}, "vencTextos": {"cAdContrato": "N", "cAdPeriodo": "N", "cAdVenc": " ", "cAntecipar": "", "cCodPerRef": "001", "cDiaFim": 0, "cDiaIni": 0, "cPostergar": "", "cProxMes": "", "cTpVenc": "001", "nDiaFixo": 0, "nDias": 5}}]}'import os
import requests
corpo = {'call': 'UpsertContrato',
'param': [{'cabecalho': {'cCodIntCtr': '019289Tb2',
'cCodSit': '10',
'cNumCtr': '2020/01001',
'cTipoFat': '01',
'dVigFinal': '30/03/2022',
'dVigInicial': '29/03/2020',
'nCodCli': 2370765,
'nDiaFat': 30,
'nValTotMes': 3302},
'departamentos': [],
'emailCliente': {'cEnviarBoleto': '',
'cEnviarLinkNfse': '',
'cEnviarRecibo': '',
'cUtilizarEmails': ''},
'infAdic': {'cCidPrestServ': 'PETROPOLIS (RJ)',
'cCodART': '',
'cCodCateg': '1.01.02',
'cCodObra': '',
'cContato': '',
'cDadosAdicNF': '',
'nCodCC': 1208238,
'nCodProj': 0,
'nCodVend': 0},
'itensContrato': [{'itemCabecalho': {'codIntItem': '1',
'cCodCategItem': '',
'cNaoGerarFinanceiro': 'N',
'codLC116': '3.05',
'codNBS': '',
'codServMunic': '01292',
'codServico': 0,
'natOperacao': '01',
'quant': 1,
'seq': 1,
'valorDed': 0,
'valorTotal': 3002,
'valorUnit': 3002},
'itemDescrServ': {'descrCompleta': 'Serviços prestados'},
'itemImpostos': {'aliqCOFINS': 0,
'aliqCSLL': 0,
'aliqINSS': 0,
'aliqIR': 0,
'aliqISS': 5,
'aliqPIS': 0,
'redBaseINSS': 0,
'retCOFINS': '',
'retCSLL': '',
'retINSS': '',
'retIR': '',
'retISS': 'N',
'retPIS': '',
'valorCOFINS': 0,
'valorCSLL': 0,
'valorINSS': 0,
'valorIR': 0,
'valorISS': 150.1,
'valorPIS': 0},
'itemLeiTranspImp': {'aliMunicipal': 0,
'aliqEstadual': 0,
'aliqFederal': 0,
'chave': '',
'fonte': ''}},
{'itemCabecalho': {'codIntItem': '2',
'cCodCategItem': '',
'cNaoGerarFinanceiro': 'N',
'codLC116': '17.01',
'codNBS': '',
'codServMunic': '0162-8/99',
'codServico': 3412648,
'natOperacao': '01',
'quant': 1,
'seq': 2,
'valorDed': 0,
'valorTotal': 300,
'valorUnit': 300},
'itemDescrServ': {'descrCompleta': 'Homologação de '
'processo contábil'},
'itemImpostos': {'aliqCOFINS': 0,
'aliqCSLL': 0,
'aliqINSS': 0,
'aliqIR': 0,
'aliqISS': 3,
'aliqPIS': 0,
'redBaseINSS': 0,
'retCOFINS': '',
'retCSLL': '',
'retINSS': '',
'retIR': '',
'retISS': 'N',
'retPIS': '',
'valorCOFINS': 0,
'valorCSLL': 0,
'valorINSS': 0,
'valorIR': 0,
'valorISS': 9,
'valorPIS': 0},
'itemLeiTranspImp': {'aliMunicipal': 0,
'aliqEstadual': 0,
'aliqFederal': 0,
'chave': '',
'fonte': ''}}],
'observacoes': {'cObsContrato': ''},
'vencTextos': {'cAdContrato': 'N',
'cAdPeriodo': 'N',
'cAdVenc': ' ',
'cAntecipar': '',
'cCodPerRef': '001',
'cDiaFim': 0,
'cDiaIni': 0,
'cPostergar': '',
'cProxMes': '',
'cTpVenc': '001',
'nDiaFixo': 0,
'nDias': 5}}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/contrato/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/contrato/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "UpsertContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/contrato/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "UpsertContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/contrato/")
corpo = <<~'JSON'
{
"call": "UpsertContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "UpsertContrato",
"param": [
{
"cabecalho": {
"cCodIntCtr": "019289Tb2",
"cCodSit": "10",
"cNumCtr": "2020/01001",
"cTipoFat": "01",
"dVigFinal": "30/03/2022",
"dVigInicial": "29/03/2020",
"nCodCli": 2370765,
"nDiaFat": 30,
"nValTotMes": 3302
},
"departamentos": [],
"emailCliente": {
"cEnviarBoleto": "",
"cEnviarLinkNfse": "",
"cEnviarRecibo": "",
"cUtilizarEmails": ""
},
"infAdic": {
"cCidPrestServ": "PETROPOLIS (RJ)",
"cCodART": "",
"cCodCateg": "1.01.02",
"cCodObra": "",
"cContato": "",
"cDadosAdicNF": "",
"nCodCC": 1208238,
"nCodProj": 0,
"nCodVend": 0
},
"itensContrato": [
{
"itemCabecalho": {
"codIntItem": "1",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "3.05",
"codNBS": "",
"codServMunic": "01292",
"codServico": 0,
"natOperacao": "01",
"quant": 1,
"seq": 1,
"valorDed": 0,
"valorTotal": 3002,
"valorUnit": 3002
},
"itemDescrServ": {
"descrCompleta": "Serviços prestados"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 5,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 150.1,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
},
{
"itemCabecalho": {
"codIntItem": "2",
"cCodCategItem": "",
"cNaoGerarFinanceiro": "N",
"codLC116": "17.01",
"codNBS": "",
"codServMunic": "0162-8/99",
"codServico": 3412648,
"natOperacao": "01",
"quant": 1,
"seq": 2,
"valorDed": 0,
"valorTotal": 300,
"valorUnit": 300
},
"itemDescrServ": {
"descrCompleta": "Homologação de processo contábil"
},
"itemImpostos": {
"aliqCOFINS": 0,
"aliqCSLL": 0,
"aliqINSS": 0,
"aliqIR": 0,
"aliqISS": 3,
"aliqPIS": 0,
"redBaseINSS": 0,
"retCOFINS": "",
"retCSLL": "",
"retINSS": "",
"retIR": "",
"retISS": "N",
"retPIS": "",
"valorCOFINS": 0,
"valorCSLL": 0,
"valorINSS": 0,
"valorIR": 0,
"valorISS": 9,
"valorPIS": 0
},
"itemLeiTranspImp": {
"aliMunicipal": 0,
"aliqEstadual": 0,
"aliqFederal": 0,
"chave": "",
"fonte": ""
}
}
],
"observacoes": {
"cObsContrato": ""
},
"vencTextos": {
"cAdContrato": "N",
"cAdPeriodo": "N",
"cAdVenc": " ",
"cAntecipar": "",
"cCodPerRef": "001",
"cDiaFim": 0,
"cDiaIni": 0,
"cPostergar": "",
"cProxMes": "",
"cTpVenc": "001",
"nDiaFixo": 0,
"nDias": 5
}
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/contrato/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/contrato/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""UpsertContrato"", ""param"": [{""cabecalho"": {""cCodIntCtr"": ""019289Tb2"", ""cCodSit"": ""10"", ""cNumCtr"": ""2020/01001"", ""cTipoFat"": ""01"", ""dVigFinal"": ""30/03/2022"", ""dVigInicial"": ""29/03/2020"", ""nCodCli"": 2370765, ""nDiaFat"": 30, ""nValTotMes"": 3302}, ""departamentos"": [], ""emailCliente"": {""cEnviarBoleto"": """", ""cEnviarLinkNfse"": """", ""cEnviarRecibo"": """", ""cUtilizarEmails"": """"}, ""infAdic"": {""cCidPrestServ"": ""PETROPOLIS (RJ)"", ""cCodART"": """", ""cCodCateg"": ""1.01.02"", ""cCodObra"": """", ""cContato"": """", ""cDadosAdicNF"": """", ""nCodCC"": 1208238, ""nCodProj"": 0, ""nCodVend"": 0}, ""itensContrato"": [{""itemCabecalho"": {""codIntItem"": ""1"", ""cCodCategItem"": """", ""cNaoGerarFinanceiro"": ""N"", ""codLC116"": ""3.05"", ""codNBS"": """", ""codServMunic"": ""01292"", ""codServico"": 0, ""natOperacao"": ""01"", ""quant"": 1, ""seq"": 1, ""valorDed"": 0, ""valorTotal"": 3002, ""valorUnit"": 3002}, ""itemDescrServ"": {""descrCompleta"": ""Serviços prestados""}, ""itemImpostos"": {""aliqCOFINS"": 0, ""aliqCSLL"": 0, ""aliqINSS"": 0, ""aliqIR"": 0, ""aliqISS"": 5, ""aliqPIS"": 0, ""redBaseINSS"": 0, ""retCOFINS"": """", ""retCSLL"": """", ""retINSS"": """", ""retIR"": """", ""retISS"": ""N"", ""retPIS"": """", ""valorCOFINS"": 0, ""valorCSLL"": 0, ""valorINSS"": 0, ""valorIR"": 0, ""valorISS"": 150.1, ""valorPIS"": 0}, ""itemLeiTranspImp"": {""aliMunicipal"": 0, ""aliqEstadual"": 0, ""aliqFederal"": 0, ""chave"": """", ""fonte"": """"}}, {""itemCabecalho"": {""codIntItem"": ""2"", ""cCodCategItem"": """", ""cNaoGerarFinanceiro"": ""N"", ""codLC116"": ""17.01"", ""codNBS"": """", ""codServMunic"": ""0162-8/99"", ""codServico"": 3412648, ""natOperacao"": ""01"", ""quant"": 1, ""seq"": 2, ""valorDed"": 0, ""valorTotal"": 300, ""valorUnit"": 300}, ""itemDescrServ"": {""descrCompleta"": ""Homologação de processo contábil""}, ""itemImpostos"": {""aliqCOFINS"": 0, ""aliqCSLL"": 0, ""aliqINSS"": 0, ""aliqIR"": 0, ""aliqISS"": 3, ""aliqPIS"": 0, ""redBaseINSS"": 0, ""retCOFINS"": """", ""retCSLL"": """", ""retINSS"": """", ""retIR"": """", ""retISS"": ""N"", ""retPIS"": """", ""valorCOFINS"": 0, ""valorCSLL"": 0, ""valorINSS"": 0, ""valorIR"": 0, ""valorISS"": 9, ""valorPIS"": 0}, ""itemLeiTranspImp"": {""aliMunicipal"": 0, ""aliqEstadual"": 0, ""aliqFederal"": 0, ""chave"": """", ""fonte"": """"}}], ""observacoes"": {""cObsContrato"": """"}, ""vencTextos"": {""cAdContrato"": ""N"", ""cAdPeriodo"": ""N"", ""cAdVenc"": "" "", ""cAntecipar"": """", ""cCodPerRef"": ""001"", ""cDiaFim"": 0, ""cDiaIni"": 0, ""cPostergar"": """", ""cProxMes"": """", ""cTpVenc"": ""001"", ""nDiaFixo"": 0, ""nDias"": 5}}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados