Serviços ·
OrdemServicoGeração de Ordem de Serviço
3consultas
4alterações
Claude 7 de 7 · ChatGPT 4 de 7 · MCP 7 de 7pelos assistentes de IA
JSON · XMLformato
Operação para alterar uma Ordem de Serviço.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 12Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
Cabecalho | objeto | Cabeçalho da Ordem de Serviço |
Cabecalho.cCodIntCli | texto · até 60 | Código de Integração do Cliente |
Cabecalho.cCodIntOS | texto · até 60 | Código de Integração da OS. Obrigatório na inclusão. |
Cabecalho.cCodParc | texto · até 3 | Código da parcela/Condição de pagamento. Utilize a tag "nCodigo" do método "ListarFormasPagVendas" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código "999" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag "qtde_parcelas" e a estrutura "lista_parcelas". Alguns dos valores disponíveis são: "000" - A Vista "A03" - Para 3 dias "A05" - Para 5 dias "A07" - Para 7 dias "A08" - Para 8 dias "A09" - Para 9 dias "A10" - Para 10 dias "A13" - Para 13 dias "A14" - Para 14 dias "A15" - Para 15 dias "A17" - Para 17 dias "A20" - Para 20 dias "A21" - Para 21 dias "A25" - Para 25 dias "A26" - Para 26 dias "A28" - Para 28 dias "A35" - Para 35 dias "A36" - Para 36 dias "A40" - Para 40 dias "A42" - Para 42 dias "A45" - Para 45 dias "A50" - Para 50 dias "A56" - Para 56 dias "A60" - Para 60 dias "A70" - Para 70 dias "A75" - Para 75 dias "A90" - Para 90 dias "A98" - Para 98 dias "B20" - Para 120 dias "001" - 1 Parcela (para 30 dias) "002" - 2 Parcelas "003" - 3 Parcelas "004" - 4 Parcelas "005" - 5 Parcelas "006" - 6 Parcelas "007" - 7 Parcelas "010" - 10 Parcelas "012" - 12 Parcelas "024" - 24 Parcelas "036" - 36 Parcelas "048" - 48 Parcelas "S01" - 30/60 "S02" - 45/60 "S03" - 21/28/35 "S04" - 21/28/35/42 "S05" - 28/35/42 "S06" - 28/35/42/49 "S07" - 30/45/60/75/90 "S08" - 25/56 "S09" - 30/45 "S10" - 28/56 "S11" - 10/30/60 "S12" - 15/30/60 "S13" - 28/35 "S14" - 7/14/21 "S15" - 10/30/60/90 "S16" - 60/90/120 "S17" - 45/60/90 "S18" - 30/60/90 "S19" - 14/21 "S20" - 7/14 "S21" - 14/21/28 "S22" - 45/75 "S23" - 30/45/60 "S24" - 3/20/40 "S25" - 30/60/90/120 "S26" - 21/28 "S27" - a Vista/15 "S28" - a Vista/30 "S29" - a Vista/30/60 "S30" - a Vista/30/60/90 "S31" - a Vista/30/60/90/120/150 "S41" - 28/42/56 "S32" - 15/45/75 "S33" - 14/28/42 "S34" - 14/21/28/35/42 "S35" - 30/42/54/66/78/90 "S36" - 14/21/28/35 "S37" - 28/42 "S38" - 30/45/60 "S39" - 35/42/49/56 "S40" - 28/42/56/70 "S42" - 30/40/50/60 "S43" - 30/50/70/90 "S44" - 14/28 "S45" - 45/60/75/90 "S46" - a Vista/30/60/90/120 "S47" - a vista/20/40/60 "S48" - 21/42 "S49" - 15/30/45 "S50" - 14/42 "S51" - 21/35 "S52" - 28/56/84 "S53" - 28/42/56/70/84 "S54" - a Vista/30/45 "S55" - 21/45 "S56" - a Vista/28 "S57" - a Vista/60/90 "S58" - 35/45/55 "S59" - 28/35/42/56 "S60" - 30/45/60/75 "S61" - 28/35/42/49/56 "S62" - 40/70/100 "S63" - 42/56 "S64" - a Vista/28/35 "S65" - 35/42 "S66" - 20/40 "S67" - a Vista/28/35/42 |
Cabecalho.cDescParc | texto · até 30 | Descrição da parcela. Utilizado apenas para retorno do método "ConsultarOS". |
Cabecalho.cEtapa | texto · até 2 | Código da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar |
Cabecalho.cNumOS | texto · até 15 | Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente) |
Cabecalho.dDtPrevisao | texto · até 10 | Data de Previsão |
Cabecalho.nCodCli | número inteiro | Código do Cliente |
Cabecalho.nCodCtr | número inteiro | Código do Contrato. Ao informar esse campo será incluído ao contrato uma Ordem de Serviço adicional. Utilizado somente na Inclusão/Alteração. Utilize a tag "nCodCtr" do método "ListarContrato" da API /api/v1/servicos/contrato/ para obter essa informação |
Cabecalho.nCodOS | número inteiro | Código da Ordem de Serviço |
Cabecalho.nCodVend | número inteiro | Código do Vendedor |
Cabecalho.nQtdeParc | número inteiro | Quantidade de Parcelas |
Cabecalho.nValorTotal | número | Valor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente. |
Cabecalho.nValorTotalImpRet | número | Valor Total de Impostos Retidos |
Caracteristicas | lista de objetos | Características da Ordem de Serviço. |
Caracteristicas[].cConteudo | texto · até 7000 | Conteúdo da Característica. |
Caracteristicas[].cNome | texto · até 70 | Nome da característica. |
Caracteristicas[].nIdCampo | número inteiro | Id do campo característica. |
Caracteristicas[].nIdCaracteristica | número inteiro | ID da Característica. |
Departamentos | lista de objetos | Dados da Aba "Departamentos" do Pedido de Venda. |
Departamentos[].cCodDepto | texto · até 40 | ID do Departamento. Informação localizada na Aba "Departamentos" do Pedido de Venda. Utilize a tag "codigo" do método "ListarDepatartamentos" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação. |
Departamentos[].nPerc | número | Percentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
Departamentos[].nValor | número | Valor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
Departamentos[].nValorFixo | texto · até 1 | Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda. |
Email | objeto | |
Email.cEnvBoleto | texto · até 1 | Enviar ao cliente e-mail com os Boletos de Cobrança gerados pelo faturamento. É permitido somente o preenchimento de uma das tags "cEnvPix" ou "cEnvBoleto". |
Email.cEnvLink | texto · até 1 | Enviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida. |
Email.cEnvPix | texto · até 1 | Enviar ao cliente e-mail com o PIX de Cobrança gerado pelo faturamento. É permitido somente o preenchimento de uma das tags "cEnvPix" ou "cEnvBoleto". |
Email.cEnvRecibo | texto · até 1 | Enviar um recibo de prestação de serviços (ao invés da NFS-e) |
Email.cEnvViaUnica | texto · até 1 | Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não |
Email.cEnviarPara | texto | Utilizar os seguintes endereços de e-mail |
InfoCadastro | objeto | Informações do cadastro da Ordem de Serviço. |
InfoCadastro.cAmbiente | texto · até 1 | Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção |
InfoCadastro.cCancelada | texto · até 1 | Ordem de Serviço cancelada?Ex.: S, N |
InfoCadastro.cFaturada | texto · até 1 | Ordem de Serviço faturada com sucesso?Ex.: S, N |
InfoCadastro.cHrAlt | texto · até 8 | Hora de Alteração da Ordem de Serviço |
InfoCadastro.cHrCanc | texto · até 8 | Hora do Cancelamento |
InfoCadastro.cHrFat | texto · até 8 | Hora do Faturamento |
InfoCadastro.cHrInc | texto · até 8 | Hora de inclusão da Ordem de Serviço |
InfoCadastro.cOrigem | texto · até 3 | Origem da Ordem de Serviço |
InfoCadastro.dDtAlt | texto · até 10 | Data de Alteração da Ordem de Serviço |
InfoCadastro.dDtCanc | texto · até 10 | Data de Cancelamento |
InfoCadastro.dDtFat | texto · até 10 | Data de Faturamento |
InfoCadastro.dDtInc | texto · até 10 | Data de Inclusão da Ordem de Serviç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. |
InformacoesAdicionais | objeto | |
InformacoesAdicionais.DetalhesNfse | objeto | Detalhes da NFSE. |
InformacoesAdicionais.DetalhesNfse.Eventos | objeto | Evento na Nfse. |
InformacoesAdicionais.DetalhesNfse.Eventos.cBairroEvento | texto · até 60 | Bairro do Evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCepEvento | texto · até 10 | CEP do Evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeEvento | texto · até 40 | Código da Cidade da Prestação de Serviços. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeExtEvento | texto · até 60 | Cidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como "S". |
InformacoesAdicionais.DetalhesNfse.Eventos.cCodAtivEvento | texto · até 30 | Código de Atividade do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCodPaisEvento | texto · até 4 | Código do país do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cComplEvento | texto · até 40 | Completo do endereço do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cEndEvento | texto · até 60 | Endereço do envento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cEndExtEvento | texto · até 255 | Endereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como "S". |
InformacoesAdicionais.DetalhesNfse.Eventos.cExtEvento | texto · até 1 | Evento no Exterior S/N. |
InformacoesAdicionais.DetalhesNfse.Eventos.cNomeEvento | texto · até 60 | Nome do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cNumEndEvento | texto · até 10 | Número do endereço do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cUfEvento | texto · até 2 | Estado do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.dDtFimEvento | texto | Data Final do Evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.dDtIniEvento | texto | Data de Início do Evento. |
InformacoesAdicionais.cCidPrestServ | texto · até 40 | Cidade da Prestação do Serviço |
InformacoesAdicionais.cCodART | texto · até 20 | Código ART |
InformacoesAdicionais.cCodCateg | texto · até 20 | Categoria |
InformacoesAdicionais.cCodObra | texto · até 15 | Código da Obra |
InformacoesAdicionais.cContato | texto · até 100 | Contato |
InformacoesAdicionais.cDadosAdicNF | texto | Dados Adicionais da Nota Fiscal |
InformacoesAdicionais.cNumContrato | texto · até 20 | Número do Contrato de Venda |
InformacoesAdicionais.cNumPedido | texto · até 30 | Número do Pedido do Cliente |
InformacoesAdicionais.cNumRecibo | texto · até 10 | Número do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado). |
InformacoesAdicionais.cUsoConsumo | texto · até 1 | Uso e consumo pessoal. |
InformacoesAdicionais.dDataRps | texto · até 10 | Data da RPS |
InformacoesAdicionais.nCodCC | número inteiro | Código da Conta Corrente |
InformacoesAdicionais.nCodProj | número inteiro | Código do Projeto |
InformacoesAdicionais.nIdDestinatario | número inteiro | ID Cliente para o Destinatário. |
Observacoes | objeto | |
Observacoes.cObsOS | texto | Observações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal). |
Parcelas | lista de objetos | Permite que o parcelamento seja realizado de forma manual. |
Parcelas[].categoria_adiantamento | texto · até 20 | Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].conta_corrente_adiantamento | número inteiro | Conta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].dDtVenc | texto · até 10 | Data de Vencimento da parcela. Ex: 01/02/2016 |
Parcelas[].meio_pagamento | texto · até 100 | Meio de Pagamento - Utilizado apenas para emissão de NFS-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" da Ordem de Serviço. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
Parcelas[].nDiasobrigatório | número inteiro | Número de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias. |
Parcelas[].nParcelaobrigatório | número inteiro | Número da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2. |
Parcelas[].nPercentual | número | Percentual do valor da parcela. |
Parcelas[].nValor | número | Valor da Parcela. Ex: 100.23 |
Parcelas[].nao_gerar_boleto | texto · até 1 | Não gerar boleto para esta parcela ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].nsu | texto · até 100 | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. |
Parcelas[].parcela_adiantamento | texto · até 1 | Está é uma parcela de Adiantamento do Cliente. Informe "S" para indicar que é uma parcela de adiantamento. O padrão é "N". Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].tipo_documento | texto · até 5 | Tipo de Documento. Informação localizada na Aba "Parcelas" da Ordem de Serviço. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa disponível na API: /api/v1/ger |
ServicosPrestados | lista de objetos | Item da Ordem serviço |
ServicosPrestados[].DeducoesIss | lista de objetos | Informe aqui as Deduções para o ISS. |
ServicosPrestados[].DeducoesIss[].cCnpjFornecedor | texto · até 20 | CPF ou CNPJ do Fornecedor |
ServicosPrestados[].DeducoesIss[].cDescMateriais | texto · até 100 | Descrição do material. |
ServicosPrestados[].DeducoesIss[].cFormaDeducao | texto · até 1 | Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor. |
ServicosPrestados[].DeducoesIss[].cNFReferencia | texto · até 20 | Nota Fiscal de Referência. |
ServicosPrestados[].DeducoesIss[].cTipoDeduducao | texto · até 1 | Tipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada |
ServicosPrestados[].DeducoesIss[].nPercDeducao | número | Percentual de dedução. |
ServicosPrestados[].DeducoesIss[].nQuantMateriais | número | Quantidade de Material |
ServicosPrestados[].DeducoesIss[].nValorDeducao | número | Valor da Dedução. |
ServicosPrestados[].DeducoesIss[].nValorTotNfRef | número | Valor total NF de Referência |
ServicosPrestados[].cAcaoItem | texto · até 1 | Ação a ser realizada na alteração do item. Pode ser: "A" - Alterar o item (padrão). "E" - Excluir o item. "I" - Incluir o item na alteração. |
ServicosPrestados[].cCodCategItem | texto · até 20 | Código da Categoria. |
ServicosPrestados[].cCodIntServico | texto · até 60 | Código de Integração 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. |
ServicosPrestados[].cCodServLC116 | texto · até 20 | Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag "nCodServico" 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. |
ServicosPrestados[].cCodServMun | texto · até 20 | Código do Serviço Municipal ou CNAE. Caso tenha informado a tag "nCodServico" 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. |
ServicosPrestados[].cCodigo | texto · até 20 | Código do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. |
ServicosPrestados[].cDadosAdicItem | texto | Dados adicionais do Item. |
ServicosPrestados[].cDescServ | texto | Descrição dos Serviços. Caso tenha informado a tag "nCodServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
ServicosPrestados[].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. |
ServicosPrestados[].cNbs | texto · até 9 | Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag "nCodServico" irá assumir o valor informado no cadastro do respectivo serviço. |
ServicosPrestados[].cReembolso | texto · até 1 | Identificação se o item é despesa reembolsável. |
ServicosPrestados[].cRetemISS | texto · até 1 | Retem ISS (S/N) |
ServicosPrestados[].cTpDesconto | texto · até 1 | Tipo de Desconto. Pode ser: P - Percentual V - Valor |
ServicosPrestados[].cTribServ | texto · até 2 | Tipo de Tributação dos Serviços. Caso tenha informado a tag "nCodServico" 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. |
ServicosPrestados[].impostos | objeto | Dados do impostos do serviço. |
ServicosPrestados[].impostos.cCST | 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. |
ServicosPrestados[].impostos.cClassTrib | 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. |
ServicosPrestados[].impostos.cFixarCOFINS | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarCSLL | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarINSS | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarIRRF | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarISS | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarPIS | texto · até 1 | 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. |
ServicosPrestados[].impostos.cIndOPer | 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. |
ServicosPrestados[].impostos.cManCbs | 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. |
ServicosPrestados[].impostos.cManIbsMun | 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. |
ServicosPrestados[].impostos.cManIbsUf | 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. |
ServicosPrestados[].impostos.cRetemCOFINS | texto · até 1 | Retém COFINS (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemCSLL | texto · até 1 | Retém CSLL (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemINSS | texto · até 1 | Retém INSS (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemIRRF | texto · até 1 | Retém IRRF (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemPIS | texto · até 1 | Retém PIS (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.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. |
ServicosPrestados[].impostos.lDeduzISS | sim/não | Deduz o ISS da Base de Cálculo de PIS e COFINS |
ServicosPrestados[].impostos.nAliqCOFINSobrigató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. |
ServicosPrestados[].impostos.nAliqCSLLobrigató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. |
ServicosPrestados[].impostos.nAliqCbs | 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. |
ServicosPrestados[].impostos.nAliqEstadualIBPT | número | Alíquota da Carga Tribut. Aproximada Estadual. |
ServicosPrestados[].impostos.nAliqFederalIBPT | número | Alíquota da Carga Tribut. Aproximada Federal. |
ServicosPrestados[].impostos.nAliqINSSobrigató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. |
ServicosPrestados[].impostos.nAliqIRRFobrigatório | número | Alíquota de IRRF. 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. |
ServicosPrestados[].impostos.nAliqISS | número | Alíquota de ISS. |
ServicosPrestados[].impostos.nAliqIbsMun | número | 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. |
ServicosPrestados[].impostos.nAliqIbsUf | 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. |
ServicosPrestados[].impostos.nAliqMunicipalIBPT | número | Alíquota da Carga Tribut. Aproximada Municipal. |
ServicosPrestados[].impostos.nAliqPISobrigató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. |
ServicosPrestados[].impostos.nAliqRedBaseCOFINS | número | Percentual de Redução da Base de Cálculo do COFINS. |
ServicosPrestados[].impostos.nAliqRedBaseINSS | número | Percentual de Redução da Base de Cálculo do INSS. |
ServicosPrestados[].impostos.nAliqRedBasePIS | número | Percentual de Redução da Base de Cálculo do PIS. |
ServicosPrestados[].impostos.nBaseCalcIbsCbs | número | Valor da Base de Calculo do IBS e 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. |
ServicosPrestados[].impostos.nBaseISS | número | Base de Cálculo do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
ServicosPrestados[].impostos.nPercReducaoCbs | 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. |
ServicosPrestados[].impostos.nPercReducaoIbsMun | 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. |
ServicosPrestados[].impostos.nPercReducaoIbsUf | 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. |
ServicosPrestados[].impostos.nTotDeducao | número | Valor de Dedução da Base de Cálculo. Por padrão, esse campo afeta a Base de Cálculo do ISS. Para atender a condições legais acordadas para cada munícipio pode afetar as Bases de Cálculos dos Impostos Federais também. Consulte a legislação do seu município. |
ServicosPrestados[].impostos.nValorCOFINS | número | Valor do COFINS. 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. |
ServicosPrestados[].impostos.nValorCSLL | 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. |
ServicosPrestados[].impostos.nValorCbs | 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. |
ServicosPrestados[].impostos.nValorDeducao | número | Valor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem. |
ServicosPrestados[].impostos.nValorDeducaoIRRF | número | Valor da dedução da base do IR. |
ServicosPrestados[].impostos.nValorINSS | 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. |
ServicosPrestados[].impostos.nValorIRRF | número | Valor do IRRF. 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. |
ServicosPrestados[].impostos.nValorISS | número | Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
ServicosPrestados[].impostos.nValorIbsMun | 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. |
ServicosPrestados[].impostos.nValorIbsUf | 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. |
ServicosPrestados[].impostos.nValorPIS | 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. |
ServicosPrestados[].nAliqDesconto | número | Aliquota do Desconto. |
ServicosPrestados[].nCodServico | 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. |
ServicosPrestados[].nIdItem | número inteiro | ID do Item da Ordem de Serviço. Não deve ser informado na inclusão. Pode ser informado na alteração para identificar o item. |
ServicosPrestados[].nQtde | número | Quantidade de serviços. |
ServicosPrestados[].nSeqItem | número inteiro | Sequencia do Item Deve ser preenchido com uma sequencia de 1 a 199. |
ServicosPrestados[].nValUnit | número | Valor Unitário do serviço. Caso tenha informado a tag "nCodServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
ServicosPrestados[].nValorAcrescimos | número | Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.) |
ServicosPrestados[].nValorDesconto | número | Valor do Desconto. |
ServicosPrestados[].nValorOutrasRetencoes | número | Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.) |
ServicosPrestados[].viaUnica | objeto | Informações referente ao serviço de NF modelo 21 ou 22. |
ServicosPrestados[].viaUnica.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. |
ServicosPrestados[].viaUnica.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. |
ServicosPrestados[].viaUnica.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 |
ServicosPrestados[].viaUnica.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 |
ServicosPrestados[].viaUnica.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. |
Tarefas | lista de objetos | Lista com as tarefas relacionadas a ordem de serviço. Retornado apenas no método de consulta e quando preenchida a tag "cIncluirTarefas" como "S". |
Tarefas[].cCodIntTarefa | texto · até 20 | |
Tarefas[].cDescricao | texto · até 10 | Descrição da tarefa. |
Tarefas[].cNomeUserAtb | texto · até 800 | |
Tarefas[].dData | texto | |
Tarefas[].hHora | texto · até 5 | |
Tarefas[].nCodDoc | número inteiro | Id do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for "pedido-compra", esse campo reflete o código do pedido de compra. Se a origem da tarefa for "contas-receber", esse campo reflete o código da conta a receber. |
Tarefas[].nCodTarefa | número inteiro | Código único da tarefa. |
Tarefas[].nCodUserAtb | número inteiro | Código do usuário atribuído. |
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 | Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração. |
despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto · até 200 | Descrição da despesa. |
despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto · até 10 | Data da despesa. |
despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso. (Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão). Esse código não aparece na tela do Omie. Utilize esse código para identificar a despesa via API. |
despesasReembolsaveis.despesaReembolsavel[].nValorReemb | número | Valor da despesa. |
produtosUtilizados | objeto | Produtos Utilizados na Ordem de Serviço. |
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. 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 | rodutos 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. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntOS | texto | Código de Integração da Ordem de Serviço |
cCodStatus | texto | Código do Status |
cDescStatus | texto | Descrição do Status |
cNumOS | texto | Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente) |
nCodOS | número inteiro | Código da Ordem de Serviço |
POST /api/v1/servicos/os/
curl -s https://app.omie.com.br/api/v1/servicos/os/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "AlterarOS", "param": [{"Cabecalho": {"nCodOS": "1790776458", "cCodParc": "999", "cEtapa": "20", "dDtPrevisao": "30/09/2026", "nCodCli": 2485994, "nQtdeParc": 7}, "Departamentos": [], "Email": {"cEnvBoleto": "N", "cEnvLink": "N", "cEnviarPara": "teste@omie.com.br"}, "InformacoesAdicionais": {"cCidPrestServ": "SAO PAULO (SP)", "cCodCateg": "1.01.02", "cDadosAdicNF": "OS incluida via API de teste 72628", "nCodCC": 11850365}, "ServicosPrestados": [{"cCodServLC116": "7.07", "cCodServMun": "01015", "cDadosAdicItem": "Serviços prestados", "cDescServ": "Serviço prestado 001", "cRetemISS": "N", "cTribServ": "01", "impostos": {"cRetemIRRF": "S", "cRetemPIS": "S", "nAliqCOFINS": 0, "nAliqCSLL": 0, "nAliqIRRF": 15, "nAliqISS": 3, "nAliqPIS": 4.5}, "nQtde": 3, "nValUnit": 1000}, {"impostos": {"cRetemIRRF": "S", "cRetemPIS": "S", "nAliqIRRF": 15, "nAliqISS": 3, "nAliqPIS": 4.5}, "nCodServico": 2342423, "nQtde": 12, "nValUnit": 35}]}]}'import os
import requests
corpo = {'call': 'AlterarOS',
'param': [{'Cabecalho': {'nCodOS': '1790776458',
'cCodParc': '999',
'cEtapa': '20',
'dDtPrevisao': '30/09/2026',
'nCodCli': 2485994,
'nQtdeParc': 7},
'Departamentos': [],
'Email': {'cEnvBoleto': 'N',
'cEnvLink': 'N',
'cEnviarPara': 'teste@omie.com.br'},
'InformacoesAdicionais': {'cCidPrestServ': 'SAO PAULO (SP)',
'cCodCateg': '1.01.02',
'cDadosAdicNF': 'OS incluida via API de teste '
'72628',
'nCodCC': 11850365},
'ServicosPrestados': [{'cCodServLC116': '7.07',
'cCodServMun': '01015',
'cDadosAdicItem': 'Serviços prestados',
'cDescServ': 'Serviço prestado 001',
'cRetemISS': 'N',
'cTribServ': '01',
'impostos': {'cRetemIRRF': 'S',
'cRetemPIS': 'S',
'nAliqCOFINS': 0,
'nAliqCSLL': 0,
'nAliqIRRF': 15,
'nAliqISS': 3,
'nAliqPIS': 4.5},
'nQtde': 3,
'nValUnit': 1000},
{'impostos': {'cRetemIRRF': 'S',
'cRetemPIS': 'S',
'nAliqIRRF': 15,
'nAliqISS': 3,
'nAliqPIS': 4.5},
'nCodServico': 2342423,
'nQtde': 12,
'nValUnit': 35}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/os/",
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/os/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "AlterarOS",
"param": [
{
"Cabecalho": {
"nCodOS": "1790776458",
"cCodParc": "999",
"cEtapa": "20",
"dDtPrevisao": "30/09/2026",
"nCodCli": 2485994,
"nQtdeParc": 7
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "teste@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API de teste 72628",
"nCodCC": 11850365
},
"ServicosPrestados": [
{
"cCodServLC116": "7.07",
"cCodServMun": "01015",
"cDadosAdicItem": "Serviços prestados",
"cDescServ": "Serviço prestado 001",
"cRetemISS": "N",
"cTribServ": "01",
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqCOFINS": 0,
"nAliqCSLL": 0,
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nQtde": 3,
"nValUnit": 1000
},
{
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nCodServico": 2342423,
"nQtde": 12,
"nValUnit": 35
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/os/");
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": "AlterarOS",
"param": [
{
"Cabecalho": {
"nCodOS": "1790776458",
"cCodParc": "999",
"cEtapa": "20",
"dDtPrevisao": "30/09/2026",
"nCodCli": 2485994,
"nQtdeParc": 7
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "teste@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API de teste 72628",
"nCodCC": 11850365
},
"ServicosPrestados": [
{
"cCodServLC116": "7.07",
"cCodServMun": "01015",
"cDadosAdicItem": "Serviços prestados",
"cDescServ": "Serviço prestado 001",
"cRetemISS": "N",
"cTribServ": "01",
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqCOFINS": 0,
"nAliqCSLL": 0,
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nQtde": 3,
"nValUnit": 1000
},
{
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nCodServico": 2342423,
"nQtde": 12,
"nValUnit": 35
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/os/")
corpo = <<~'JSON'
{
"call": "AlterarOS",
"param": [
{
"Cabecalho": {
"nCodOS": "1790776458",
"cCodParc": "999",
"cEtapa": "20",
"dDtPrevisao": "30/09/2026",
"nCodCli": 2485994,
"nQtdeParc": 7
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "teste@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API de teste 72628",
"nCodCC": 11850365
},
"ServicosPrestados": [
{
"cCodServLC116": "7.07",
"cCodServMun": "01015",
"cDadosAdicItem": "Serviços prestados",
"cDescServ": "Serviço prestado 001",
"cRetemISS": "N",
"cTribServ": "01",
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqCOFINS": 0,
"nAliqCSLL": 0,
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nQtde": 3,
"nValUnit": 1000
},
{
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nCodServico": 2342423,
"nQtde": 12,
"nValUnit": 35
}
]
}
]
}
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": "AlterarOS",
"param": [
{
"Cabecalho": {
"nCodOS": "1790776458",
"cCodParc": "999",
"cEtapa": "20",
"dDtPrevisao": "30/09/2026",
"nCodCli": 2485994,
"nQtdeParc": 7
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "teste@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API de teste 72628",
"nCodCC": 11850365
},
"ServicosPrestados": [
{
"cCodServLC116": "7.07",
"cCodServMun": "01015",
"cDadosAdicItem": "Serviços prestados",
"cDescServ": "Serviço prestado 001",
"cRetemISS": "N",
"cTribServ": "01",
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqCOFINS": 0,
"nAliqCSLL": 0,
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nQtde": 3,
"nValUnit": 1000
},
{
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nCodServico": 2342423,
"nQtde": 12,
"nValUnit": 35
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/os/"))
.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/os/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""AlterarOS"", ""param"": [{""Cabecalho"": {""nCodOS"": ""1790776458"", ""cCodParc"": ""999"", ""cEtapa"": ""20"", ""dDtPrevisao"": ""30/09/2026"", ""nCodCli"": 2485994, ""nQtdeParc"": 7}, ""Departamentos"": [], ""Email"": {""cEnvBoleto"": ""N"", ""cEnvLink"": ""N"", ""cEnviarPara"": ""teste@omie.com.br""}, ""InformacoesAdicionais"": {""cCidPrestServ"": ""SAO PAULO (SP)"", ""cCodCateg"": ""1.01.02"", ""cDadosAdicNF"": ""OS incluida via API de teste 72628"", ""nCodCC"": 11850365}, ""ServicosPrestados"": [{""cCodServLC116"": ""7.07"", ""cCodServMun"": ""01015"", ""cDadosAdicItem"": ""Serviços prestados"", ""cDescServ"": ""Serviço prestado 001"", ""cRetemISS"": ""N"", ""cTribServ"": ""01"", ""impostos"": {""cRetemIRRF"": ""S"", ""cRetemPIS"": ""S"", ""nAliqCOFINS"": 0, ""nAliqCSLL"": 0, ""nAliqIRRF"": 15, ""nAliqISS"": 3, ""nAliqPIS"": 4.5}, ""nQtde"": 3, ""nValUnit"": 1000}, {""impostos"": {""cRetemIRRF"": ""S"", ""cRetemPIS"": ""S"", ""nAliqIRRF"": 15, ""nAliqISS"": 3, ""nAliqPIS"": 4.5}, ""nCodServico"": 2342423, ""nQtde"": 12, ""nValUnit"": 35}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosConsulta da Ordem de Serviço.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 5Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntOS | texto · até 60 | Código de Integração da OS |
cIncluirTarefas | texto · até 1 | Indica se deve incluir as tarefas vinculadas a ordem de serviço no retorno (S/N). Como default é "N". Deve ser utilizado apenas no método de consulta. |
cNumOS | texto · até 15 | Número da Ordem de Serviço Conforme visualizada na tela pelo cliente. |
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 | Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração. |
despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto · até 200 | Descrição da despesa. |
despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto · até 10 | Data da despesa. |
despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso. (Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão). Esse código não aparece na tela do Omie. Utilize esse código para identificar a despesa via API. |
despesasReembolsaveis.despesaReembolsavel[].nValorReemb | número | Valor da despesa. |
nCodOS | número inteiro | Código da Ordem de Serviço |
Retorno 12O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
Cabecalho | objeto | Cabeçalho da Ordem de Serviço |
Cabecalho.cCodIntCli | texto | Código de Integração do Cliente |
Cabecalho.cCodIntOS | texto | Código de Integração da OS. Obrigatório na inclusão. |
Cabecalho.cCodParc | texto | Código da parcela/Condição de pagamento. Utilize a tag "nCodigo" do método "ListarFormasPagVendas" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código "999" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag "qtde_parcelas" e a estrutura "lista_parcelas". Alguns dos valores disponíveis são: "000" - A Vista "A03" - Para 3 dias "A05" - Para 5 dias "A07" - Para 7 dias "A08" - Para 8 dias "A09" - Para 9 dias "A10" - Para 10 dias "A13" - Para 13 dias "A14" - Para 14 dias "A15" - Para 15 dias "A17" - Para 17 dias "A20" - Para 20 dias "A21" - Para 21 dias "A25" - Para 25 dias "A26" - Para 26 dias "A28" - Para 28 dias "A35" - Para 35 dias "A36" - Para 36 dias "A40" - Para 40 dias "A42" - Para 42 dias "A45" - Para 45 dias "A50" - Para 50 dias "A56" - Para 56 dias "A60" - Para 60 dias "A70" - Para 70 dias "A75" - Para 75 dias "A90" - Para 90 dias "A98" - Para 98 dias "B20" - Para 120 dias "001" - 1 Parcela (para 30 dias) "002" - 2 Parcelas "003" - 3 Parcelas "004" - 4 Parcelas "005" - 5 Parcelas "006" - 6 Parcelas "007" - 7 Parcelas "010" - 10 Parcelas "012" - 12 Parcelas "024" - 24 Parcelas "036" - 36 Parcelas "048" - 48 Parcelas "S01" - 30/60 "S02" - 45/60 "S03" - 21/28/35 "S04" - 21/28/35/42 "S05" - 28/35/42 "S06" - 28/35/42/49 "S07" - 30/45/60/75/90 "S08" - 25/56 "S09" - 30/45 "S10" - 28/56 "S11" - 10/30/60 "S12" - 15/30/60 "S13" - 28/35 "S14" - 7/14/21 "S15" - 10/30/60/90 "S16" - 60/90/120 "S17" - 45/60/90 "S18" - 30/60/90 "S19" - 14/21 "S20" - 7/14 "S21" - 14/21/28 "S22" - 45/75 "S23" - 30/45/60 "S24" - 3/20/40 "S25" - 30/60/90/120 "S26" - 21/28 "S27" - a Vista/15 "S28" - a Vista/30 "S29" - a Vista/30/60 "S30" - a Vista/30/60/90 "S31" - a Vista/30/60/90/120/150 "S41" - 28/42/56 "S32" - 15/45/75 "S33" - 14/28/42 "S34" - 14/21/28/35/42 "S35" - 30/42/54/66/78/90 "S36" - 14/21/28/35 "S37" - 28/42 "S38" - 30/45/60 "S39" - 35/42/49/56 "S40" - 28/42/56/70 "S42" - 30/40/50/60 "S43" - 30/50/70/90 "S44" - 14/28 "S45" - 45/60/75/90 "S46" - a Vista/30/60/90/120 "S47" - a vista/20/40/60 "S48" - 21/42 "S49" - 15/30/45 "S50" - 14/42 "S51" - 21/35 "S52" - 28/56/84 "S53" - 28/42/56/70/84 "S54" - a Vista/30/45 "S55" - 21/45 "S56" - a Vista/28 "S57" - a Vista/60/90 "S58" - 35/45/55 "S59" - 28/35/42/56 "S60" - 30/45/60/75 "S61" - 28/35/42/49/56 "S62" - 40/70/100 "S63" - 42/56 "S64" - a Vista/28/35 "S65" - 35/42 "S66" - 20/40 "S67" - a Vista/28/35/42 |
Cabecalho.cDescParc | texto | Descrição da parcela. Utilizado apenas para retorno do método "ConsultarOS". |
Cabecalho.cEtapa | texto | Código da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar |
Cabecalho.cNumOS | texto | Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente) |
Cabecalho.dDtPrevisao | texto | Data de Previsão |
Cabecalho.nCodCli | número inteiro | Código do Cliente |
Cabecalho.nCodCtr | número inteiro | Código do Contrato. Ao informar esse campo será incluído ao contrato uma Ordem de Serviço adicional. Utilizado somente na Inclusão/Alteração. Utilize a tag "nCodCtr" do método "ListarContrato" da API /api/v1/servicos/contrato/ para obter essa informação |
Cabecalho.nCodOS | número inteiro | Código da Ordem de Serviço |
Cabecalho.nCodVend | número inteiro | Código do Vendedor |
Cabecalho.nQtdeParc | número inteiro | Quantidade de Parcelas |
Cabecalho.nValorTotal | decimal | Valor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente. |
Cabecalho.nValorTotalImpRet | decimal | Valor Total de Impostos Retidos |
Caracteristicas | lista de objetos | Características da Ordem de Serviço. |
Caracteristicas[].cConteudo | texto | Conteúdo da Característica. |
Caracteristicas[].cNome | texto | Nome da característica. |
Caracteristicas[].nIdCampo | número inteiro | Id do campo característica. |
Caracteristicas[].nIdCaracteristica | número inteiro | ID da Característica. |
Departamentos | lista de objetos | Dados da Aba "Departamentos" do Pedido de Venda. |
Departamentos[].cCodDepto | texto | ID do Departamento. Informação localizada na Aba "Departamentos" do Pedido de Venda. Utilize a tag "codigo" do método "ListarDepatartamentos" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação. |
Departamentos[].nPerc | decimal | Percentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
Departamentos[].nValor | decimal | Valor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
Departamentos[].nValorFixo | texto | Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda. |
Email | objeto | |
Email.cEnvBoleto | texto | Enviar ao cliente e-mail com os Boletos de Cobrança gerados pelo faturamento. É permitido somente o preenchimento de uma das tags "cEnvPix" ou "cEnvBoleto". |
Email.cEnvLink | texto | Enviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida. |
Email.cEnvPix | texto | Enviar ao cliente e-mail com o PIX de Cobrança gerado pelo faturamento. É permitido somente o preenchimento de uma das tags "cEnvPix" ou "cEnvBoleto". |
Email.cEnvRecibo | texto | Enviar um recibo de prestação de serviços (ao invés da NFS-e) |
Email.cEnvViaUnica | texto | Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não |
Email.cEnviarPara | texto | Utilizar os seguintes endereços de e-mail |
InfoCadastro | objeto | Informações do cadastro da Ordem de Serviço. |
InfoCadastro.cAmbiente | texto | Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção |
InfoCadastro.cCancelada | texto | Ordem de Serviço cancelada? |
InfoCadastro.cFaturada | texto | Ordem de Serviço faturada com sucesso? |
InfoCadastro.cHrAlt | texto | Hora de Alteração da Ordem de Serviço |
InfoCadastro.cHrCanc | texto | Hora do Cancelamento |
InfoCadastro.cHrFat | texto | Hora do Faturamento |
InfoCadastro.cHrInc | texto | Hora de inclusão da Ordem de Serviço |
InfoCadastro.cOrigem | texto | Origem da Ordem de Serviço |
InfoCadastro.dDtAlt | texto | Data de Alteração da Ordem de Serviço |
InfoCadastro.dDtCanc | texto | Data de Cancelamento |
InfoCadastro.dDtFat | texto | Data de Faturamento |
InfoCadastro.dDtInc | texto | Data de Inclusão da Ordem de Serviço |
InfoCadastro.uAlt | texto | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
InfoCadastro.uInc | texto | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
InformacoesAdicionais | objeto | |
InformacoesAdicionais.DetalhesNfse | objeto | Detalhes da NFSE. |
InformacoesAdicionais.DetalhesNfse.Eventos | objeto | Evento na Nfse. |
InformacoesAdicionais.DetalhesNfse.Eventos.cBairroEvento | texto | Bairro do Evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCepEvento | texto | CEP do Evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeEvento | texto | Código da Cidade da Prestação de Serviços. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeExtEvento | texto | Cidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como "S". |
InformacoesAdicionais.DetalhesNfse.Eventos.cCodAtivEvento | texto | Código de Atividade do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCodPaisEvento | texto | Código do país do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cComplEvento | texto | Completo do endereço do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cEndEvento | texto | Endereço do envento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cEndExtEvento | texto | Endereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como "S". |
InformacoesAdicionais.DetalhesNfse.Eventos.cExtEvento | texto | Evento no Exterior S/N. |
InformacoesAdicionais.DetalhesNfse.Eventos.cNomeEvento | texto | Nome do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cNumEndEvento | texto | Número do endereço do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cUfEvento | texto | Estado do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.dDtFimEvento | texto | Data Final do Evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.dDtIniEvento | texto | Data de Início do Evento. |
InformacoesAdicionais.cCidPrestServ | texto | Cidade da Prestação do Serviço |
InformacoesAdicionais.cCodART | texto | Código ART |
InformacoesAdicionais.cCodCateg | texto | Categoria |
InformacoesAdicionais.cCodObra | texto | Código da Obra |
InformacoesAdicionais.cContato | texto | Contato |
InformacoesAdicionais.cDadosAdicNF | texto | Dados Adicionais da Nota Fiscal |
InformacoesAdicionais.cNumContrato | texto | Número do Contrato de Venda |
InformacoesAdicionais.cNumPedido | texto | Número do Pedido do Cliente |
InformacoesAdicionais.cNumRecibo | texto | Número do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado). |
InformacoesAdicionais.cUsoConsumo | texto | Uso e consumo pessoal. |
InformacoesAdicionais.dDataRps | texto | Data da RPS |
InformacoesAdicionais.nCodCC | número inteiro | Código da Conta Corrente |
InformacoesAdicionais.nCodProj | número inteiro | Código do Projeto |
InformacoesAdicionais.nIdDestinatario | número inteiro | ID Cliente para o Destinatário. |
Observacoes | objeto | |
Observacoes.cObsOS | texto | Observações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal). |
Parcelas | lista de objetos | Permite que o parcelamento seja realizado de forma manual. |
Parcelas[].categoria_adiantamento | texto | Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].conta_corrente_adiantamento | número inteiro | Conta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].dDtVenc | texto | Data de Vencimento da parcela. Ex: 01/02/2016 |
Parcelas[].meio_pagamento | texto | Meio de Pagamento - Utilizado apenas para emissão de NFS-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" da Ordem de Serviço. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
Parcelas[].nDias | número inteiro | Número de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias. |
Parcelas[].nParcela | número inteiro | Número da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2. |
Parcelas[].nPercentual | decimal | Percentual do valor da parcela. |
Parcelas[].nValor | decimal | Valor da Parcela. Ex: 100.23 |
Parcelas[].nao_gerar_boleto | texto | Não gerar boleto para esta parcela ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].nsu | texto | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. |
Parcelas[].parcela_adiantamento | texto | Está é uma parcela de Adiantamento do Cliente. Informe "S" para indicar que é uma parcela de adiantamento. O padrão é "N". Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].tipo_documento | texto | Tipo de Documento. Informação localizada na Aba "Parcelas" da Ordem de Serviço. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa disponível na API: /api/v1/ger |
ServicosPrestados | lista de objetos | Item da Ordem serviço |
ServicosPrestados[].DeducoesIss | lista de objetos | Informe aqui as Deduções para o ISS. |
ServicosPrestados[].DeducoesIss[].cCnpjFornecedor | texto | CPF ou CNPJ do Fornecedor |
ServicosPrestados[].DeducoesIss[].cDescMateriais | texto | Descrição do material. |
ServicosPrestados[].DeducoesIss[].cFormaDeducao | texto | Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor. |
ServicosPrestados[].DeducoesIss[].cNFReferencia | texto | Nota Fiscal de Referência. |
ServicosPrestados[].DeducoesIss[].cTipoDeduducao | texto | Tipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada |
ServicosPrestados[].DeducoesIss[].nPercDeducao | decimal | Percentual de dedução. |
ServicosPrestados[].DeducoesIss[].nQuantMateriais | decimal | Quantidade de Material |
ServicosPrestados[].DeducoesIss[].nValorDeducao | decimal | Valor da Dedução. |
ServicosPrestados[].DeducoesIss[].nValorTotNfRef | decimal | Valor total NF de Referência |
ServicosPrestados[].cAcaoItem | texto | Ação a ser realizada na alteração do item. Pode ser: "A" - Alterar o item (padrão). "E" - Excluir o item. "I" - Incluir o item na alteração. |
ServicosPrestados[].cCodCategItem | texto | Código da Categoria. |
ServicosPrestados[].cCodIntServico | texto | Código de Integração 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. |
ServicosPrestados[].cCodServLC116 | texto | Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag "nCodServico" 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. |
ServicosPrestados[].cCodServMun | texto | Código do Serviço Municipal ou CNAE. Caso tenha informado a tag "nCodServico" 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. |
ServicosPrestados[].cCodigo | texto | Código do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. |
ServicosPrestados[].cDadosAdicItem | texto | Dados adicionais do Item. |
ServicosPrestados[].cDescServ | texto | Descrição dos Serviços. Caso tenha informado a tag "nCodServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
ServicosPrestados[].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. |
ServicosPrestados[].cNbs | texto | Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag "nCodServico" irá assumir o valor informado no cadastro do respectivo serviço. |
ServicosPrestados[].cReembolso | texto | Identificação se o item é despesa reembolsável. |
ServicosPrestados[].cRetemISS | texto | Retem ISS (S/N) |
ServicosPrestados[].cTpDesconto | texto | Tipo de Desconto. Pode ser: P - Percentual V - Valor |
ServicosPrestados[].cTribServ | texto | Tipo de Tributação dos Serviços. Caso tenha informado a tag "nCodServico" 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. |
ServicosPrestados[].impostos | objeto | Dados do impostos do serviço. |
ServicosPrestados[].impostos.cCST | 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. |
ServicosPrestados[].impostos.cClassTrib | 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. |
ServicosPrestados[].impostos.cFixarCOFINS | texto | 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. |
ServicosPrestados[].impostos.cFixarCSLL | texto | 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. |
ServicosPrestados[].impostos.cFixarINSS | texto | 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. |
ServicosPrestados[].impostos.cFixarIRRF | texto | 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. |
ServicosPrestados[].impostos.cFixarISS | texto | 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. |
ServicosPrestados[].impostos.cFixarPIS | texto | 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. |
ServicosPrestados[].impostos.cIndOPer | 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. |
ServicosPrestados[].impostos.cManCbs | 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. |
ServicosPrestados[].impostos.cManIbsMun | 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. |
ServicosPrestados[].impostos.cManIbsUf | 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. |
ServicosPrestados[].impostos.cRetemCOFINS | texto | Retém COFINS (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemCSLL | texto | Retém CSLL (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemINSS | texto | Retém INSS (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemIRRF | texto | Retém IRRF (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemPIS | texto | Retém PIS (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.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. |
ServicosPrestados[].impostos.lDeduzISS | sim/não | Deduz o ISS da Base de Cálculo de PIS e COFINS |
ServicosPrestados[].impostos.nAliqCOFINS | 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. |
ServicosPrestados[].impostos.nAliqCSLL | 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. |
ServicosPrestados[].impostos.nAliqCbs | 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. |
ServicosPrestados[].impostos.nAliqEstadualIBPT | decimal | Alíquota da Carga Tribut. Aproximada Estadual. |
ServicosPrestados[].impostos.nAliqFederalIBPT | decimal | Alíquota da Carga Tribut. Aproximada Federal. |
ServicosPrestados[].impostos.nAliqINSS | 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. |
ServicosPrestados[].impostos.nAliqIRRF | decimal | Alíquota de IRRF. 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. |
ServicosPrestados[].impostos.nAliqISS | decimal | Alíquota de ISS. |
ServicosPrestados[].impostos.nAliqIbsMun | decimal | 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. |
ServicosPrestados[].impostos.nAliqIbsUf | 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. |
ServicosPrestados[].impostos.nAliqMunicipalIBPT | decimal | Alíquota da Carga Tribut. Aproximada Municipal. |
ServicosPrestados[].impostos.nAliqPIS | 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. |
ServicosPrestados[].impostos.nAliqRedBaseCOFINS | decimal | Percentual de Redução da Base de Cálculo do COFINS. |
ServicosPrestados[].impostos.nAliqRedBaseINSS | decimal | Percentual de Redução da Base de Cálculo do INSS. |
ServicosPrestados[].impostos.nAliqRedBasePIS | decimal | Percentual de Redução da Base de Cálculo do PIS. |
ServicosPrestados[].impostos.nBaseCalcIbsCbs | decimal | Valor da Base de Calculo do IBS e 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. |
ServicosPrestados[].impostos.nBaseISS | decimal | Base de Cálculo do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
ServicosPrestados[].impostos.nPercReducaoCbs | 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. |
ServicosPrestados[].impostos.nPercReducaoIbsMun | 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. |
ServicosPrestados[].impostos.nPercReducaoIbsUf | 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. |
ServicosPrestados[].impostos.nTotDeducao | decimal | Valor de Dedução da Base de Cálculo. Por padrão, esse campo afeta a Base de Cálculo do ISS. Para atender a condições legais acordadas para cada munícipio pode afetar as Bases de Cálculos dos Impostos Federais também. Consulte a legislação do seu município. |
ServicosPrestados[].impostos.nValorCOFINS | decimal | Valor do COFINS. 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. |
ServicosPrestados[].impostos.nValorCSLL | 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. |
ServicosPrestados[].impostos.nValorCbs | 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. |
ServicosPrestados[].impostos.nValorDeducao | decimal | Valor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem. |
ServicosPrestados[].impostos.nValorDeducaoIRRF | decimal | Valor da dedução da base do IR. |
ServicosPrestados[].impostos.nValorINSS | 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. |
ServicosPrestados[].impostos.nValorIRRF | decimal | Valor do IRRF. 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. |
ServicosPrestados[].impostos.nValorISS | decimal | Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
ServicosPrestados[].impostos.nValorIbsMun | 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. |
ServicosPrestados[].impostos.nValorIbsUf | 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. |
ServicosPrestados[].impostos.nValorPIS | 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. |
ServicosPrestados[].nAliqDesconto | decimal | Aliquota do Desconto. |
ServicosPrestados[].nCodServico | 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. |
ServicosPrestados[].nIdItem | número inteiro | ID do Item da Ordem de Serviço. Não deve ser informado na inclusão. Pode ser informado na alteração para identificar o item. |
ServicosPrestados[].nQtde | decimal | Quantidade de serviços. |
ServicosPrestados[].nSeqItem | número inteiro | Sequencia do Item Deve ser preenchido com uma sequencia de 1 a 199. |
ServicosPrestados[].nValUnit | decimal | Valor Unitário do serviço. Caso tenha informado a tag "nCodServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
ServicosPrestados[].nValorAcrescimos | decimal | Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.) |
ServicosPrestados[].nValorDesconto | decimal | Valor do Desconto. |
ServicosPrestados[].nValorOutrasRetencoes | decimal | Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.) |
ServicosPrestados[].viaUnica | objeto | Informações referente ao serviço de NF modelo 21 ou 22. |
ServicosPrestados[].viaUnica.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. |
ServicosPrestados[].viaUnica.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. |
ServicosPrestados[].viaUnica.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 |
ServicosPrestados[].viaUnica.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 |
ServicosPrestados[].viaUnica.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. |
Tarefas | lista de objetos | Lista com as tarefas relacionadas a ordem de serviço. Retornado apenas no método de consulta e quando preenchida a tag "cIncluirTarefas" como "S". |
Tarefas[].cCodIntTarefa | texto | |
Tarefas[].cDescricao | texto | Descrição da tarefa. |
Tarefas[].cNomeUserAtb | texto | |
Tarefas[].dData | texto | |
Tarefas[].hHora | texto | |
Tarefas[].nCodDoc | número inteiro | Id do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for "pedido-compra", esse campo reflete o código do pedido de compra. Se a origem da tarefa for "contas-receber", esse campo reflete o código da conta a receber. |
Tarefas[].nCodTarefa | número inteiro | Código único da tarefa. |
Tarefas[].nCodUserAtb | número inteiro | Código do usuário atribuído. |
despesasReembolsaveis | objeto | Despesas reembolsáveis. |
despesasReembolsaveis.cCodCategReemb | texto | Código da categoria para reembolso |
despesasReembolsaveis.despesaReembolsavel | lista de objetos | Despesa reembolsável |
despesasReembolsaveis.despesaReembolsavel[].cAcaoReemb | texto | Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração. |
despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto | Descrição da despesa. |
despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto | Data da despesa. |
despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso. (Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão). Esse código não aparece na tela do Omie. Utilize esse código para identificar a despesa via API. |
despesasReembolsaveis.despesaReembolsavel[].nValorReemb | decimal | Valor da despesa. |
produtosUtilizados | objeto | Produtos Utilizados na Ordem de Serviço. |
produtosUtilizados.cAcaoProdUtilizados | texto | Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. Obrigatório na inclusão. |
produtosUtilizados.cCodCategRem | texto | Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED' |
produtosUtilizados.produtoUtilizado | lista de objetos | rodutos utilizados no serviço. |
produtosUtilizados.produtoUtilizado[].cAcaoItemPU | texto | 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[].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. |
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 | decimal | Quantidade. |
POST /api/v1/servicos/os/
curl -s https://app.omie.com.br/api/v1/servicos/os/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ConsultarOS", "param": [{"cCodIntOS": "", "nCodOS": 0, "cNumOS": ""}]}'import os
import requests
corpo = {'call': 'ConsultarOS', 'param': [{'cCodIntOS': '', 'nCodOS': 0, 'cNumOS': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/os/",
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/os/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/os/");
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": "ConsultarOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/os/")
corpo = <<~'JSON'
{
"call": "ConsultarOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": ""
}
]
}
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": "ConsultarOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/os/"))
.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/os/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarOS"", ""param"": [{""cCodIntOS"": """", ""nCodOS"": 0, ""cNumOS"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosOperação para excluir uma Ordem de Serviço.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 5Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntOS | texto · até 60 | Código de Integração da OS |
cIncluirTarefas | texto · até 1 | Indica se deve incluir as tarefas vinculadas a ordem de serviço no retorno (S/N). Como default é "N". Deve ser utilizado apenas no método de consulta. |
cNumOS | texto · até 15 | Número da Ordem de Serviço Conforme visualizada na tela pelo cliente. |
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 | Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração. |
despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto · até 200 | Descrição da despesa. |
despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto · até 10 | Data da despesa. |
despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso. (Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão). Esse código não aparece na tela do Omie. Utilize esse código para identificar a despesa via API. |
despesasReembolsaveis.despesaReembolsavel[].nValorReemb | número | Valor da despesa. |
nCodOS | número inteiro | Código da Ordem de Serviço |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntOS | texto | Código de Integração da Ordem de Serviço |
cCodStatus | texto | Código do Status |
cDescStatus | texto | Descrição do Status |
cNumOS | texto | Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente) |
nCodOS | número inteiro | Código da Ordem de Serviço |
POST /api/v1/servicos/os/
curl -s https://app.omie.com.br/api/v1/servicos/os/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ExcluirOS", "param": [{"cCodIntOS": "", "nCodOS": 0, "cNumOS": ""}]}'import os
import requests
corpo = {'call': 'ExcluirOS', 'param': [{'cCodIntOS': '', 'nCodOS': 0, 'cNumOS': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/os/",
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/os/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/os/");
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": "ExcluirOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/os/")
corpo = <<~'JSON'
{
"call": "ExcluirOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": ""
}
]
}
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": "ExcluirOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/os/"))
.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/os/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirOS"", ""param"": [{""cCodIntOS"": """", ""nCodOS"": 0, ""cNumOS"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosOperação para incluir uma Ordem de Serviço
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 12Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
Cabecalho | objeto | Cabeçalho da Ordem de Serviço |
Cabecalho.cCodIntCli | texto · até 60 | Código de Integração do Cliente |
Cabecalho.cCodIntOS | texto · até 60 | Código de Integração da OS. Obrigatório na inclusão. |
Cabecalho.cCodParc | texto · até 3 | Código da parcela/Condição de pagamento. Utilize a tag "nCodigo" do método "ListarFormasPagVendas" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código "999" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag "qtde_parcelas" e a estrutura "lista_parcelas". Alguns dos valores disponíveis são: "000" - A Vista "A03" - Para 3 dias "A05" - Para 5 dias "A07" - Para 7 dias "A08" - Para 8 dias "A09" - Para 9 dias "A10" - Para 10 dias "A13" - Para 13 dias "A14" - Para 14 dias "A15" - Para 15 dias "A17" - Para 17 dias "A20" - Para 20 dias "A21" - Para 21 dias "A25" - Para 25 dias "A26" - Para 26 dias "A28" - Para 28 dias "A35" - Para 35 dias "A36" - Para 36 dias "A40" - Para 40 dias "A42" - Para 42 dias "A45" - Para 45 dias "A50" - Para 50 dias "A56" - Para 56 dias "A60" - Para 60 dias "A70" - Para 70 dias "A75" - Para 75 dias "A90" - Para 90 dias "A98" - Para 98 dias "B20" - Para 120 dias "001" - 1 Parcela (para 30 dias) "002" - 2 Parcelas "003" - 3 Parcelas "004" - 4 Parcelas "005" - 5 Parcelas "006" - 6 Parcelas "007" - 7 Parcelas "010" - 10 Parcelas "012" - 12 Parcelas "024" - 24 Parcelas "036" - 36 Parcelas "048" - 48 Parcelas "S01" - 30/60 "S02" - 45/60 "S03" - 21/28/35 "S04" - 21/28/35/42 "S05" - 28/35/42 "S06" - 28/35/42/49 "S07" - 30/45/60/75/90 "S08" - 25/56 "S09" - 30/45 "S10" - 28/56 "S11" - 10/30/60 "S12" - 15/30/60 "S13" - 28/35 "S14" - 7/14/21 "S15" - 10/30/60/90 "S16" - 60/90/120 "S17" - 45/60/90 "S18" - 30/60/90 "S19" - 14/21 "S20" - 7/14 "S21" - 14/21/28 "S22" - 45/75 "S23" - 30/45/60 "S24" - 3/20/40 "S25" - 30/60/90/120 "S26" - 21/28 "S27" - a Vista/15 "S28" - a Vista/30 "S29" - a Vista/30/60 "S30" - a Vista/30/60/90 "S31" - a Vista/30/60/90/120/150 "S41" - 28/42/56 "S32" - 15/45/75 "S33" - 14/28/42 "S34" - 14/21/28/35/42 "S35" - 30/42/54/66/78/90 "S36" - 14/21/28/35 "S37" - 28/42 "S38" - 30/45/60 "S39" - 35/42/49/56 "S40" - 28/42/56/70 "S42" - 30/40/50/60 "S43" - 30/50/70/90 "S44" - 14/28 "S45" - 45/60/75/90 "S46" - a Vista/30/60/90/120 "S47" - a vista/20/40/60 "S48" - 21/42 "S49" - 15/30/45 "S50" - 14/42 "S51" - 21/35 "S52" - 28/56/84 "S53" - 28/42/56/70/84 "S54" - a Vista/30/45 "S55" - 21/45 "S56" - a Vista/28 "S57" - a Vista/60/90 "S58" - 35/45/55 "S59" - 28/35/42/56 "S60" - 30/45/60/75 "S61" - 28/35/42/49/56 "S62" - 40/70/100 "S63" - 42/56 "S64" - a Vista/28/35 "S65" - 35/42 "S66" - 20/40 "S67" - a Vista/28/35/42 |
Cabecalho.cDescParc | texto · até 30 | Descrição da parcela. Utilizado apenas para retorno do método "ConsultarOS". |
Cabecalho.cEtapa | texto · até 2 | Código da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar |
Cabecalho.cNumOS | texto · até 15 | Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente) |
Cabecalho.dDtPrevisao | texto · até 10 | Data de Previsão |
Cabecalho.nCodCli | número inteiro | Código do Cliente |
Cabecalho.nCodCtr | número inteiro | Código do Contrato. Ao informar esse campo será incluído ao contrato uma Ordem de Serviço adicional. Utilizado somente na Inclusão/Alteração. Utilize a tag "nCodCtr" do método "ListarContrato" da API /api/v1/servicos/contrato/ para obter essa informação |
Cabecalho.nCodOS | número inteiro | Código da Ordem de Serviço |
Cabecalho.nCodVend | número inteiro | Código do Vendedor |
Cabecalho.nQtdeParc | número inteiro | Quantidade de Parcelas |
Cabecalho.nValorTotal | número | Valor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente. |
Cabecalho.nValorTotalImpRet | número | Valor Total de Impostos Retidos |
Caracteristicas | lista de objetos | Características da Ordem de Serviço. |
Caracteristicas[].cConteudo | texto · até 7000 | Conteúdo da Característica. |
Caracteristicas[].cNome | texto · até 70 | Nome da característica. |
Caracteristicas[].nIdCampo | número inteiro | Id do campo característica. |
Caracteristicas[].nIdCaracteristica | número inteiro | ID da Característica. |
Departamentos | lista de objetos | Dados da Aba "Departamentos" do Pedido de Venda. |
Departamentos[].cCodDepto | texto · até 40 | ID do Departamento. Informação localizada na Aba "Departamentos" do Pedido de Venda. Utilize a tag "codigo" do método "ListarDepatartamentos" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação. |
Departamentos[].nPerc | número | Percentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
Departamentos[].nValor | número | Valor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
Departamentos[].nValorFixo | texto · até 1 | Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda. |
Email | objeto | |
Email.cEnvBoleto | texto · até 1 | Enviar ao cliente e-mail com os Boletos de Cobrança gerados pelo faturamento. É permitido somente o preenchimento de uma das tags "cEnvPix" ou "cEnvBoleto". |
Email.cEnvLink | texto · até 1 | Enviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida. |
Email.cEnvPix | texto · até 1 | Enviar ao cliente e-mail com o PIX de Cobrança gerado pelo faturamento. É permitido somente o preenchimento de uma das tags "cEnvPix" ou "cEnvBoleto". |
Email.cEnvRecibo | texto · até 1 | Enviar um recibo de prestação de serviços (ao invés da NFS-e) |
Email.cEnvViaUnica | texto · até 1 | Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não |
Email.cEnviarPara | texto | Utilizar os seguintes endereços de e-mail |
InfoCadastro | objeto | Informações do cadastro da Ordem de Serviço. |
InfoCadastro.cAmbiente | texto · até 1 | Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção |
InfoCadastro.cCancelada | texto · até 1 | Ordem de Serviço cancelada?Ex.: S, N |
InfoCadastro.cFaturada | texto · até 1 | Ordem de Serviço faturada com sucesso?Ex.: S, N |
InfoCadastro.cHrAlt | texto · até 8 | Hora de Alteração da Ordem de Serviço |
InfoCadastro.cHrCanc | texto · até 8 | Hora do Cancelamento |
InfoCadastro.cHrFat | texto · até 8 | Hora do Faturamento |
InfoCadastro.cHrInc | texto · até 8 | Hora de inclusão da Ordem de Serviço |
InfoCadastro.cOrigem | texto · até 3 | Origem da Ordem de Serviço |
InfoCadastro.dDtAlt | texto · até 10 | Data de Alteração da Ordem de Serviço |
InfoCadastro.dDtCanc | texto · até 10 | Data de Cancelamento |
InfoCadastro.dDtFat | texto · até 10 | Data de Faturamento |
InfoCadastro.dDtInc | texto · até 10 | Data de Inclusão da Ordem de Serviç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. |
InformacoesAdicionais | objeto | |
InformacoesAdicionais.DetalhesNfse | objeto | Detalhes da NFSE. |
InformacoesAdicionais.DetalhesNfse.Eventos | objeto | Evento na Nfse. |
InformacoesAdicionais.DetalhesNfse.Eventos.cBairroEvento | texto · até 60 | Bairro do Evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCepEvento | texto · até 10 | CEP do Evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeEvento | texto · até 40 | Código da Cidade da Prestação de Serviços. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeExtEvento | texto · até 60 | Cidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como "S". |
InformacoesAdicionais.DetalhesNfse.Eventos.cCodAtivEvento | texto · até 30 | Código de Atividade do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cCodPaisEvento | texto · até 4 | Código do país do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cComplEvento | texto · até 40 | Completo do endereço do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cEndEvento | texto · até 60 | Endereço do envento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cEndExtEvento | texto · até 255 | Endereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como "S". |
InformacoesAdicionais.DetalhesNfse.Eventos.cExtEvento | texto · até 1 | Evento no Exterior S/N. |
InformacoesAdicionais.DetalhesNfse.Eventos.cNomeEvento | texto · até 60 | Nome do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cNumEndEvento | texto · até 10 | Número do endereço do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.cUfEvento | texto · até 2 | Estado do evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.dDtFimEvento | texto | Data Final do Evento. |
InformacoesAdicionais.DetalhesNfse.Eventos.dDtIniEvento | texto | Data de Início do Evento. |
InformacoesAdicionais.cCidPrestServ | texto · até 40 | Cidade da Prestação do Serviço |
InformacoesAdicionais.cCodART | texto · até 20 | Código ART |
InformacoesAdicionais.cCodCateg | texto · até 20 | Categoria |
InformacoesAdicionais.cCodObra | texto · até 15 | Código da Obra |
InformacoesAdicionais.cContato | texto · até 100 | Contato |
InformacoesAdicionais.cDadosAdicNF | texto | Dados Adicionais da Nota Fiscal |
InformacoesAdicionais.cNumContrato | texto · até 20 | Número do Contrato de Venda |
InformacoesAdicionais.cNumPedido | texto · até 30 | Número do Pedido do Cliente |
InformacoesAdicionais.cNumRecibo | texto · até 10 | Número do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado). |
InformacoesAdicionais.cUsoConsumo | texto · até 1 | Uso e consumo pessoal. |
InformacoesAdicionais.dDataRps | texto · até 10 | Data da RPS |
InformacoesAdicionais.nCodCC | número inteiro | Código da Conta Corrente |
InformacoesAdicionais.nCodProj | número inteiro | Código do Projeto |
InformacoesAdicionais.nIdDestinatario | número inteiro | ID Cliente para o Destinatário. |
Observacoes | objeto | |
Observacoes.cObsOS | texto | Observações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal). |
Parcelas | lista de objetos | Permite que o parcelamento seja realizado de forma manual. |
Parcelas[].categoria_adiantamento | texto · até 20 | Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].conta_corrente_adiantamento | número inteiro | Conta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].dDtVenc | texto · até 10 | Data de Vencimento da parcela. Ex: 01/02/2016 |
Parcelas[].meio_pagamento | texto · até 100 | Meio de Pagamento - Utilizado apenas para emissão de NFS-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" da Ordem de Serviço. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
Parcelas[].nDiasobrigatório | número inteiro | Número de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias. |
Parcelas[].nParcelaobrigatório | número inteiro | Número da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2. |
Parcelas[].nPercentual | número | Percentual do valor da parcela. |
Parcelas[].nValor | número | Valor da Parcela. Ex: 100.23 |
Parcelas[].nao_gerar_boleto | texto · até 1 | Não gerar boleto para esta parcela ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].nsu | texto · até 100 | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. |
Parcelas[].parcela_adiantamento | texto · até 1 | Está é uma parcela de Adiantamento do Cliente. Informe "S" para indicar que é uma parcela de adiantamento. O padrão é "N". Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
Parcelas[].tipo_documento | texto · até 5 | Tipo de Documento. Informação localizada na Aba "Parcelas" da Ordem de Serviço. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa disponível na API: /api/v1/ger |
ServicosPrestados | lista de objetos | Item da Ordem serviço |
ServicosPrestados[].DeducoesIss | lista de objetos | Informe aqui as Deduções para o ISS. |
ServicosPrestados[].DeducoesIss[].cCnpjFornecedor | texto · até 20 | CPF ou CNPJ do Fornecedor |
ServicosPrestados[].DeducoesIss[].cDescMateriais | texto · até 100 | Descrição do material. |
ServicosPrestados[].DeducoesIss[].cFormaDeducao | texto · até 1 | Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor. |
ServicosPrestados[].DeducoesIss[].cNFReferencia | texto · até 20 | Nota Fiscal de Referência. |
ServicosPrestados[].DeducoesIss[].cTipoDeduducao | texto · até 1 | Tipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada |
ServicosPrestados[].DeducoesIss[].nPercDeducao | número | Percentual de dedução. |
ServicosPrestados[].DeducoesIss[].nQuantMateriais | número | Quantidade de Material |
ServicosPrestados[].DeducoesIss[].nValorDeducao | número | Valor da Dedução. |
ServicosPrestados[].DeducoesIss[].nValorTotNfRef | número | Valor total NF de Referência |
ServicosPrestados[].cAcaoItem | texto · até 1 | Ação a ser realizada na alteração do item. Pode ser: "A" - Alterar o item (padrão). "E" - Excluir o item. "I" - Incluir o item na alteração. |
ServicosPrestados[].cCodCategItem | texto · até 20 | Código da Categoria. |
ServicosPrestados[].cCodIntServico | texto · até 60 | Código de Integração 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. |
ServicosPrestados[].cCodServLC116 | texto · até 20 | Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag "nCodServico" 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. |
ServicosPrestados[].cCodServMun | texto · até 20 | Código do Serviço Municipal ou CNAE. Caso tenha informado a tag "nCodServico" 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. |
ServicosPrestados[].cCodigo | texto · até 20 | Código do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. |
ServicosPrestados[].cDadosAdicItem | texto | Dados adicionais do Item. |
ServicosPrestados[].cDescServ | texto | Descrição dos Serviços. Caso tenha informado a tag "nCodServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
ServicosPrestados[].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. |
ServicosPrestados[].cNbs | texto · até 9 | Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag "nCodServico" irá assumir o valor informado no cadastro do respectivo serviço. |
ServicosPrestados[].cReembolso | texto · até 1 | Identificação se o item é despesa reembolsável. |
ServicosPrestados[].cRetemISS | texto · até 1 | Retem ISS (S/N) |
ServicosPrestados[].cTpDesconto | texto · até 1 | Tipo de Desconto. Pode ser: P - Percentual V - Valor |
ServicosPrestados[].cTribServ | texto · até 2 | Tipo de Tributação dos Serviços. Caso tenha informado a tag "nCodServico" 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. |
ServicosPrestados[].impostos | objeto | Dados do impostos do serviço. |
ServicosPrestados[].impostos.cCST | 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. |
ServicosPrestados[].impostos.cClassTrib | 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. |
ServicosPrestados[].impostos.cFixarCOFINS | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarCSLL | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarINSS | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarIRRF | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarISS | texto · até 1 | 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. |
ServicosPrestados[].impostos.cFixarPIS | texto · até 1 | 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. |
ServicosPrestados[].impostos.cIndOPer | 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. |
ServicosPrestados[].impostos.cManCbs | 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. |
ServicosPrestados[].impostos.cManIbsMun | 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. |
ServicosPrestados[].impostos.cManIbsUf | 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. |
ServicosPrestados[].impostos.cRetemCOFINS | texto · até 1 | Retém COFINS (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemCSLL | texto · até 1 | Retém CSLL (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemINSS | texto · até 1 | Retém INSS (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemIRRF | texto · até 1 | Retém IRRF (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.cRetemPIS | texto · até 1 | Retém PIS (S/N). Indica se o imposto deve ser retido ou não. |
ServicosPrestados[].impostos.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. |
ServicosPrestados[].impostos.lDeduzISS | sim/não | Deduz o ISS da Base de Cálculo de PIS e COFINS |
ServicosPrestados[].impostos.nAliqCOFINSobrigató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. |
ServicosPrestados[].impostos.nAliqCSLLobrigató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. |
ServicosPrestados[].impostos.nAliqCbs | 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. |
ServicosPrestados[].impostos.nAliqEstadualIBPT | número | Alíquota da Carga Tribut. Aproximada Estadual. |
ServicosPrestados[].impostos.nAliqFederalIBPT | número | Alíquota da Carga Tribut. Aproximada Federal. |
ServicosPrestados[].impostos.nAliqINSSobrigató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. |
ServicosPrestados[].impostos.nAliqIRRFobrigatório | número | Alíquota de IRRF. 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. |
ServicosPrestados[].impostos.nAliqISS | número | Alíquota de ISS. |
ServicosPrestados[].impostos.nAliqIbsMun | número | 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. |
ServicosPrestados[].impostos.nAliqIbsUf | 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. |
ServicosPrestados[].impostos.nAliqMunicipalIBPT | número | Alíquota da Carga Tribut. Aproximada Municipal. |
ServicosPrestados[].impostos.nAliqPISobrigató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. |
ServicosPrestados[].impostos.nAliqRedBaseCOFINS | número | Percentual de Redução da Base de Cálculo do COFINS. |
ServicosPrestados[].impostos.nAliqRedBaseINSS | número | Percentual de Redução da Base de Cálculo do INSS. |
ServicosPrestados[].impostos.nAliqRedBasePIS | número | Percentual de Redução da Base de Cálculo do PIS. |
ServicosPrestados[].impostos.nBaseCalcIbsCbs | número | Valor da Base de Calculo do IBS e 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. |
ServicosPrestados[].impostos.nBaseISS | número | Base de Cálculo do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
ServicosPrestados[].impostos.nPercReducaoCbs | 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. |
ServicosPrestados[].impostos.nPercReducaoIbsMun | 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. |
ServicosPrestados[].impostos.nPercReducaoIbsUf | 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. |
ServicosPrestados[].impostos.nTotDeducao | número | Valor de Dedução da Base de Cálculo. Por padrão, esse campo afeta a Base de Cálculo do ISS. Para atender a condições legais acordadas para cada munícipio pode afetar as Bases de Cálculos dos Impostos Federais também. Consulte a legislação do seu município. |
ServicosPrestados[].impostos.nValorCOFINS | número | Valor do COFINS. 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. |
ServicosPrestados[].impostos.nValorCSLL | 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. |
ServicosPrestados[].impostos.nValorCbs | 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. |
ServicosPrestados[].impostos.nValorDeducao | número | Valor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem. |
ServicosPrestados[].impostos.nValorDeducaoIRRF | número | Valor da dedução da base do IR. |
ServicosPrestados[].impostos.nValorINSS | 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. |
ServicosPrestados[].impostos.nValorIRRF | número | Valor do IRRF. 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. |
ServicosPrestados[].impostos.nValorISS | número | Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
ServicosPrestados[].impostos.nValorIbsMun | 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. |
ServicosPrestados[].impostos.nValorIbsUf | 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. |
ServicosPrestados[].impostos.nValorPIS | 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. |
ServicosPrestados[].nAliqDesconto | número | Aliquota do Desconto. |
ServicosPrestados[].nCodServico | 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. |
ServicosPrestados[].nIdItem | número inteiro | ID do Item da Ordem de Serviço. Não deve ser informado na inclusão. Pode ser informado na alteração para identificar o item. |
ServicosPrestados[].nQtde | número | Quantidade de serviços. |
ServicosPrestados[].nSeqItem | número inteiro | Sequencia do Item Deve ser preenchido com uma sequencia de 1 a 199. |
ServicosPrestados[].nValUnit | número | Valor Unitário do serviço. Caso tenha informado a tag "nCodServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
ServicosPrestados[].nValorAcrescimos | número | Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.) |
ServicosPrestados[].nValorDesconto | número | Valor do Desconto. |
ServicosPrestados[].nValorOutrasRetencoes | número | Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.) |
ServicosPrestados[].viaUnica | objeto | Informações referente ao serviço de NF modelo 21 ou 22. |
ServicosPrestados[].viaUnica.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. |
ServicosPrestados[].viaUnica.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. |
ServicosPrestados[].viaUnica.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 |
ServicosPrestados[].viaUnica.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 |
ServicosPrestados[].viaUnica.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. |
Tarefas | lista de objetos | Lista com as tarefas relacionadas a ordem de serviço. Retornado apenas no método de consulta e quando preenchida a tag "cIncluirTarefas" como "S". |
Tarefas[].cCodIntTarefa | texto · até 20 | |
Tarefas[].cDescricao | texto · até 10 | Descrição da tarefa. |
Tarefas[].cNomeUserAtb | texto · até 800 | |
Tarefas[].dData | texto | |
Tarefas[].hHora | texto · até 5 | |
Tarefas[].nCodDoc | número inteiro | Id do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for "pedido-compra", esse campo reflete o código do pedido de compra. Se a origem da tarefa for "contas-receber", esse campo reflete o código da conta a receber. |
Tarefas[].nCodTarefa | número inteiro | Código único da tarefa. |
Tarefas[].nCodUserAtb | número inteiro | Código do usuário atribuído. |
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 | Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração. |
despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto · até 200 | Descrição da despesa. |
despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto · até 10 | Data da despesa. |
despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso. (Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão). Esse código não aparece na tela do Omie. Utilize esse código para identificar a despesa via API. |
despesasReembolsaveis.despesaReembolsavel[].nValorReemb | número | Valor da despesa. |
produtosUtilizados | objeto | Produtos Utilizados na Ordem de Serviço. |
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. 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 | rodutos 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. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntOS | texto | Código de Integração da Ordem de Serviço |
cCodStatus | texto | Código do Status |
cDescStatus | texto | Descrição do Status |
cNumOS | texto | Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente) |
nCodOS | número inteiro | Código da Ordem de Serviço |
POST /api/v1/servicos/os/
curl -s https://app.omie.com.br/api/v1/servicos/os/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirOS", "param": [{"Cabecalho": {"cCodIntOS": "1790776458", "cCodParc": "999", "cEtapa": "20", "dDtPrevisao": "30/09/2026", "nCodCli": 2485994, "nQtdeParc": 7}, "Departamentos": [], "Email": {"cEnvBoleto": "N", "cEnvLink": "N", "cEnviarPara": "teste@omie.com.br"}, "InformacoesAdicionais": {"cCidPrestServ": "SAO PAULO (SP)", "cCodCateg": "1.01.02", "cDadosAdicNF": "OS incluida via API de teste 79056", "nCodCC": 11850365}, "ServicosPrestados": [{"cCodServLC116": "7.07", "cCodServMun": "01015", "cDadosAdicItem": "Serviços prestados", "cDescServ": "Serviço prestado 001", "cRetemISS": "N", "cTribServ": "01", "impostos": {"cRetemIRRF": "S", "cRetemPIS": "S", "nAliqCOFINS": 0, "nAliqCSLL": 0, "nAliqIRRF": 15, "nAliqISS": 3, "nAliqPIS": 4.5}, "nQtde": 3, "nValUnit": 1000}, {"impostos": {"cRetemIRRF": "S", "cRetemPIS": "S", "nAliqIRRF": 15, "nAliqISS": 3, "nAliqPIS": 4.5}, "nCodServico": 2342423, "nQtde": 12, "nValUnit": 35}]}]}'import os
import requests
corpo = {'call': 'IncluirOS',
'param': [{'Cabecalho': {'cCodIntOS': '1790776458',
'cCodParc': '999',
'cEtapa': '20',
'dDtPrevisao': '30/09/2026',
'nCodCli': 2485994,
'nQtdeParc': 7},
'Departamentos': [],
'Email': {'cEnvBoleto': 'N',
'cEnvLink': 'N',
'cEnviarPara': 'teste@omie.com.br'},
'InformacoesAdicionais': {'cCidPrestServ': 'SAO PAULO (SP)',
'cCodCateg': '1.01.02',
'cDadosAdicNF': 'OS incluida via API de teste '
'79056',
'nCodCC': 11850365},
'ServicosPrestados': [{'cCodServLC116': '7.07',
'cCodServMun': '01015',
'cDadosAdicItem': 'Serviços prestados',
'cDescServ': 'Serviço prestado 001',
'cRetemISS': 'N',
'cTribServ': '01',
'impostos': {'cRetemIRRF': 'S',
'cRetemPIS': 'S',
'nAliqCOFINS': 0,
'nAliqCSLL': 0,
'nAliqIRRF': 15,
'nAliqISS': 3,
'nAliqPIS': 4.5},
'nQtde': 3,
'nValUnit': 1000},
{'impostos': {'cRetemIRRF': 'S',
'cRetemPIS': 'S',
'nAliqIRRF': 15,
'nAliqISS': 3,
'nAliqPIS': 4.5},
'nCodServico': 2342423,
'nQtde': 12,
'nValUnit': 35}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/os/",
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/os/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirOS",
"param": [
{
"Cabecalho": {
"cCodIntOS": "1790776458",
"cCodParc": "999",
"cEtapa": "20",
"dDtPrevisao": "30/09/2026",
"nCodCli": 2485994,
"nQtdeParc": 7
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "teste@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API de teste 79056",
"nCodCC": 11850365
},
"ServicosPrestados": [
{
"cCodServLC116": "7.07",
"cCodServMun": "01015",
"cDadosAdicItem": "Serviços prestados",
"cDescServ": "Serviço prestado 001",
"cRetemISS": "N",
"cTribServ": "01",
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqCOFINS": 0,
"nAliqCSLL": 0,
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nQtde": 3,
"nValUnit": 1000
},
{
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nCodServico": 2342423,
"nQtde": 12,
"nValUnit": 35
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/os/");
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": "IncluirOS",
"param": [
{
"Cabecalho": {
"cCodIntOS": "1790776458",
"cCodParc": "999",
"cEtapa": "20",
"dDtPrevisao": "30/09/2026",
"nCodCli": 2485994,
"nQtdeParc": 7
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "teste@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API de teste 79056",
"nCodCC": 11850365
},
"ServicosPrestados": [
{
"cCodServLC116": "7.07",
"cCodServMun": "01015",
"cDadosAdicItem": "Serviços prestados",
"cDescServ": "Serviço prestado 001",
"cRetemISS": "N",
"cTribServ": "01",
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqCOFINS": 0,
"nAliqCSLL": 0,
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nQtde": 3,
"nValUnit": 1000
},
{
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nCodServico": 2342423,
"nQtde": 12,
"nValUnit": 35
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/os/")
corpo = <<~'JSON'
{
"call": "IncluirOS",
"param": [
{
"Cabecalho": {
"cCodIntOS": "1790776458",
"cCodParc": "999",
"cEtapa": "20",
"dDtPrevisao": "30/09/2026",
"nCodCli": 2485994,
"nQtdeParc": 7
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "teste@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API de teste 79056",
"nCodCC": 11850365
},
"ServicosPrestados": [
{
"cCodServLC116": "7.07",
"cCodServMun": "01015",
"cDadosAdicItem": "Serviços prestados",
"cDescServ": "Serviço prestado 001",
"cRetemISS": "N",
"cTribServ": "01",
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqCOFINS": 0,
"nAliqCSLL": 0,
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nQtde": 3,
"nValUnit": 1000
},
{
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nCodServico": 2342423,
"nQtde": 12,
"nValUnit": 35
}
]
}
]
}
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": "IncluirOS",
"param": [
{
"Cabecalho": {
"cCodIntOS": "1790776458",
"cCodParc": "999",
"cEtapa": "20",
"dDtPrevisao": "30/09/2026",
"nCodCli": 2485994,
"nQtdeParc": 7
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "teste@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API de teste 79056",
"nCodCC": 11850365
},
"ServicosPrestados": [
{
"cCodServLC116": "7.07",
"cCodServMun": "01015",
"cDadosAdicItem": "Serviços prestados",
"cDescServ": "Serviço prestado 001",
"cRetemISS": "N",
"cTribServ": "01",
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqCOFINS": 0,
"nAliqCSLL": 0,
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nQtde": 3,
"nValUnit": 1000
},
{
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nCodServico": 2342423,
"nQtde": 12,
"nValUnit": 35
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/os/"))
.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/os/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirOS"", ""param"": [{""Cabecalho"": {""cCodIntOS"": ""1790776458"", ""cCodParc"": ""999"", ""cEtapa"": ""20"", ""dDtPrevisao"": ""30/09/2026"", ""nCodCli"": 2485994, ""nQtdeParc"": 7}, ""Departamentos"": [], ""Email"": {""cEnvBoleto"": ""N"", ""cEnvLink"": ""N"", ""cEnviarPara"": ""teste@omie.com.br""}, ""InformacoesAdicionais"": {""cCidPrestServ"": ""SAO PAULO (SP)"", ""cCodCateg"": ""1.01.02"", ""cDadosAdicNF"": ""OS incluida via API de teste 79056"", ""nCodCC"": 11850365}, ""ServicosPrestados"": [{""cCodServLC116"": ""7.07"", ""cCodServMun"": ""01015"", ""cDadosAdicItem"": ""Serviços prestados"", ""cDescServ"": ""Serviço prestado 001"", ""cRetemISS"": ""N"", ""cTribServ"": ""01"", ""impostos"": {""cRetemIRRF"": ""S"", ""cRetemPIS"": ""S"", ""nAliqCOFINS"": 0, ""nAliqCSLL"": 0, ""nAliqIRRF"": 15, ""nAliqISS"": 3, ""nAliqPIS"": 4.5}, ""nQtde"": 3, ""nValUnit"": 1000}, {""impostos"": {""cRetemIRRF"": ""S"", ""cRetemPIS"": ""S"", ""nAliqIRRF"": 15, ""nAliqISS"": 3, ""nAliqPIS"": 4.5}, ""nCodServico"": 2342423, ""nQtde"": 12, ""nValUnit"": 35}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosLista as Ordens de Serviços.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 24Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | texto · até 1 | |
cExibirCaracteristicas | texto · até 1 | Exibir as características (S/N). Preencher com "S" ou "N". |
cExibirDespesas | texto · até 1 | Exibir as despesas reembolsáveis (S/N). Preencher com "S" ou "N". |
cExibirProdutos | texto · até 1 | Exibir os produtos utilizados (S/N). Preencher com "S" ou "N". |
cTipoFat | texto · até 3 | Tipo de faturamento: Pode ser: REC - Recibo NFS - NFS-e VUF - Via única não autorizada VUA - Via única autorizada |
filtrar_apenas_alteracao | texto · até 1 | |
filtrar_apenas_inclusao | texto · até 1 | |
filtrar_por_cliente | número inteiro | Filtra pelo ID do cliente. |
filtrar_por_codigo | lista de objetos | Lista de códigos de Ordem de Serviço. |
filtrar_por_codigo[].cCodIntOS | texto · até 60 | Código de Integração da OS. |
filtrar_por_codigo[].nCodOS | número inteiro | Código da Ordem de Serviço. (Código interno utilizado apenas na API). |
filtrar_por_data_ate | texto · até 10 | Data de inclusão e/ou alteração final. |
filtrar_por_data_cancelamento_ate | texto · até 10 | Data de cancelamento final. |
filtrar_por_data_cancelamento_de | texto · até 10 | Data de cancelamento inicial. |
filtrar_por_data_de | texto · até 10 | Data de inclusão e/ou alteração inicial. |
filtrar_por_data_faturamento_ate | texto · até 10 | Data de faturamento final. |
filtrar_por_data_faturamento_de | texto · até 10 | Data de faturamento inicial. |
filtrar_por_data_previsao_ate | texto · até 10 | Data de previsão final. |
filtrar_por_data_previsao_de | texto · até 10 | Data de previsão inicial |
filtrar_por_etapa | texto · até 2 | Etapa da Ordem de Serviço. |
filtrar_por_status | texto · até 1 | Status da OS: F-Faturada N-Não faturada C-Cancelada |
ordem_decrescente | texto · até 1 | Ordem Crescente ou Decrescente. |
ordem_descrescente | texto · até 1 | Descontinuado. |
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 |
|---|---|---|
osCadastro | lista de objetos | |
osCadastro[].Cabecalho | objeto | Cabeçalho da Ordem de Serviço |
osCadastro[].Cabecalho.cCodIntCli | texto | Código de Integração do Cliente |
osCadastro[].Cabecalho.cCodIntOS | texto | Código de Integração da OS. Obrigatório na inclusão. |
osCadastro[].Cabecalho.cCodParc | texto | Código da parcela/Condição de pagamento. Utilize a tag "nCodigo" do método "ListarFormasPagVendas" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código "999" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag "qtde_parcelas" e a estrutura "lista_parcelas". Alguns dos valores disponíveis são: "000" - A Vista "A03" - Para 3 dias "A05" - Para 5 dias "A07" - Para 7 dias "A08" - Para 8 dias "A09" - Para 9 dias "A10" - Para 10 dias "A13" - Para 13 dias "A14" - Para 14 dias "A15" - Para 15 dias "A17" - Para 17 dias "A20" - Para 20 dias "A21" - Para 21 dias "A25" - Para 25 dias "A26" - Para 26 dias "A28" - Para 28 dias "A35" - Para 35 dias "A36" - Para 36 dias "A40" - Para 40 dias "A42" - Para 42 dias "A45" - Para 45 dias "A50" - Para 50 dias "A56" - Para 56 dias "A60" - Para 60 dias "A70" - Para 70 dias "A75" - Para 75 dias "A90" - Para 90 dias "A98" - Para 98 dias "B20" - Para 120 dias "001" - 1 Parcela (para 30 dias) "002" - 2 Parcelas "003" - 3 Parcelas "004" - 4 Parcelas "005" - 5 Parcelas "006" - 6 Parcelas "007" - 7 Parcelas "010" - 10 Parcelas "012" - 12 Parcelas "024" - 24 Parcelas "036" - 36 Parcelas "048" - 48 Parcelas "S01" - 30/60 "S02" - 45/60 "S03" - 21/28/35 "S04" - 21/28/35/42 "S05" - 28/35/42 "S06" - 28/35/42/49 "S07" - 30/45/60/75/90 "S08" - 25/56 "S09" - 30/45 "S10" - 28/56 "S11" - 10/30/60 "S12" - 15/30/60 "S13" - 28/35 "S14" - 7/14/21 "S15" - 10/30/60/90 "S16" - 60/90/120 "S17" - 45/60/90 "S18" - 30/60/90 "S19" - 14/21 "S20" - 7/14 "S21" - 14/21/28 "S22" - 45/75 "S23" - 30/45/60 "S24" - 3/20/40 "S25" - 30/60/90/120 "S26" - 21/28 "S27" - a Vista/15 "S28" - a Vista/30 "S29" - a Vista/30/60 "S30" - a Vista/30/60/90 "S31" - a Vista/30/60/90/120/150 "S41" - 28/42/56 "S32" - 15/45/75 "S33" - 14/28/42 "S34" - 14/21/28/35/42 "S35" - 30/42/54/66/78/90 "S36" - 14/21/28/35 "S37" - 28/42 "S38" - 30/45/60 "S39" - 35/42/49/56 "S40" - 28/42/56/70 "S42" - 30/40/50/60 "S43" - 30/50/70/90 "S44" - 14/28 "S45" - 45/60/75/90 "S46" - a Vista/30/60/90/120 "S47" - a vista/20/40/60 "S48" - 21/42 "S49" - 15/30/45 "S50" - 14/42 "S51" - 21/35 "S52" - 28/56/84 "S53" - 28/42/56/70/84 "S54" - a Vista/30/45 "S55" - 21/45 "S56" - a Vista/28 "S57" - a Vista/60/90 "S58" - 35/45/55 "S59" - 28/35/42/56 "S60" - 30/45/60/75 "S61" - 28/35/42/49/56 "S62" - 40/70/100 "S63" - 42/56 "S64" - a Vista/28/35 "S65" - 35/42 "S66" - 20/40 "S67" - a Vista/28/35/42 |
osCadastro[].Cabecalho.cDescParc | texto | Descrição da parcela. Utilizado apenas para retorno do método "ConsultarOS". |
osCadastro[].Cabecalho.cEtapa | texto | Código da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar |
osCadastro[].Cabecalho.cNumOS | texto | Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente) |
osCadastro[].Cabecalho.dDtPrevisao | texto | Data de Previsão |
osCadastro[].Cabecalho.nCodCli | número inteiro | Código do Cliente |
osCadastro[].Cabecalho.nCodCtr | número inteiro | Código do Contrato. Ao informar esse campo será incluído ao contrato uma Ordem de Serviço adicional. Utilizado somente na Inclusão/Alteração. Utilize a tag "nCodCtr" do método "ListarContrato" da API /api/v1/servicos/contrato/ para obter essa informação |
osCadastro[].Cabecalho.nCodOS | número inteiro | Código da Ordem de Serviço |
osCadastro[].Cabecalho.nCodVend | número inteiro | Código do Vendedor |
osCadastro[].Cabecalho.nQtdeParc | número inteiro | Quantidade de Parcelas |
osCadastro[].Cabecalho.nValorTotal | decimal | Valor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente. |
osCadastro[].Cabecalho.nValorTotalImpRet | decimal | Valor Total de Impostos Retidos |
osCadastro[].Caracteristicas | lista de objetos | Características da Ordem de Serviço. |
osCadastro[].Caracteristicas[].cConteudo | texto | Conteúdo da Característica. |
osCadastro[].Caracteristicas[].cNome | texto | Nome da característica. |
osCadastro[].Caracteristicas[].nIdCampo | número inteiro | Id do campo característica. |
osCadastro[].Caracteristicas[].nIdCaracteristica | número inteiro | ID da Característica. |
osCadastro[].Departamentos | lista de objetos | Dados da Aba "Departamentos" do Pedido de Venda. |
osCadastro[].Departamentos[].cCodDepto | texto | ID do Departamento. Informação localizada na Aba "Departamentos" do Pedido de Venda. Utilize a tag "codigo" do método "ListarDepatartamentos" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação. |
osCadastro[].Departamentos[].nPerc | decimal | Percentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
osCadastro[].Departamentos[].nValor | decimal | Valor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda. |
osCadastro[].Departamentos[].nValorFixo | texto | Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda. |
osCadastro[].Email | objeto | |
osCadastro[].Email.cEnvBoleto | texto | Enviar ao cliente e-mail com os Boletos de Cobrança gerados pelo faturamento. É permitido somente o preenchimento de uma das tags "cEnvPix" ou "cEnvBoleto". |
osCadastro[].Email.cEnvLink | texto | Enviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida. |
osCadastro[].Email.cEnvPix | texto | Enviar ao cliente e-mail com o PIX de Cobrança gerado pelo faturamento. É permitido somente o preenchimento de uma das tags "cEnvPix" ou "cEnvBoleto". |
osCadastro[].Email.cEnvRecibo | texto | Enviar um recibo de prestação de serviços (ao invés da NFS-e) |
osCadastro[].Email.cEnvViaUnica | texto | Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não |
osCadastro[].Email.cEnviarPara | texto | Utilizar os seguintes endereços de e-mail |
osCadastro[].InfoCadastro | objeto | Informações do cadastro da Ordem de Serviço. |
osCadastro[].InfoCadastro.cAmbiente | texto | Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção |
osCadastro[].InfoCadastro.cCancelada | texto | Ordem de Serviço cancelada? |
osCadastro[].InfoCadastro.cFaturada | texto | Ordem de Serviço faturada com sucesso? |
osCadastro[].InfoCadastro.cHrAlt | texto | Hora de Alteração da Ordem de Serviço |
osCadastro[].InfoCadastro.cHrCanc | texto | Hora do Cancelamento |
osCadastro[].InfoCadastro.cHrFat | texto | Hora do Faturamento |
osCadastro[].InfoCadastro.cHrInc | texto | Hora de inclusão da Ordem de Serviço |
osCadastro[].InfoCadastro.cOrigem | texto | Origem da Ordem de Serviço |
osCadastro[].InfoCadastro.dDtAlt | texto | Data de Alteração da Ordem de Serviço |
osCadastro[].InfoCadastro.dDtCanc | texto | Data de Cancelamento |
osCadastro[].InfoCadastro.dDtFat | texto | Data de Faturamento |
osCadastro[].InfoCadastro.dDtInc | texto | Data de Inclusão da Ordem de Serviço |
osCadastro[].InfoCadastro.uAlt | texto | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
osCadastro[].InfoCadastro.uInc | texto | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
osCadastro[].InformacoesAdicionais | objeto | |
osCadastro[].InformacoesAdicionais.DetalhesNfse | objeto | Detalhes da NFSE. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos | objeto | Evento na Nfse. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cBairroEvento | texto | Bairro do Evento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCepEvento | texto | CEP do Evento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeEvento | texto | Código da Cidade da Prestação de Serviços. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeExtEvento | texto | Cidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como "S". |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCodAtivEvento | texto | Código de Atividade do evento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCodPaisEvento | texto | Código do país do evento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cComplEvento | texto | Completo do endereço do evento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cEndEvento | texto | Endereço do envento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cEndExtEvento | texto | Endereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como "S". |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cExtEvento | texto | Evento no Exterior S/N. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cNomeEvento | texto | Nome do evento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cNumEndEvento | texto | Número do endereço do evento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cUfEvento | texto | Estado do evento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.dDtFimEvento | texto | Data Final do Evento. |
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.dDtIniEvento | texto | Data de Início do Evento. |
osCadastro[].InformacoesAdicionais.cCidPrestServ | texto | Cidade da Prestação do Serviço |
osCadastro[].InformacoesAdicionais.cCodART | texto | Código ART |
osCadastro[].InformacoesAdicionais.cCodCateg | texto | Categoria |
osCadastro[].InformacoesAdicionais.cCodObra | texto | Código da Obra |
osCadastro[].InformacoesAdicionais.cContato | texto | Contato |
osCadastro[].InformacoesAdicionais.cDadosAdicNF | texto | Dados Adicionais da Nota Fiscal |
osCadastro[].InformacoesAdicionais.cNumContrato | texto | Número do Contrato de Venda |
osCadastro[].InformacoesAdicionais.cNumPedido | texto | Número do Pedido do Cliente |
osCadastro[].InformacoesAdicionais.cNumRecibo | texto | Número do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado). |
osCadastro[].InformacoesAdicionais.cUsoConsumo | texto | Uso e consumo pessoal. |
osCadastro[].InformacoesAdicionais.dDataRps | texto | Data da RPS |
osCadastro[].InformacoesAdicionais.nCodCC | número inteiro | Código da Conta Corrente |
osCadastro[].InformacoesAdicionais.nCodProj | número inteiro | Código do Projeto |
osCadastro[].InformacoesAdicionais.nIdDestinatario | número inteiro | ID Cliente para o Destinatário. |
osCadastro[].Observacoes | objeto | |
osCadastro[].Observacoes.cObsOS | texto | Observações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal). |
osCadastro[].Parcelas | lista de objetos | Permite que o parcelamento seja realizado de forma manual. |
osCadastro[].Parcelas[].categoria_adiantamento | texto | Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
osCadastro[].Parcelas[].conta_corrente_adiantamento | número inteiro | Conta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
osCadastro[].Parcelas[].dDtVenc | texto | Data de Vencimento da parcela. Ex: 01/02/2016 |
osCadastro[].Parcelas[].meio_pagamento | texto | Meio de Pagamento - Utilizado apenas para emissão de NFS-e (campo "tPag" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba "Parcelas" da Ordem de Serviço. Caso informado na estrutura "informacoes_adicionais" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura "parcela". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/ |
osCadastro[].Parcelas[].nDias | número inteiro | Número de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias. |
osCadastro[].Parcelas[].nParcela | número inteiro | Número da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2. |
osCadastro[].Parcelas[].nPercentual | decimal | Percentual do valor da parcela. |
osCadastro[].Parcelas[].nValor | decimal | Valor da Parcela. Ex: 100.23 |
osCadastro[].Parcelas[].nao_gerar_boleto | texto | Não gerar boleto para esta parcela ao emitir a nota fiscal. Informe "S" para não gerar o boleto. O padrão é "N". Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
osCadastro[].Parcelas[].nsu | texto | Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. |
osCadastro[].Parcelas[].parcela_adiantamento | texto | Está é uma parcela de Adiantamento do Cliente. Informe "S" para indicar que é uma parcela de adiantamento. O padrão é "N". Informação localizada na Aba "Parcelas" da Ordem de Serviço. |
osCadastro[].Parcelas[].tipo_documento | texto | Tipo de Documento. Informação localizada na Aba "Parcelas" da Ordem de Serviço. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa disponível na API: /api/v1/ger |
osCadastro[].ServicosPrestados | lista de objetos | Item da Ordem serviço |
osCadastro[].ServicosPrestados[].DeducoesIss | lista de objetos | Informe aqui as Deduções para o ISS. |
osCadastro[].ServicosPrestados[].DeducoesIss[].cCnpjFornecedor | texto | CPF ou CNPJ do Fornecedor |
osCadastro[].ServicosPrestados[].DeducoesIss[].cDescMateriais | texto | Descrição do material. |
osCadastro[].ServicosPrestados[].DeducoesIss[].cFormaDeducao | texto | Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor. |
osCadastro[].ServicosPrestados[].DeducoesIss[].cNFReferencia | texto | Nota Fiscal de Referência. |
osCadastro[].ServicosPrestados[].DeducoesIss[].cTipoDeduducao | texto | Tipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada |
osCadastro[].ServicosPrestados[].DeducoesIss[].nPercDeducao | decimal | Percentual de dedução. |
osCadastro[].ServicosPrestados[].DeducoesIss[].nQuantMateriais | decimal | Quantidade de Material |
osCadastro[].ServicosPrestados[].DeducoesIss[].nValorDeducao | decimal | Valor da Dedução. |
osCadastro[].ServicosPrestados[].DeducoesIss[].nValorTotNfRef | decimal | Valor total NF de Referência |
osCadastro[].ServicosPrestados[].cAcaoItem | texto | Ação a ser realizada na alteração do item. Pode ser: "A" - Alterar o item (padrão). "E" - Excluir o item. "I" - Incluir o item na alteração. |
osCadastro[].ServicosPrestados[].cCodCategItem | texto | Código da Categoria. |
osCadastro[].ServicosPrestados[].cCodIntServico | texto | Código de Integração 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. |
osCadastro[].ServicosPrestados[].cCodServLC116 | texto | Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag "nCodServico" 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. |
osCadastro[].ServicosPrestados[].cCodServMun | texto | Código do Serviço Municipal ou CNAE. Caso tenha informado a tag "nCodServico" 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. |
osCadastro[].ServicosPrestados[].cCodigo | texto | Código do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. |
osCadastro[].ServicosPrestados[].cDadosAdicItem | texto | Dados adicionais do Item. |
osCadastro[].ServicosPrestados[].cDescServ | texto | Descrição dos Serviços. Caso tenha informado a tag "nCodServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
osCadastro[].ServicosPrestados[].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. |
osCadastro[].ServicosPrestados[].cNbs | texto | Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag "nCodServico" irá assumir o valor informado no cadastro do respectivo serviço. |
osCadastro[].ServicosPrestados[].cReembolso | texto | Identificação se o item é despesa reembolsável. |
osCadastro[].ServicosPrestados[].cRetemISS | texto | Retem ISS (S/N) |
osCadastro[].ServicosPrestados[].cTpDesconto | texto | Tipo de Desconto. Pode ser: P - Percentual V - Valor |
osCadastro[].ServicosPrestados[].cTribServ | texto | Tipo de Tributação dos Serviços. Caso tenha informado a tag "nCodServico" 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. |
osCadastro[].ServicosPrestados[].impostos | objeto | Dados do impostos do serviço. |
osCadastro[].ServicosPrestados[].impostos.cCST | 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. |
osCadastro[].ServicosPrestados[].impostos.cClassTrib | 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. |
osCadastro[].ServicosPrestados[].impostos.cFixarCOFINS | texto | 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. |
osCadastro[].ServicosPrestados[].impostos.cFixarCSLL | texto | 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. |
osCadastro[].ServicosPrestados[].impostos.cFixarINSS | texto | 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. |
osCadastro[].ServicosPrestados[].impostos.cFixarIRRF | texto | 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. |
osCadastro[].ServicosPrestados[].impostos.cFixarISS | texto | 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. |
osCadastro[].ServicosPrestados[].impostos.cFixarPIS | texto | 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. |
osCadastro[].ServicosPrestados[].impostos.cIndOPer | 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. |
osCadastro[].ServicosPrestados[].impostos.cManCbs | 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. |
osCadastro[].ServicosPrestados[].impostos.cManIbsMun | 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. |
osCadastro[].ServicosPrestados[].impostos.cManIbsUf | 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. |
osCadastro[].ServicosPrestados[].impostos.cRetemCOFINS | texto | Retém COFINS (S/N). Indica se o imposto deve ser retido ou não. |
osCadastro[].ServicosPrestados[].impostos.cRetemCSLL | texto | Retém CSLL (S/N). Indica se o imposto deve ser retido ou não. |
osCadastro[].ServicosPrestados[].impostos.cRetemINSS | texto | Retém INSS (S/N). Indica se o imposto deve ser retido ou não. |
osCadastro[].ServicosPrestados[].impostos.cRetemIRRF | texto | Retém IRRF (S/N). Indica se o imposto deve ser retido ou não. |
osCadastro[].ServicosPrestados[].impostos.cRetemPIS | texto | Retém PIS (S/N). Indica se o imposto deve ser retido ou não. |
osCadastro[].ServicosPrestados[].impostos.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. |
osCadastro[].ServicosPrestados[].impostos.lDeduzISS | sim/não | Deduz o ISS da Base de Cálculo de PIS e COFINS |
osCadastro[].ServicosPrestados[].impostos.nAliqCOFINS | 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. |
osCadastro[].ServicosPrestados[].impostos.nAliqCSLL | 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. |
osCadastro[].ServicosPrestados[].impostos.nAliqCbs | 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. |
osCadastro[].ServicosPrestados[].impostos.nAliqEstadualIBPT | decimal | Alíquota da Carga Tribut. Aproximada Estadual. |
osCadastro[].ServicosPrestados[].impostos.nAliqFederalIBPT | decimal | Alíquota da Carga Tribut. Aproximada Federal. |
osCadastro[].ServicosPrestados[].impostos.nAliqINSS | 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. |
osCadastro[].ServicosPrestados[].impostos.nAliqIRRF | decimal | Alíquota de IRRF. 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. |
osCadastro[].ServicosPrestados[].impostos.nAliqISS | decimal | Alíquota de ISS. |
osCadastro[].ServicosPrestados[].impostos.nAliqIbsMun | decimal | 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. |
osCadastro[].ServicosPrestados[].impostos.nAliqIbsUf | 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. |
osCadastro[].ServicosPrestados[].impostos.nAliqMunicipalIBPT | decimal | Alíquota da Carga Tribut. Aproximada Municipal. |
osCadastro[].ServicosPrestados[].impostos.nAliqPIS | 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. |
osCadastro[].ServicosPrestados[].impostos.nAliqRedBaseCOFINS | decimal | Percentual de Redução da Base de Cálculo do COFINS. |
osCadastro[].ServicosPrestados[].impostos.nAliqRedBaseINSS | decimal | Percentual de Redução da Base de Cálculo do INSS. |
osCadastro[].ServicosPrestados[].impostos.nAliqRedBasePIS | decimal | Percentual de Redução da Base de Cálculo do PIS. |
osCadastro[].ServicosPrestados[].impostos.nBaseCalcIbsCbs | decimal | Valor da Base de Calculo do IBS e 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. |
osCadastro[].ServicosPrestados[].impostos.nBaseISS | decimal | Base de Cálculo do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
osCadastro[].ServicosPrestados[].impostos.nPercReducaoCbs | 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. |
osCadastro[].ServicosPrestados[].impostos.nPercReducaoIbsMun | 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. |
osCadastro[].ServicosPrestados[].impostos.nPercReducaoIbsUf | 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. |
osCadastro[].ServicosPrestados[].impostos.nTotDeducao | decimal | Valor de Dedução da Base de Cálculo. Por padrão, esse campo afeta a Base de Cálculo do ISS. Para atender a condições legais acordadas para cada munícipio pode afetar as Bases de Cálculos dos Impostos Federais também. Consulte a legislação do seu município. |
osCadastro[].ServicosPrestados[].impostos.nValorCOFINS | decimal | Valor do COFINS. 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. |
osCadastro[].ServicosPrestados[].impostos.nValorCSLL | 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. |
osCadastro[].ServicosPrestados[].impostos.nValorCbs | 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. |
osCadastro[].ServicosPrestados[].impostos.nValorDeducao | decimal | Valor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem. |
osCadastro[].ServicosPrestados[].impostos.nValorDeducaoIRRF | decimal | Valor da dedução da base do IR. |
osCadastro[].ServicosPrestados[].impostos.nValorINSS | 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. |
osCadastro[].ServicosPrestados[].impostos.nValorIRRF | decimal | Valor do IRRF. 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. |
osCadastro[].ServicosPrestados[].impostos.nValorISS | decimal | Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração. |
osCadastro[].ServicosPrestados[].impostos.nValorIbsMun | 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. |
osCadastro[].ServicosPrestados[].impostos.nValorIbsUf | 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. |
osCadastro[].ServicosPrestados[].impostos.nValorPIS | 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. |
osCadastro[].ServicosPrestados[].nAliqDesconto | decimal | Aliquota do Desconto. |
osCadastro[].ServicosPrestados[].nCodServico | 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. |
osCadastro[].ServicosPrestados[].nIdItem | número inteiro | ID do Item da Ordem de Serviço. Não deve ser informado na inclusão. Pode ser informado na alteração para identificar o item. |
osCadastro[].ServicosPrestados[].nQtde | decimal | Quantidade de serviços. |
osCadastro[].ServicosPrestados[].nSeqItem | número inteiro | Sequencia do Item Deve ser preenchido com uma sequencia de 1 a 199. |
osCadastro[].ServicosPrestados[].nValUnit | decimal | Valor Unitário do serviço. Caso tenha informado a tag "nCodServico" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. |
osCadastro[].ServicosPrestados[].nValorAcrescimos | decimal | Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.) |
osCadastro[].ServicosPrestados[].nValorDesconto | decimal | Valor do Desconto. |
osCadastro[].ServicosPrestados[].nValorOutrasRetencoes | decimal | Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.) |
osCadastro[].ServicosPrestados[].viaUnica | objeto | Informações referente ao serviço de NF modelo 21 ou 22. |
osCadastro[].ServicosPrestados[].viaUnica.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. |
osCadastro[].ServicosPrestados[].viaUnica.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. |
osCadastro[].ServicosPrestados[].viaUnica.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 |
osCadastro[].ServicosPrestados[].viaUnica.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 |
osCadastro[].ServicosPrestados[].viaUnica.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. |
osCadastro[].Tarefas | lista de objetos | Lista com as tarefas relacionadas a ordem de serviço. Retornado apenas no método de consulta e quando preenchida a tag "cIncluirTarefas" como "S". |
osCadastro[].Tarefas[].cCodIntTarefa | texto | |
osCadastro[].Tarefas[].cDescricao | texto | Descrição da tarefa. |
osCadastro[].Tarefas[].cNomeUserAtb | texto | |
osCadastro[].Tarefas[].dData | texto | |
osCadastro[].Tarefas[].hHora | texto | |
osCadastro[].Tarefas[].nCodDoc | número inteiro | Id do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for "pedido-compra", esse campo reflete o código do pedido de compra. Se a origem da tarefa for "contas-receber", esse campo reflete o código da conta a receber. |
osCadastro[].Tarefas[].nCodTarefa | número inteiro | Código único da tarefa. |
osCadastro[].Tarefas[].nCodUserAtb | número inteiro | Código do usuário atribuído. |
osCadastro[].despesasReembolsaveis | objeto | Despesas reembolsáveis. |
osCadastro[].despesasReembolsaveis.cCodCategReemb | texto | Código da categoria para reembolso |
osCadastro[].despesasReembolsaveis.despesaReembolsavel | lista de objetos | Despesa reembolsável |
osCadastro[].despesasReembolsaveis.despesaReembolsavel[].cAcaoReemb | texto | Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração. |
osCadastro[].despesasReembolsaveis.despesaReembolsavel[].cDescReemb | texto | Descrição da despesa. |
osCadastro[].despesasReembolsaveis.despesaReembolsavel[].dDataReemb | texto | Data da despesa. |
osCadastro[].despesasReembolsaveis.despesaReembolsavel[].nCodReemb | número inteiro | ID do Reembolso. (Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão). Esse código não aparece na tela do Omie. Utilize esse código para identificar a despesa via API. |
osCadastro[].despesasReembolsaveis.despesaReembolsavel[].nValorReemb | decimal | Valor da despesa. |
osCadastro[].produtosUtilizados | objeto | Produtos Utilizados na Ordem de Serviço. |
osCadastro[].produtosUtilizados.cAcaoProdUtilizados | texto | Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. Obrigatório na inclusão. |
osCadastro[].produtosUtilizados.cCodCategRem | texto | Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED' |
osCadastro[].produtosUtilizados.produtoUtilizado | lista de objetos | rodutos utilizados no serviço. |
osCadastro[].produtosUtilizados.produtoUtilizado[].cAcaoItemPU | texto | Pode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração. |
osCadastro[].produtosUtilizados.produtoUtilizado[].codigo_local_estoque | número inteiro | Código do Local do Estoque. |
osCadastro[].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. |
osCadastro[].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.. |
osCadastro[].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. |
osCadastro[].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. |
osCadastro[].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. |
osCadastro[].produtosUtilizados.produtoUtilizado[].nQtdePU | decimal | Quantidade. |
pagina | número inteiro | |
registros | número inteiro | |
total_de_paginas | número inteiro | |
total_de_registros | número inteiro |
POST /api/v1/servicos/os/
curl -s https://app.omie.com.br/api/v1/servicos/os/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarOS", "param": [{"pagina": 1, "registros_por_pagina": 50, "apenas_importado_api": "N"}]}'import os
import requests
corpo = {'call': 'ListarOS',
'param': [{'pagina': 1, 'registros_por_pagina': 50, 'apenas_importado_api': 'N'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/os/",
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/os/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarOS",
"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/os/");
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": "ListarOS",
"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/os/")
corpo = <<~'JSON'
{
"call": "ListarOS",
"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": "ListarOS",
"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/os/"))
.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/os/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarOS"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 50, ""apenas_importado_api"": ""N""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRetorna o Status da Ordem de Serviço
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 7Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntOS | texto · até 60 | Código de Integração da Ordem de Serviço |
lMsg | sim/não | Retornar todas mensagens de comunicação com a prefeitura (S/N). Quando preenchido com "N" ou não preenchido, vamos devolver apenas as mensagens com erro. Quando preenchido com "S", vamos devolver todas as mensagens de comunicação com a prefeitura. O padrão é "N". |
lPdfDemo | sim/não | Exibir a Url do PDF do Demonstrativo da NFS-e. Pode ser: true false O padrão é false. |
lPdfDest | sim/não | Exibir a Url do PDF do Destinatário da NFS-e. Pode ser: true false O padrão é false. |
lPdfRecibo | sim/não | Exibir a Url do Recibo. Pode ser: true false O padrão é false. |
lRps | sim/não | Exibir a Url da RPS. Pode ser: true false O padrão é false. |
nCodOS | número inteiro | ID da Ordem de Serviço (Código interno) |
Retorno 21O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
ListaRpsNfse | lista de objetos | Lista de RPS geradas para a Ordem de Serviço |
ListaRpsNfse[].cCNPJ | texto | CNPJ do Prestador |
ListaRpsNfse[].cCodVerif | texto | Código de Verificação da NFS-e gerada. |
ListaRpsNfse[].cInscrMunicipal | número inteiro | Inscrição Municipal do Prestador |
ListaRpsNfse[].cProtocolo | texto | Número do protocolo do envio do lote. |
ListaRpsNfse[].cStatusLote | texto | Código do status do lote enviado para a prefeitura. Pode ser: 001 - Aguardando envio para a prefeitura. 002 - Enviado para a prefeitura, aguardando processamento. 003 - Processado com erro. 004 - Processado com sucesso. 005 - Cancelado com sucesso. |
ListaRpsNfse[].cStatusRps | texto | Código do status da RPS. Pode ser: 001 - Aguardando envio para a prefeitura. 002 - Enviado para a prefeitura, aguardando processamento. 003 - Processado com erro. 004 - Processado com sucesso. 005 - Cancelado com sucesso. |
ListaRpsNfse[].cUrlNfse | texto | Link para obter a NFS-e na prefeitura. |
ListaRpsNfse[].cUrlPdfDemo | texto | Link para obter o PDF do Demonstrativo da NFS-e. |
ListaRpsNfse[].cUrlPdfDest | texto | Link para obter o PDF da nota do Destinatário. |
ListaRpsNfse[].cUrlRps | texto | Link para obter a RPS. |
ListaRpsNfse[].danfe | texto | Link para o DANFE da NF-e gerada. |
ListaRpsNfse[].mensagens | lista de objetos | Mensagens de comunicação com a Prefeitura |
ListaRpsNfse[].mensagens[].cAnexo | texto | Indica se a mensagem tem algum anexo (S/N). Esse campo só é retornado quando a tag "lMsg" enviada na request é true. |
ListaRpsNfse[].mensagens[].cCodigo | texto | Código da mensagem de Erro/Aviso |
ListaRpsNfse[].mensagens[].cCorrecao | texto | Correção da descrição de mensagem de erro/aviso. |
ListaRpsNfse[].mensagens[].cDescricao | texto | Descrição da mensagem de erro/aviso. |
ListaRpsNfse[].mensagens[].cSituacao | texto | Situação da mensagem. Pode ser: ERRO ALERTA SUCESSO Esse campo só é retornado quando a tag "lMsg" enviada na request é true. |
ListaRpsNfse[].mensagens[].cUsuario | texto | Usuário vinculado a mensagem. Esse campo só é retornado quando a tag "lMsg" enviada na request é true. |
ListaRpsNfse[].mensagens[].dData | texto | Data da mensagem. Esse campo só é retornado quando a tag "lMsg" enviada na request é true. |
ListaRpsNfse[].mensagens[].hHora | texto | Hora da mensagem. Esse campo só é retornado quando a tag "lMsg" enviada na request é true. |
ListaRpsNfse[].nLote | número inteiro | Número do Lote de Envio da RPS |
ListaRpsNfse[].nNfse | texto | Número da NFS-e gerada. |
ListaRpsNfse[].nRps | texto | Número do Recibo Provisório de Serviços (RPS). |
ListaRpsNfse[].xml_distr | texto | XML de distribuição da NF-e |
cAmbiente | texto | Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção |
cCancelada | texto | Ordem de Serviço cancelada? |
cCodIntOS | texto | Código de Integração da Ordem de Serviço (para OS geradas via API, a partir de outros aplicativos) |
cEtapa | texto | Etapa da Ordem de Serviço |
cFaturada | texto | Ordem de Serviço faturada com sucesso? |
cHrAlt | texto | Hora de Alteração da Ordem de Serviço |
cHrCanc | texto | Hora do Cancelamento |
cHrFat | texto | Hora do Faturamento |
cHrInc | texto | Hora de inclusão da Ordem de Serviço |
cNumContrato | texto | Número do Contrato |
cNumOS | texto | Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente) |
cNumPedido | texto | Número do pedido do cliente. |
cNumRecibo | texto | Número do Recibo gerado. |
cUrlPdfRecibo | texto | Link para obter o PDF do Recibo. |
dDtAlt | texto | Data de Alteração da Ordem de Serviço |
dDtCanc | texto | Data de Cancelamento |
dDtFat | texto | Data de Faturamento |
dDtInc | texto | Data de Inclusão da Ordem de Serviço |
nCodOS | número inteiro | ID da Ordem de Serviço (código interno de controle). |
nValorTot | decimal | Valor da Ordem de Serviço |
POST /api/v1/servicos/os/
curl -s https://app.omie.com.br/api/v1/servicos/os/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "StatusOS", "param": [{"cCodIntOS": "", "nCodOS": 0}]}'import os
import requests
corpo = {'call': 'StatusOS', 'param': [{'cCodIntOS': '', 'nCodOS': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/os/",
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/os/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "StatusOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/os/");
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": "StatusOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/os/")
corpo = <<~'JSON'
{
"call": "StatusOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0
}
]
}
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": "StatusOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/os/"))
.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/os/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""StatusOS"", ""param"": [{""cCodIntOS"": """", ""nCodOS"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosTroca a Etapa da Ordem de Serviço.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
cEtapa | texto · até 2 | Etapa da Ordem de Serviço. Esse campo indica em que coluna a Ordem de Serviço irá figurar no processo de faturamento do Omie. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: "10" - Primeira coluna "20" - Segunda coluna "30" - Terceira coluna "40" - Quarta coluna "50" - Faturar |
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntOS | texto · até 60 | Código de integração da Ordem de Serviço. Preencha esse campo com o código da Ordem de Serviço no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Ordem de Serviço você conseguirá ver a relação entre o id da Ordem de Serviço gerada no Omie e o código da Ordem de Serviço existente em sua aplicação. |
cNumOS | texto · até 15 | Número da Ordem de Serviço. Esse é o número da Ordem de Serviço no Omie, que é gerado automaticamente e exibido na tela. |
nCodOS | número inteiro | ID da Ordem de Serviço. Esse campo não é exibido na tela da Ordem de Serviço. É uma informação interna, utilizada apenas nas APIs. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodIntOS | texto | Código de integração da Ordem de Serviço. Preencha esse campo com o código da Ordem de Serviço no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Ordem de Serviço você conseguirá ver a relação entre o id da Ordem de Serviço gerada no Omie e o código da Ordem de Serviço existente em sua aplicação. |
cNumOS | texto | Número da Ordem de Serviço. Esse é o número da Ordem de Serviço no Omie, que é gerado automaticamente e exibido na tela. |
codigo_status | texto | Código do Status do Pedido de Venda. |
descricao_status | texto | Descrição do status |
nCodOS | número inteiro | ID da Ordem de Serviço. Esse campo não é exibido na tela da Ordem de Serviço. É uma informação interna, utilizada apenas nas APIs. |
POST /api/v1/servicos/os/
curl -s https://app.omie.com.br/api/v1/servicos/os/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "TrocarEtapaOS", "param": [{"cCodIntOS": "", "nCodOS": 0, "cNumOS": "", "cEtapa": ""}]}'import os
import requests
corpo = {'call': 'TrocarEtapaOS',
'param': [{'cCodIntOS': '', 'nCodOS': 0, 'cNumOS': '', 'cEtapa': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/os/",
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/os/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "TrocarEtapaOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": "",
"cEtapa": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/os/");
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": "TrocarEtapaOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": "",
"cEtapa": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/os/")
corpo = <<~'JSON'
{
"call": "TrocarEtapaOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": "",
"cEtapa": ""
}
]
}
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": "TrocarEtapaOS",
"param": [
{
"cCodIntOS": "",
"nCodOS": 0,
"cNumOS": "",
"cEtapa": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/os/"))
.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/os/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""TrocarEtapaOS"", ""param"": [{""cCodIntOS"": """", ""nCodOS"": 0, ""cNumOS"": """", ""cEtapa"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados