OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Serviços · OrdemServico

Geração de Ordem de Serviço

POSThttps://app.omie.com.br/api/v1/servicos/os/WSDL
3consultas
4alterações
Claude 7 de 7 · ChatGPT 4 de 7 · MCP 7 de 7pelos assistentes de IA
JSON · XMLformato

AlterarOS

altera dadosClaudeChatGPTMCP

Operação para alterar uma Ordem de Serviço.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 12Campos e estruturas que você pode enviar
CampoTipoDescrição
CabecalhoobjetoCabeçalho da Ordem de Serviço
Cabecalho.cCodIntClitexto · até 60Código de Integração do Cliente
Cabecalho.cCodIntOStexto · até 60Código de Integração da OS. Obrigatório na inclusão.
Cabecalho.cCodParctexto · até 3Có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.cDescParctexto · até 30Descrição da parcela. Utilizado apenas para retorno do método "ConsultarOS".
Cabecalho.cEtapatexto · até 2Código da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar
Cabecalho.cNumOStexto · até 15Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente)
Cabecalho.dDtPrevisaotexto · até 10Data de Previsão
Cabecalho.nCodClinúmero inteiroCódigo do Cliente
Cabecalho.nCodCtrnúmero inteiroCó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.nCodOSnúmero inteiroCódigo da Ordem de Serviço
Cabecalho.nCodVendnúmero inteiroCódigo do Vendedor
Cabecalho.nQtdeParcnúmero inteiroQuantidade de Parcelas
Cabecalho.nValorTotalnúmeroValor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente.
Cabecalho.nValorTotalImpRetnúmeroValor Total de Impostos Retidos
Caracteristicaslista de objetosCaracterísticas da Ordem de Serviço.
Caracteristicas[].cConteudotexto · até 7000Conteúdo da Característica.
Caracteristicas[].cNometexto · até 70Nome da característica.
Caracteristicas[].nIdCamponúmero inteiroId do campo característica.
Caracteristicas[].nIdCaracteristicanúmero inteiroID da Característica.
Departamentoslista de objetosDados da Aba "Departamentos" do Pedido de Venda.
Departamentos[].cCodDeptotexto · até 40ID 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[].nPercnúmeroPercentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
Departamentos[].nValornúmeroValor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
Departamentos[].nValorFixotexto · até 1Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda.
Emailobjeto
Email.cEnvBoletotexto · até 1Enviar 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.cEnvLinktexto · até 1Enviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida.
Email.cEnvPixtexto · até 1Enviar 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.cEnvRecibotexto · até 1Enviar um recibo de prestação de serviços (ao invés da NFS-e)
Email.cEnvViaUnicatexto · até 1Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não
Email.cEnviarParatextoUtilizar os seguintes endereços de e-mail
InfoCadastroobjetoInformações do cadastro da Ordem de Serviço.
InfoCadastro.cAmbientetexto · até 1Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção
InfoCadastro.cCanceladatexto · até 1Ordem de Serviço cancelada?Ex.: S, N
InfoCadastro.cFaturadatexto · até 1Ordem de Serviço faturada com sucesso?Ex.: S, N
InfoCadastro.cHrAlttexto · até 8Hora de Alteração da Ordem de Serviço
InfoCadastro.cHrCanctexto · até 8Hora do Cancelamento
InfoCadastro.cHrFattexto · até 8Hora do Faturamento
InfoCadastro.cHrInctexto · até 8Hora de inclusão da Ordem de Serviço
InfoCadastro.cOrigemtexto · até 3Origem da Ordem de Serviço
InfoCadastro.dDtAlttexto · até 10Data de Alteração da Ordem de Serviço
InfoCadastro.dDtCanctexto · até 10Data de Cancelamento
InfoCadastro.dDtFattexto · até 10Data de Faturamento
InfoCadastro.dDtInctexto · até 10Data de Inclusão da Ordem de Serviço
InfoCadastro.uAlttexto · até 10Usuário da Alteração. Não deve ser informado na Inclusão/Alteração.
InfoCadastro.uInctexto · até 10Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
InformacoesAdicionaisobjeto
InformacoesAdicionais.DetalhesNfseobjetoDetalhes da NFSE.
InformacoesAdicionais.DetalhesNfse.EventosobjetoEvento na Nfse.
InformacoesAdicionais.DetalhesNfse.Eventos.cBairroEventotexto · até 60Bairro do Evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cCepEventotexto · até 10CEP do Evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeEventotexto · até 40Código da Cidade da Prestação de Serviços.
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeExtEventotexto · até 60Cidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como "S".
InformacoesAdicionais.DetalhesNfse.Eventos.cCodAtivEventotexto · até 30Código de Atividade do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cCodPaisEventotexto · até 4Código do país do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cComplEventotexto · até 40Completo do endereço do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cEndEventotexto · até 60Endereço do envento.
InformacoesAdicionais.DetalhesNfse.Eventos.cEndExtEventotexto · até 255Endereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como "S".
InformacoesAdicionais.DetalhesNfse.Eventos.cExtEventotexto · até 1Evento no Exterior S/N.
InformacoesAdicionais.DetalhesNfse.Eventos.cNomeEventotexto · até 60Nome do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cNumEndEventotexto · até 10Número do endereço do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cUfEventotexto · até 2Estado do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.dDtFimEventotextoData Final do Evento.
InformacoesAdicionais.DetalhesNfse.Eventos.dDtIniEventotextoData de Início do Evento.
InformacoesAdicionais.cCidPrestServtexto · até 40Cidade da Prestação do Serviço
InformacoesAdicionais.cCodARTtexto · até 20Código ART
InformacoesAdicionais.cCodCategtexto · até 20Categoria
InformacoesAdicionais.cCodObratexto · até 15Código da Obra
InformacoesAdicionais.cContatotexto · até 100Contato
InformacoesAdicionais.cDadosAdicNFtextoDados Adicionais da Nota Fiscal
InformacoesAdicionais.cNumContratotexto · até 20Número do Contrato de Venda
InformacoesAdicionais.cNumPedidotexto · até 30Número do Pedido do Cliente
InformacoesAdicionais.cNumRecibotexto · até 10Número do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado).
InformacoesAdicionais.cUsoConsumotexto · até 1Uso e consumo pessoal.
InformacoesAdicionais.dDataRpstexto · até 10Data da RPS
InformacoesAdicionais.nCodCCnúmero inteiroCódigo da Conta Corrente
InformacoesAdicionais.nCodProjnúmero inteiroCódigo do Projeto
InformacoesAdicionais.nIdDestinatarionúmero inteiroID Cliente para o Destinatário.
Observacoesobjeto
Observacoes.cObsOStextoObservações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal).
Parcelaslista de objetosPermite que o parcelamento seja realizado de forma manual.
Parcelas[].categoria_adiantamentotexto · até 20Có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_adiantamentonúmero inteiroConta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" da Ordem de Serviço.
Parcelas[].dDtVenctexto · até 10Data de Vencimento da parcela. Ex: 01/02/2016
Parcelas[].meio_pagamentotexto · até 100Meio 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órionúmero inteiroNúmero de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias.
Parcelas[].nParcelaobrigatórionúmero inteiroNúmero da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2.
Parcelas[].nPercentualnúmeroPercentual do valor da parcela.
Parcelas[].nValornúmeroValor da Parcela. Ex: 100.23
Parcelas[].nao_gerar_boletotexto · até 1Nã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[].nsutexto · até 100Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico.
Parcelas[].parcela_adiantamentotexto · até 1Está é 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_documentotexto · até 5Tipo 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
ServicosPrestadoslista de objetosItem da Ordem serviço
ServicosPrestados[].DeducoesIsslista de objetosInforme aqui as Deduções para o ISS.
ServicosPrestados[].DeducoesIss[].cCnpjFornecedortexto · até 20CPF ou CNPJ do Fornecedor
ServicosPrestados[].DeducoesIss[].cDescMateriaistexto · até 100Descrição do material.
ServicosPrestados[].DeducoesIss[].cFormaDeducaotexto · até 1Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor.
ServicosPrestados[].DeducoesIss[].cNFReferenciatexto · até 20Nota Fiscal de Referência.
ServicosPrestados[].DeducoesIss[].cTipoDeduducaotexto · até 1Tipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada
ServicosPrestados[].DeducoesIss[].nPercDeducaonúmeroPercentual de dedução.
ServicosPrestados[].DeducoesIss[].nQuantMateriaisnúmeroQuantidade de Material
ServicosPrestados[].DeducoesIss[].nValorDeducaonúmeroValor da Dedução.
ServicosPrestados[].DeducoesIss[].nValorTotNfRefnúmeroValor total NF de Referência
ServicosPrestados[].cAcaoItemtexto · até 1Açã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[].cCodCategItemtexto · até 20Código da Categoria.
ServicosPrestados[].cCodIntServicotexto · até 60Có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[].cCodServLC116texto · até 20Có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[].cCodServMuntexto · até 20Có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[].cCodigotexto · até 20Código do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.
ServicosPrestados[].cDadosAdicItemtextoDados adicionais do Item.
ServicosPrestados[].cDescServtextoDescriçã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[].cNaoGerarFinanceirotexto · até 1Não gerar conta a receber para este item. Informar "S" para não gerar movimento financeiro. Informar "N" para gerar movimento financeiro.
ServicosPrestados[].cNbstexto · até 9Có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[].cReembolsotexto · até 1Identificação se o item é despesa reembolsável.
ServicosPrestados[].cRetemISStexto · até 1Retem ISS (S/N)
ServicosPrestados[].cTpDescontotexto · até 1Tipo de Desconto. Pode ser: P - Percentual V - Valor
ServicosPrestados[].cTribServtexto · até 2Tipo 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[].impostosobjetoDados do impostos do serviço.
ServicosPrestados[].impostos.cCSTtexto · até 3Có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.cClassTribtexto · até 6Có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.cFixarCOFINStexto · até 1Indica 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.cFixarCSLLtexto · até 1Indica 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.cFixarINSStexto · até 1Indica 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.cFixarIRRFtexto · até 1Indica 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.cFixarISStexto · até 1Indica 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.cFixarPIStexto · até 1Indica 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.cIndOPertexto · até 6Có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.cManCbstexto · até 1Indica 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.cManIbsMuntexto · até 1Indica 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.cManIbsUftexto · até 1Indica 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.cRetemCOFINStexto · até 1Retém COFINS (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemCSLLtexto · até 1Retém CSLL (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemINSStexto · até 1Retém INSS (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemIRRFtexto · até 1Retém IRRF (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemPIStexto · até 1Retém PIS (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cUtilizaValorImpostotexto · até 1Indica 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.lDeduzISSsim/nãoDeduz o ISS da Base de Cálculo de PIS e COFINS
ServicosPrestados[].impostos.nAliqCOFINSobrigatórionúmeroAlí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órionúmeroAlí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.nAliqCbsnúmeroAlí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.nAliqEstadualIBPTnúmeroAlíquota da Carga Tribut. Aproximada Estadual.
ServicosPrestados[].impostos.nAliqFederalIBPTnúmeroAlíquota da Carga Tribut. Aproximada Federal.
ServicosPrestados[].impostos.nAliqINSSobrigatórionúmeroAlí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órionúmeroAlí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.nAliqISSnúmeroAlíquota de ISS.
ServicosPrestados[].impostos.nAliqIbsMunnúmeroAlí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.nAliqIbsUfnúmeroAlí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.nAliqMunicipalIBPTnúmeroAlíquota da Carga Tribut. Aproximada Municipal.
ServicosPrestados[].impostos.nAliqPISobrigatórionúmeroAlí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.nAliqRedBaseCOFINSnúmeroPercentual de Redução da Base de Cálculo do COFINS.
ServicosPrestados[].impostos.nAliqRedBaseINSSnúmeroPercentual de Redução da Base de Cálculo do INSS.
ServicosPrestados[].impostos.nAliqRedBasePISnúmeroPercentual de Redução da Base de Cálculo do PIS.
ServicosPrestados[].impostos.nBaseCalcIbsCbsnúmeroValor 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.nBaseISSnúmeroBase de Cálculo do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração.
ServicosPrestados[].impostos.nPercReducaoCbsnúmeroPercentual 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.nPercReducaoIbsMunnúmeroPercentual 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.nPercReducaoIbsUfnúmeroPercentual 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.nTotDeducaonúmeroValor 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.nValorCOFINSnúmeroValor 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.nValorCSLLnúmeroValor 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.nValorCbsnúmeroValor 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.nValorDeducaonúmeroValor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem.
ServicosPrestados[].impostos.nValorDeducaoIRRFnúmeroValor da dedução da base do IR.
ServicosPrestados[].impostos.nValorINSSnúmeroValor 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.nValorIRRFnúmeroValor 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.nValorISSnúmeroValor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração.
ServicosPrestados[].impostos.nValorIbsMunnúmeroValor 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.nValorIbsUfnúmeroValor 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.nValorPISnúmeroValor 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[].nAliqDescontonúmeroAliquota do Desconto.
ServicosPrestados[].nCodServiconúmero inteiroCó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[].nIdItemnúmero inteiroID 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[].nQtdenúmeroQuantidade de serviços.
ServicosPrestados[].nSeqItemnúmero inteiroSequencia do Item Deve ser preenchido com uma sequencia de 1 a 199.
ServicosPrestados[].nValUnitnúmeroValor 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[].nValorAcrescimosnúmeroValor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.)
ServicosPrestados[].nValorDescontonúmeroValor do Desconto.
ServicosPrestados[].nValorOutrasRetencoesnúmeroValor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.)
ServicosPrestados[].viaUnicaobjetoInformações referente ao serviço de NF modelo 21 ou 22.
ServicosPrestados[].viaUnica.cCFOPtexto · até 10Có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.cClassifServicotexto · até 4Có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.cModeloNFtexto · até 2Indica 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.cTipoReceitatexto · até 1Indicador 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.cTipoUtilizacaotexto · até 1Có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.
Tarefaslista de objetosLista 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[].cCodIntTarefatexto · até 20
Tarefas[].cDescricaotexto · até 10Descrição da tarefa.
Tarefas[].cNomeUserAtbtexto · até 800
Tarefas[].dDatatexto
Tarefas[].hHoratexto · até 5
Tarefas[].nCodDocnúmero inteiroId 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[].nCodTarefanúmero inteiroCódigo único da tarefa.
Tarefas[].nCodUserAtbnúmero inteiroCódigo do usuário atribuído.
despesasReembolsaveisobjetoDespesas reembolsáveis.
despesasReembolsaveis.cCodCategReembtexto · até 20Código da categoria para reembolso
despesasReembolsaveis.despesaReembolsavellista de objetosDespesa reembolsável
despesasReembolsaveis.despesaReembolsavel[].cAcaoReembtexto · até 1Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração.
despesasReembolsaveis.despesaReembolsavel[].cDescReembtexto · até 200Descrição da despesa.
despesasReembolsaveis.despesaReembolsavel[].dDataReembtexto · até 10Data da despesa.
despesasReembolsaveis.despesaReembolsavel[].nCodReembnúmero inteiroID 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[].nValorReembnúmeroValor da despesa.
produtosUtilizadosobjetoProdutos Utilizados na Ordem de Serviço.
produtosUtilizados.cAcaoProdUtilizadostexto · até 3Pode 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.cCodCategRemtexto · até 20Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED'
produtosUtilizados.produtoUtilizadolista de objetosrodutos utilizados no serviço.
produtosUtilizados.produtoUtilizado[].cAcaoItemPUtexto · até 1Pode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração.
produtosUtilizados.produtoUtilizado[].codigo_local_estoquenúmero inteiroCódigo do Local do Estoque.
produtosUtilizados.produtoUtilizado[].lote_validadelista de objetosInformaçõ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[].nIdLotenúmero inteiroId 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órionúmeroInforme 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[].nCodProdutoPUnúmero inteiroCódigo interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie.
produtosUtilizados.produtoUtilizado[].nIdItemPUnú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[].nQtdePUnúmeroQuantidade.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntOStextoCódigo de Integração da Ordem de Serviço
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
cNumOStextoNúmero da Ordem de Serviço (Conforme visualizada em tela pelo cliente)
nCodOSnúmero inteiroCó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}]}]}'

ConsultarOS

consultaClaudeChatGPTMCP

Consulta da Ordem de Serviço.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 5Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntOStexto · até 60Código de Integração da OS
cIncluirTarefastexto · até 1Indica 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.
cNumOStexto · até 15Número da Ordem de Serviço Conforme visualizada na tela pelo cliente.
despesasReembolsaveisobjetoDespesas reembolsáveis.
despesasReembolsaveis.cCodCategReembtexto · até 20Código da categoria para reembolso
despesasReembolsaveis.despesaReembolsavellista de objetosDespesa reembolsável
despesasReembolsaveis.despesaReembolsavel[].cAcaoReembtexto · até 1Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração.
despesasReembolsaveis.despesaReembolsavel[].cDescReembtexto · até 200Descrição da despesa.
despesasReembolsaveis.despesaReembolsavel[].dDataReembtexto · até 10Data da despesa.
despesasReembolsaveis.despesaReembolsavel[].nCodReembnúmero inteiroID 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[].nValorReembnúmeroValor da despesa.
nCodOSnúmero inteiroCódigo da Ordem de Serviço
Retorno 12O que volta numa chamada bem-sucedida
CampoTipoDescrição
CabecalhoobjetoCabeçalho da Ordem de Serviço
Cabecalho.cCodIntClitextoCódigo de Integração do Cliente
Cabecalho.cCodIntOStextoCódigo de Integração da OS. Obrigatório na inclusão.
Cabecalho.cCodParctextoCó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.cDescParctextoDescrição da parcela. Utilizado apenas para retorno do método "ConsultarOS".
Cabecalho.cEtapatextoCódigo da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar
Cabecalho.cNumOStextoNúmero da Ordem de Serviço (Conforme visualizada em tela pelo cliente)
Cabecalho.dDtPrevisaotextoData de Previsão
Cabecalho.nCodClinúmero inteiroCódigo do Cliente
Cabecalho.nCodCtrnúmero inteiroCó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.nCodOSnúmero inteiroCódigo da Ordem de Serviço
Cabecalho.nCodVendnúmero inteiroCódigo do Vendedor
Cabecalho.nQtdeParcnúmero inteiroQuantidade de Parcelas
Cabecalho.nValorTotaldecimalValor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente.
Cabecalho.nValorTotalImpRetdecimalValor Total de Impostos Retidos
Caracteristicaslista de objetosCaracterísticas da Ordem de Serviço.
Caracteristicas[].cConteudotextoConteúdo da Característica.
Caracteristicas[].cNometextoNome da característica.
Caracteristicas[].nIdCamponúmero inteiroId do campo característica.
Caracteristicas[].nIdCaracteristicanúmero inteiroID da Característica.
Departamentoslista de objetosDados da Aba "Departamentos" do Pedido de Venda.
Departamentos[].cCodDeptotextoID 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[].nPercdecimalPercentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
Departamentos[].nValordecimalValor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
Departamentos[].nValorFixotextoIndica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda.
Emailobjeto
Email.cEnvBoletotextoEnviar 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.cEnvLinktextoEnviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida.
Email.cEnvPixtextoEnviar 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.cEnvRecibotextoEnviar um recibo de prestação de serviços (ao invés da NFS-e)
Email.cEnvViaUnicatextoEnviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não
Email.cEnviarParatextoUtilizar os seguintes endereços de e-mail
InfoCadastroobjetoInformações do cadastro da Ordem de Serviço.
InfoCadastro.cAmbientetextoAmbiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção
InfoCadastro.cCanceladatextoOrdem de Serviço cancelada?
InfoCadastro.cFaturadatextoOrdem de Serviço faturada com sucesso?
InfoCadastro.cHrAlttextoHora de Alteração da Ordem de Serviço
InfoCadastro.cHrCanctextoHora do Cancelamento
InfoCadastro.cHrFattextoHora do Faturamento
InfoCadastro.cHrInctextoHora de inclusão da Ordem de Serviço
InfoCadastro.cOrigemtextoOrigem da Ordem de Serviço
InfoCadastro.dDtAlttextoData de Alteração da Ordem de Serviço
InfoCadastro.dDtCanctextoData de Cancelamento
InfoCadastro.dDtFattextoData de Faturamento
InfoCadastro.dDtInctextoData de Inclusão da Ordem de Serviço
InfoCadastro.uAlttextoUsuário da Alteração. Não deve ser informado na Inclusão/Alteração.
InfoCadastro.uInctextoUsuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
InformacoesAdicionaisobjeto
InformacoesAdicionais.DetalhesNfseobjetoDetalhes da NFSE.
InformacoesAdicionais.DetalhesNfse.EventosobjetoEvento na Nfse.
InformacoesAdicionais.DetalhesNfse.Eventos.cBairroEventotextoBairro do Evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cCepEventotextoCEP do Evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeEventotextoCódigo da Cidade da Prestação de Serviços.
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeExtEventotextoCidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como "S".
InformacoesAdicionais.DetalhesNfse.Eventos.cCodAtivEventotextoCódigo de Atividade do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cCodPaisEventotextoCódigo do país do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cComplEventotextoCompleto do endereço do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cEndEventotextoEndereço do envento.
InformacoesAdicionais.DetalhesNfse.Eventos.cEndExtEventotextoEndereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como "S".
InformacoesAdicionais.DetalhesNfse.Eventos.cExtEventotextoEvento no Exterior S/N.
InformacoesAdicionais.DetalhesNfse.Eventos.cNomeEventotextoNome do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cNumEndEventotextoNúmero do endereço do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cUfEventotextoEstado do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.dDtFimEventotextoData Final do Evento.
InformacoesAdicionais.DetalhesNfse.Eventos.dDtIniEventotextoData de Início do Evento.
InformacoesAdicionais.cCidPrestServtextoCidade da Prestação do Serviço
InformacoesAdicionais.cCodARTtextoCódigo ART
InformacoesAdicionais.cCodCategtextoCategoria
InformacoesAdicionais.cCodObratextoCódigo da Obra
InformacoesAdicionais.cContatotextoContato
InformacoesAdicionais.cDadosAdicNFtextoDados Adicionais da Nota Fiscal
InformacoesAdicionais.cNumContratotextoNúmero do Contrato de Venda
InformacoesAdicionais.cNumPedidotextoNúmero do Pedido do Cliente
InformacoesAdicionais.cNumRecibotextoNúmero do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado).
InformacoesAdicionais.cUsoConsumotextoUso e consumo pessoal.
InformacoesAdicionais.dDataRpstextoData da RPS
InformacoesAdicionais.nCodCCnúmero inteiroCódigo da Conta Corrente
InformacoesAdicionais.nCodProjnúmero inteiroCódigo do Projeto
InformacoesAdicionais.nIdDestinatarionúmero inteiroID Cliente para o Destinatário.
Observacoesobjeto
Observacoes.cObsOStextoObservações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal).
Parcelaslista de objetosPermite que o parcelamento seja realizado de forma manual.
Parcelas[].categoria_adiantamentotextoCó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_adiantamentonúmero inteiroConta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" da Ordem de Serviço.
Parcelas[].dDtVenctextoData de Vencimento da parcela. Ex: 01/02/2016
Parcelas[].meio_pagamentotextoMeio 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[].nDiasnúmero inteiroNúmero de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias.
Parcelas[].nParcelanúmero inteiroNúmero da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2.
Parcelas[].nPercentualdecimalPercentual do valor da parcela.
Parcelas[].nValordecimalValor da Parcela. Ex: 100.23
Parcelas[].nao_gerar_boletotextoNã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[].nsutextoNúmero Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico.
Parcelas[].parcela_adiantamentotextoEstá é 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_documentotextoTipo 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
ServicosPrestadoslista de objetosItem da Ordem serviço
ServicosPrestados[].DeducoesIsslista de objetosInforme aqui as Deduções para o ISS.
ServicosPrestados[].DeducoesIss[].cCnpjFornecedortextoCPF ou CNPJ do Fornecedor
ServicosPrestados[].DeducoesIss[].cDescMateriaistextoDescrição do material.
ServicosPrestados[].DeducoesIss[].cFormaDeducaotextoTipo de dedução. Informe 'P' para Percentual ou 'V' para Valor.
ServicosPrestados[].DeducoesIss[].cNFReferenciatextoNota Fiscal de Referência.
ServicosPrestados[].DeducoesIss[].cTipoDeduducaotextoTipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada
ServicosPrestados[].DeducoesIss[].nPercDeducaodecimalPercentual de dedução.
ServicosPrestados[].DeducoesIss[].nQuantMateriaisdecimalQuantidade de Material
ServicosPrestados[].DeducoesIss[].nValorDeducaodecimalValor da Dedução.
ServicosPrestados[].DeducoesIss[].nValorTotNfRefdecimalValor total NF de Referência
ServicosPrestados[].cAcaoItemtextoAçã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[].cCodCategItemtextoCódigo da Categoria.
ServicosPrestados[].cCodIntServicotextoCó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[].cCodServLC116textoCó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[].cCodServMuntextoCó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[].cCodigotextoCódigo do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.
ServicosPrestados[].cDadosAdicItemtextoDados adicionais do Item.
ServicosPrestados[].cDescServtextoDescriçã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[].cNaoGerarFinanceirotextoNão gerar conta a receber para este item. Informar "S" para não gerar movimento financeiro. Informar "N" para gerar movimento financeiro.
ServicosPrestados[].cNbstextoCó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[].cReembolsotextoIdentificação se o item é despesa reembolsável.
ServicosPrestados[].cRetemISStextoRetem ISS (S/N)
ServicosPrestados[].cTpDescontotextoTipo de Desconto. Pode ser: P - Percentual V - Valor
ServicosPrestados[].cTribServtextoTipo 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[].impostosobjetoDados do impostos do serviço.
ServicosPrestados[].impostos.cCSTtextoCó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.cClassTribtextoCó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.cFixarCOFINStextoIndica 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.cFixarCSLLtextoIndica 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.cFixarINSStextoIndica 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.cFixarIRRFtextoIndica 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.cFixarISStextoIndica 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.cFixarPIStextoIndica 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.cIndOPertextoCó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.cManCbstextoIndica 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.cManIbsMuntextoIndica 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.cManIbsUftextoIndica 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.cRetemCOFINStextoRetém COFINS (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemCSLLtextoRetém CSLL (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemINSStextoRetém INSS (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemIRRFtextoRetém IRRF (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemPIStextoRetém PIS (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cUtilizaValorImpostotextoIndica 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.lDeduzISSsim/nãoDeduz o ISS da Base de Cálculo de PIS e COFINS
ServicosPrestados[].impostos.nAliqCOFINSdecimalAlí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.nAliqCSLLdecimalAlí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.nAliqCbsdecimalAlí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.nAliqEstadualIBPTdecimalAlíquota da Carga Tribut. Aproximada Estadual.
ServicosPrestados[].impostos.nAliqFederalIBPTdecimalAlíquota da Carga Tribut. Aproximada Federal.
ServicosPrestados[].impostos.nAliqINSSdecimalAlí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.nAliqIRRFdecimalAlí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.nAliqISSdecimalAlíquota de ISS.
ServicosPrestados[].impostos.nAliqIbsMundecimalAlí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.nAliqIbsUfdecimalAlí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.nAliqMunicipalIBPTdecimalAlíquota da Carga Tribut. Aproximada Municipal.
ServicosPrestados[].impostos.nAliqPISdecimalAlí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.nAliqRedBaseCOFINSdecimalPercentual de Redução da Base de Cálculo do COFINS.
ServicosPrestados[].impostos.nAliqRedBaseINSSdecimalPercentual de Redução da Base de Cálculo do INSS.
ServicosPrestados[].impostos.nAliqRedBasePISdecimalPercentual de Redução da Base de Cálculo do PIS.
ServicosPrestados[].impostos.nBaseCalcIbsCbsdecimalValor 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.nBaseISSdecimalBase de Cálculo do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração.
ServicosPrestados[].impostos.nPercReducaoCbsdecimalPercentual 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.nPercReducaoIbsMundecimalPercentual 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.nPercReducaoIbsUfdecimalPercentual 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.nTotDeducaodecimalValor 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.nValorCOFINSdecimalValor 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.nValorCSLLdecimalValor 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.nValorCbsdecimalValor 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.nValorDeducaodecimalValor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem.
ServicosPrestados[].impostos.nValorDeducaoIRRFdecimalValor da dedução da base do IR.
ServicosPrestados[].impostos.nValorINSSdecimalValor 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.nValorIRRFdecimalValor 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.nValorISSdecimalValor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração.
ServicosPrestados[].impostos.nValorIbsMundecimalValor 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.nValorIbsUfdecimalValor 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.nValorPISdecimalValor 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[].nAliqDescontodecimalAliquota do Desconto.
ServicosPrestados[].nCodServiconúmero inteiroCó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[].nIdItemnúmero inteiroID 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[].nQtdedecimalQuantidade de serviços.
ServicosPrestados[].nSeqItemnúmero inteiroSequencia do Item Deve ser preenchido com uma sequencia de 1 a 199.
ServicosPrestados[].nValUnitdecimalValor 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[].nValorAcrescimosdecimalValor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.)
ServicosPrestados[].nValorDescontodecimalValor do Desconto.
ServicosPrestados[].nValorOutrasRetencoesdecimalValor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.)
ServicosPrestados[].viaUnicaobjetoInformações referente ao serviço de NF modelo 21 ou 22.
ServicosPrestados[].viaUnica.cCFOPtextoCó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.cClassifServicotextoCó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.cModeloNFtextoIndica 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.cTipoReceitatextoIndicador 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.cTipoUtilizacaotextoCó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.
Tarefaslista de objetosLista 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[].cCodIntTarefatexto
Tarefas[].cDescricaotextoDescrição da tarefa.
Tarefas[].cNomeUserAtbtexto
Tarefas[].dDatatexto
Tarefas[].hHoratexto
Tarefas[].nCodDocnúmero inteiroId 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[].nCodTarefanúmero inteiroCódigo único da tarefa.
Tarefas[].nCodUserAtbnúmero inteiroCódigo do usuário atribuído.
despesasReembolsaveisobjetoDespesas reembolsáveis.
despesasReembolsaveis.cCodCategReembtextoCódigo da categoria para reembolso
despesasReembolsaveis.despesaReembolsavellista de objetosDespesa reembolsável
despesasReembolsaveis.despesaReembolsavel[].cAcaoReembtextoPode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração.
despesasReembolsaveis.despesaReembolsavel[].cDescReembtextoDescrição da despesa.
despesasReembolsaveis.despesaReembolsavel[].dDataReembtextoData da despesa.
despesasReembolsaveis.despesaReembolsavel[].nCodReembnúmero inteiroID 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[].nValorReembdecimalValor da despesa.
produtosUtilizadosobjetoProdutos Utilizados na Ordem de Serviço.
produtosUtilizados.cAcaoProdUtilizadostextoPode 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.cCodCategRemtextoCódigo da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED'
produtosUtilizados.produtoUtilizadolista de objetosrodutos utilizados no serviço.
produtosUtilizados.produtoUtilizado[].cAcaoItemPUtextoPode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração.
produtosUtilizados.produtoUtilizado[].codigo_local_estoquenúmero inteiroCódigo do Local do Estoque.
produtosUtilizados.produtoUtilizado[].lote_validadelista de objetosInformaçõ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[].nIdLotenúmero inteiroId 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[].nQtdLotedecimalInforme 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[].nCodProdutoPUnúmero inteiroCódigo interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie.
produtosUtilizados.produtoUtilizado[].nIdItemPUnú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[].nQtdePUdecimalQuantidade.
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": ""}]}'

ExcluirOS

altera dadosClaudeMCP

Operação para excluir uma Ordem de Serviço.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 5Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntOStexto · até 60Código de Integração da OS
cIncluirTarefastexto · até 1Indica 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.
cNumOStexto · até 15Número da Ordem de Serviço Conforme visualizada na tela pelo cliente.
despesasReembolsaveisobjetoDespesas reembolsáveis.
despesasReembolsaveis.cCodCategReembtexto · até 20Código da categoria para reembolso
despesasReembolsaveis.despesaReembolsavellista de objetosDespesa reembolsável
despesasReembolsaveis.despesaReembolsavel[].cAcaoReembtexto · até 1Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração.
despesasReembolsaveis.despesaReembolsavel[].cDescReembtexto · até 200Descrição da despesa.
despesasReembolsaveis.despesaReembolsavel[].dDataReembtexto · até 10Data da despesa.
despesasReembolsaveis.despesaReembolsavel[].nCodReembnúmero inteiroID 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[].nValorReembnúmeroValor da despesa.
nCodOSnúmero inteiroCódigo da Ordem de Serviço
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntOStextoCódigo de Integração da Ordem de Serviço
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
cNumOStextoNúmero da Ordem de Serviço (Conforme visualizada em tela pelo cliente)
nCodOSnúmero inteiroCó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": ""}]}'

IncluirOS

altera dadosClaudeChatGPTMCP

Operação para incluir uma Ordem de Serviço

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 12Campos e estruturas que você pode enviar
CampoTipoDescrição
CabecalhoobjetoCabeçalho da Ordem de Serviço
Cabecalho.cCodIntClitexto · até 60Código de Integração do Cliente
Cabecalho.cCodIntOStexto · até 60Código de Integração da OS. Obrigatório na inclusão.
Cabecalho.cCodParctexto · até 3Có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.cDescParctexto · até 30Descrição da parcela. Utilizado apenas para retorno do método "ConsultarOS".
Cabecalho.cEtapatexto · até 2Código da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar
Cabecalho.cNumOStexto · até 15Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente)
Cabecalho.dDtPrevisaotexto · até 10Data de Previsão
Cabecalho.nCodClinúmero inteiroCódigo do Cliente
Cabecalho.nCodCtrnúmero inteiroCó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.nCodOSnúmero inteiroCódigo da Ordem de Serviço
Cabecalho.nCodVendnúmero inteiroCódigo do Vendedor
Cabecalho.nQtdeParcnúmero inteiroQuantidade de Parcelas
Cabecalho.nValorTotalnúmeroValor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente.
Cabecalho.nValorTotalImpRetnúmeroValor Total de Impostos Retidos
Caracteristicaslista de objetosCaracterísticas da Ordem de Serviço.
Caracteristicas[].cConteudotexto · até 7000Conteúdo da Característica.
Caracteristicas[].cNometexto · até 70Nome da característica.
Caracteristicas[].nIdCamponúmero inteiroId do campo característica.
Caracteristicas[].nIdCaracteristicanúmero inteiroID da Característica.
Departamentoslista de objetosDados da Aba "Departamentos" do Pedido de Venda.
Departamentos[].cCodDeptotexto · até 40ID 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[].nPercnúmeroPercentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
Departamentos[].nValornúmeroValor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
Departamentos[].nValorFixotexto · até 1Indica que o valor foi fixado na distribuição do rateio. Informar "S" ou "N". Informação localizada na Aba "Departamentos" do Pedido de Venda.
Emailobjeto
Email.cEnvBoletotexto · até 1Enviar 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.cEnvLinktexto · até 1Enviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida.
Email.cEnvPixtexto · até 1Enviar 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.cEnvRecibotexto · até 1Enviar um recibo de prestação de serviços (ao invés da NFS-e)
Email.cEnvViaUnicatexto · até 1Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não
Email.cEnviarParatextoUtilizar os seguintes endereços de e-mail
InfoCadastroobjetoInformações do cadastro da Ordem de Serviço.
InfoCadastro.cAmbientetexto · até 1Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção
InfoCadastro.cCanceladatexto · até 1Ordem de Serviço cancelada?Ex.: S, N
InfoCadastro.cFaturadatexto · até 1Ordem de Serviço faturada com sucesso?Ex.: S, N
InfoCadastro.cHrAlttexto · até 8Hora de Alteração da Ordem de Serviço
InfoCadastro.cHrCanctexto · até 8Hora do Cancelamento
InfoCadastro.cHrFattexto · até 8Hora do Faturamento
InfoCadastro.cHrInctexto · até 8Hora de inclusão da Ordem de Serviço
InfoCadastro.cOrigemtexto · até 3Origem da Ordem de Serviço
InfoCadastro.dDtAlttexto · até 10Data de Alteração da Ordem de Serviço
InfoCadastro.dDtCanctexto · até 10Data de Cancelamento
InfoCadastro.dDtFattexto · até 10Data de Faturamento
InfoCadastro.dDtInctexto · até 10Data de Inclusão da Ordem de Serviço
InfoCadastro.uAlttexto · até 10Usuário da Alteração. Não deve ser informado na Inclusão/Alteração.
InfoCadastro.uInctexto · até 10Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
InformacoesAdicionaisobjeto
InformacoesAdicionais.DetalhesNfseobjetoDetalhes da NFSE.
InformacoesAdicionais.DetalhesNfse.EventosobjetoEvento na Nfse.
InformacoesAdicionais.DetalhesNfse.Eventos.cBairroEventotexto · até 60Bairro do Evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cCepEventotexto · até 10CEP do Evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeEventotexto · até 40Código da Cidade da Prestação de Serviços.
InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeExtEventotexto · até 60Cidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como "S".
InformacoesAdicionais.DetalhesNfse.Eventos.cCodAtivEventotexto · até 30Código de Atividade do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cCodPaisEventotexto · até 4Código do país do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cComplEventotexto · até 40Completo do endereço do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cEndEventotexto · até 60Endereço do envento.
InformacoesAdicionais.DetalhesNfse.Eventos.cEndExtEventotexto · até 255Endereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como "S".
InformacoesAdicionais.DetalhesNfse.Eventos.cExtEventotexto · até 1Evento no Exterior S/N.
InformacoesAdicionais.DetalhesNfse.Eventos.cNomeEventotexto · até 60Nome do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cNumEndEventotexto · até 10Número do endereço do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.cUfEventotexto · até 2Estado do evento.
InformacoesAdicionais.DetalhesNfse.Eventos.dDtFimEventotextoData Final do Evento.
InformacoesAdicionais.DetalhesNfse.Eventos.dDtIniEventotextoData de Início do Evento.
InformacoesAdicionais.cCidPrestServtexto · até 40Cidade da Prestação do Serviço
InformacoesAdicionais.cCodARTtexto · até 20Código ART
InformacoesAdicionais.cCodCategtexto · até 20Categoria
InformacoesAdicionais.cCodObratexto · até 15Código da Obra
InformacoesAdicionais.cContatotexto · até 100Contato
InformacoesAdicionais.cDadosAdicNFtextoDados Adicionais da Nota Fiscal
InformacoesAdicionais.cNumContratotexto · até 20Número do Contrato de Venda
InformacoesAdicionais.cNumPedidotexto · até 30Número do Pedido do Cliente
InformacoesAdicionais.cNumRecibotexto · até 10Número do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado).
InformacoesAdicionais.cUsoConsumotexto · até 1Uso e consumo pessoal.
InformacoesAdicionais.dDataRpstexto · até 10Data da RPS
InformacoesAdicionais.nCodCCnúmero inteiroCódigo da Conta Corrente
InformacoesAdicionais.nCodProjnúmero inteiroCódigo do Projeto
InformacoesAdicionais.nIdDestinatarionúmero inteiroID Cliente para o Destinatário.
Observacoesobjeto
Observacoes.cObsOStextoObservações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal).
Parcelaslista de objetosPermite que o parcelamento seja realizado de forma manual.
Parcelas[].categoria_adiantamentotexto · até 20Có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_adiantamentonúmero inteiroConta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" da Ordem de Serviço.
Parcelas[].dDtVenctexto · até 10Data de Vencimento da parcela. Ex: 01/02/2016
Parcelas[].meio_pagamentotexto · até 100Meio 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órionúmero inteiroNúmero de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias.
Parcelas[].nParcelaobrigatórionúmero inteiroNúmero da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2.
Parcelas[].nPercentualnúmeroPercentual do valor da parcela.
Parcelas[].nValornúmeroValor da Parcela. Ex: 100.23
Parcelas[].nao_gerar_boletotexto · até 1Nã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[].nsutexto · até 100Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico.
Parcelas[].parcela_adiantamentotexto · até 1Está é 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_documentotexto · até 5Tipo 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
ServicosPrestadoslista de objetosItem da Ordem serviço
ServicosPrestados[].DeducoesIsslista de objetosInforme aqui as Deduções para o ISS.
ServicosPrestados[].DeducoesIss[].cCnpjFornecedortexto · até 20CPF ou CNPJ do Fornecedor
ServicosPrestados[].DeducoesIss[].cDescMateriaistexto · até 100Descrição do material.
ServicosPrestados[].DeducoesIss[].cFormaDeducaotexto · até 1Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor.
ServicosPrestados[].DeducoesIss[].cNFReferenciatexto · até 20Nota Fiscal de Referência.
ServicosPrestados[].DeducoesIss[].cTipoDeduducaotexto · até 1Tipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada
ServicosPrestados[].DeducoesIss[].nPercDeducaonúmeroPercentual de dedução.
ServicosPrestados[].DeducoesIss[].nQuantMateriaisnúmeroQuantidade de Material
ServicosPrestados[].DeducoesIss[].nValorDeducaonúmeroValor da Dedução.
ServicosPrestados[].DeducoesIss[].nValorTotNfRefnúmeroValor total NF de Referência
ServicosPrestados[].cAcaoItemtexto · até 1Açã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[].cCodCategItemtexto · até 20Código da Categoria.
ServicosPrestados[].cCodIntServicotexto · até 60Có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[].cCodServLC116texto · até 20Có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[].cCodServMuntexto · até 20Có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[].cCodigotexto · até 20Código do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.
ServicosPrestados[].cDadosAdicItemtextoDados adicionais do Item.
ServicosPrestados[].cDescServtextoDescriçã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[].cNaoGerarFinanceirotexto · até 1Não gerar conta a receber para este item. Informar "S" para não gerar movimento financeiro. Informar "N" para gerar movimento financeiro.
ServicosPrestados[].cNbstexto · até 9Có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[].cReembolsotexto · até 1Identificação se o item é despesa reembolsável.
ServicosPrestados[].cRetemISStexto · até 1Retem ISS (S/N)
ServicosPrestados[].cTpDescontotexto · até 1Tipo de Desconto. Pode ser: P - Percentual V - Valor
ServicosPrestados[].cTribServtexto · até 2Tipo 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[].impostosobjetoDados do impostos do serviço.
ServicosPrestados[].impostos.cCSTtexto · até 3Có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.cClassTribtexto · até 6Có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.cFixarCOFINStexto · até 1Indica 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.cFixarCSLLtexto · até 1Indica 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.cFixarINSStexto · até 1Indica 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.cFixarIRRFtexto · até 1Indica 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.cFixarISStexto · até 1Indica 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.cFixarPIStexto · até 1Indica 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.cIndOPertexto · até 6Có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.cManCbstexto · até 1Indica 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.cManIbsMuntexto · até 1Indica 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.cManIbsUftexto · até 1Indica 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.cRetemCOFINStexto · até 1Retém COFINS (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemCSLLtexto · até 1Retém CSLL (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemINSStexto · até 1Retém INSS (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemIRRFtexto · até 1Retém IRRF (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemPIStexto · até 1Retém PIS (S/N). Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cUtilizaValorImpostotexto · até 1Indica 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.lDeduzISSsim/nãoDeduz o ISS da Base de Cálculo de PIS e COFINS
ServicosPrestados[].impostos.nAliqCOFINSobrigatórionúmeroAlí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órionúmeroAlí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.nAliqCbsnúmeroAlí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.nAliqEstadualIBPTnúmeroAlíquota da Carga Tribut. Aproximada Estadual.
ServicosPrestados[].impostos.nAliqFederalIBPTnúmeroAlíquota da Carga Tribut. Aproximada Federal.
ServicosPrestados[].impostos.nAliqINSSobrigatórionúmeroAlí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órionúmeroAlí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.nAliqISSnúmeroAlíquota de ISS.
ServicosPrestados[].impostos.nAliqIbsMunnúmeroAlí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.nAliqIbsUfnúmeroAlí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.nAliqMunicipalIBPTnúmeroAlíquota da Carga Tribut. Aproximada Municipal.
ServicosPrestados[].impostos.nAliqPISobrigatórionúmeroAlí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.nAliqRedBaseCOFINSnúmeroPercentual de Redução da Base de Cálculo do COFINS.
ServicosPrestados[].impostos.nAliqRedBaseINSSnúmeroPercentual de Redução da Base de Cálculo do INSS.
ServicosPrestados[].impostos.nAliqRedBasePISnúmeroPercentual de Redução da Base de Cálculo do PIS.
ServicosPrestados[].impostos.nBaseCalcIbsCbsnúmeroValor 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.nBaseISSnúmeroBase de Cálculo do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração.
ServicosPrestados[].impostos.nPercReducaoCbsnúmeroPercentual 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.nPercReducaoIbsMunnúmeroPercentual 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.nPercReducaoIbsUfnúmeroPercentual 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.nTotDeducaonúmeroValor 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.nValorCOFINSnúmeroValor 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.nValorCSLLnúmeroValor 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.nValorCbsnúmeroValor 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.nValorDeducaonúmeroValor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem.
ServicosPrestados[].impostos.nValorDeducaoIRRFnúmeroValor da dedução da base do IR.
ServicosPrestados[].impostos.nValorINSSnúmeroValor 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.nValorIRRFnúmeroValor 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.nValorISSnúmeroValor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração.
ServicosPrestados[].impostos.nValorIbsMunnúmeroValor 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.nValorIbsUfnúmeroValor 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.nValorPISnúmeroValor 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[].nAliqDescontonúmeroAliquota do Desconto.
ServicosPrestados[].nCodServiconúmero inteiroCó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[].nIdItemnúmero inteiroID 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[].nQtdenúmeroQuantidade de serviços.
ServicosPrestados[].nSeqItemnúmero inteiroSequencia do Item Deve ser preenchido com uma sequencia de 1 a 199.
ServicosPrestados[].nValUnitnúmeroValor 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[].nValorAcrescimosnúmeroValor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.)
ServicosPrestados[].nValorDescontonúmeroValor do Desconto.
ServicosPrestados[].nValorOutrasRetencoesnúmeroValor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.)
ServicosPrestados[].viaUnicaobjetoInformações referente ao serviço de NF modelo 21 ou 22.
ServicosPrestados[].viaUnica.cCFOPtexto · até 10Có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.cClassifServicotexto · até 4Có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.cModeloNFtexto · até 2Indica 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.cTipoReceitatexto · até 1Indicador 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.cTipoUtilizacaotexto · até 1Có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.
Tarefaslista de objetosLista 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[].cCodIntTarefatexto · até 20
Tarefas[].cDescricaotexto · até 10Descrição da tarefa.
Tarefas[].cNomeUserAtbtexto · até 800
Tarefas[].dDatatexto
Tarefas[].hHoratexto · até 5
Tarefas[].nCodDocnúmero inteiroId 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[].nCodTarefanúmero inteiroCódigo único da tarefa.
Tarefas[].nCodUserAtbnúmero inteiroCódigo do usuário atribuído.
despesasReembolsaveisobjetoDespesas reembolsáveis.
despesasReembolsaveis.cCodCategReembtexto · até 20Código da categoria para reembolso
despesasReembolsaveis.despesaReembolsavellista de objetosDespesa reembolsável
despesasReembolsaveis.despesaReembolsavel[].cAcaoReembtexto · até 1Pode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração.
despesasReembolsaveis.despesaReembolsavel[].cDescReembtexto · até 200Descrição da despesa.
despesasReembolsaveis.despesaReembolsavel[].dDataReembtexto · até 10Data da despesa.
despesasReembolsaveis.despesaReembolsavel[].nCodReembnúmero inteiroID 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[].nValorReembnúmeroValor da despesa.
produtosUtilizadosobjetoProdutos Utilizados na Ordem de Serviço.
produtosUtilizados.cAcaoProdUtilizadostexto · até 3Pode 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.cCodCategRemtexto · até 20Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED'
produtosUtilizados.produtoUtilizadolista de objetosrodutos utilizados no serviço.
produtosUtilizados.produtoUtilizado[].cAcaoItemPUtexto · até 1Pode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração.
produtosUtilizados.produtoUtilizado[].codigo_local_estoquenúmero inteiroCódigo do Local do Estoque.
produtosUtilizados.produtoUtilizado[].lote_validadelista de objetosInformaçõ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[].nIdLotenúmero inteiroId 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órionúmeroInforme 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[].nCodProdutoPUnúmero inteiroCódigo interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie.
produtosUtilizados.produtoUtilizado[].nIdItemPUnú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[].nQtdePUnúmeroQuantidade.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntOStextoCódigo de Integração da Ordem de Serviço
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
cNumOStextoNúmero da Ordem de Serviço (Conforme visualizada em tela pelo cliente)
nCodOSnúmero inteiroCó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}]}]}'

ListarOS

consultaClaudeChatGPTMCP

Lista as Ordens de Serviços.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 24Campos e estruturas que você pode enviar
CampoTipoDescrição
apenas_importado_apitexto · até 1
cExibirCaracteristicastexto · até 1Exibir as características (S/N). Preencher com "S" ou "N".
cExibirDespesastexto · até 1Exibir as despesas reembolsáveis (S/N). Preencher com "S" ou "N".
cExibirProdutostexto · até 1Exibir os produtos utilizados (S/N). Preencher com "S" ou "N".
cTipoFattexto · até 3Tipo de faturamento: Pode ser: REC - Recibo NFS - NFS-e VUF - Via única não autorizada VUA - Via única autorizada
filtrar_apenas_alteracaotexto · até 1
filtrar_apenas_inclusaotexto · até 1
filtrar_por_clientenúmero inteiroFiltra pelo ID do cliente.
filtrar_por_codigolista de objetosLista de códigos de Ordem de Serviço.
filtrar_por_codigo[].cCodIntOStexto · até 60Código de Integração da OS.
filtrar_por_codigo[].nCodOSnúmero inteiroCódigo da Ordem de Serviço. (Código interno utilizado apenas na API).
filtrar_por_data_atetexto · até 10Data de inclusão e/ou alteração final.
filtrar_por_data_cancelamento_atetexto · até 10Data de cancelamento final.
filtrar_por_data_cancelamento_detexto · até 10Data de cancelamento inicial.
filtrar_por_data_detexto · até 10Data de inclusão e/ou alteração inicial.
filtrar_por_data_faturamento_atetexto · até 10Data de faturamento final.
filtrar_por_data_faturamento_detexto · até 10Data de faturamento inicial.
filtrar_por_data_previsao_atetexto · até 10Data de previsão final.
filtrar_por_data_previsao_detexto · até 10Data de previsão inicial
filtrar_por_etapatexto · até 2Etapa da Ordem de Serviço.
filtrar_por_statustexto · até 1Status da OS: F-Faturada N-Não faturada C-Cancelada
ordem_decrescentetexto · até 1Ordem Crescente ou Decrescente.
ordem_descrescentetexto · até 1Descontinuado.
ordenar_portexto · até 100Ordem de exibição dos dados. Padrão: Código.
paginanúmero inteiro
registros_por_paginanúmero inteiro
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
osCadastrolista de objetos
osCadastro[].CabecalhoobjetoCabeçalho da Ordem de Serviço
osCadastro[].Cabecalho.cCodIntClitextoCódigo de Integração do Cliente
osCadastro[].Cabecalho.cCodIntOStextoCódigo de Integração da OS. Obrigatório na inclusão.
osCadastro[].Cabecalho.cCodParctextoCó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.cDescParctextoDescrição da parcela. Utilizado apenas para retorno do método "ConsultarOS".
osCadastro[].Cabecalho.cEtapatextoCódigo da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar
osCadastro[].Cabecalho.cNumOStextoNúmero da Ordem de Serviço (Conforme visualizada em tela pelo cliente)
osCadastro[].Cabecalho.dDtPrevisaotextoData de Previsão
osCadastro[].Cabecalho.nCodClinúmero inteiroCódigo do Cliente
osCadastro[].Cabecalho.nCodCtrnúmero inteiroCó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.nCodOSnúmero inteiroCódigo da Ordem de Serviço
osCadastro[].Cabecalho.nCodVendnúmero inteiroCódigo do Vendedor
osCadastro[].Cabecalho.nQtdeParcnúmero inteiroQuantidade de Parcelas
osCadastro[].Cabecalho.nValorTotaldecimalValor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente.
osCadastro[].Cabecalho.nValorTotalImpRetdecimalValor Total de Impostos Retidos
osCadastro[].Caracteristicaslista de objetosCaracterísticas da Ordem de Serviço.
osCadastro[].Caracteristicas[].cConteudotextoConteúdo da Característica.
osCadastro[].Caracteristicas[].cNometextoNome da característica.
osCadastro[].Caracteristicas[].nIdCamponúmero inteiroId do campo característica.
osCadastro[].Caracteristicas[].nIdCaracteristicanúmero inteiroID da Característica.
osCadastro[].Departamentoslista de objetosDados da Aba "Departamentos" do Pedido de Venda.
osCadastro[].Departamentos[].cCodDeptotextoID 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[].nPercdecimalPercentual de Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
osCadastro[].Departamentos[].nValordecimalValor do Rateio. Informação localizada na Aba "Departamentos" do Pedido de Venda.
osCadastro[].Departamentos[].nValorFixotextoIndica 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[].Emailobjeto
osCadastro[].Email.cEnvBoletotextoEnviar 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.cEnvLinktextoEnviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida.
osCadastro[].Email.cEnvPixtextoEnviar 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.cEnvRecibotextoEnviar um recibo de prestação de serviços (ao invés da NFS-e)
osCadastro[].Email.cEnvViaUnicatextoEnviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não
osCadastro[].Email.cEnviarParatextoUtilizar os seguintes endereços de e-mail
osCadastro[].InfoCadastroobjetoInformações do cadastro da Ordem de Serviço.
osCadastro[].InfoCadastro.cAmbientetextoAmbiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção
osCadastro[].InfoCadastro.cCanceladatextoOrdem de Serviço cancelada?
osCadastro[].InfoCadastro.cFaturadatextoOrdem de Serviço faturada com sucesso?
osCadastro[].InfoCadastro.cHrAlttextoHora de Alteração da Ordem de Serviço
osCadastro[].InfoCadastro.cHrCanctextoHora do Cancelamento
osCadastro[].InfoCadastro.cHrFattextoHora do Faturamento
osCadastro[].InfoCadastro.cHrInctextoHora de inclusão da Ordem de Serviço
osCadastro[].InfoCadastro.cOrigemtextoOrigem da Ordem de Serviço
osCadastro[].InfoCadastro.dDtAlttextoData de Alteração da Ordem de Serviço
osCadastro[].InfoCadastro.dDtCanctextoData de Cancelamento
osCadastro[].InfoCadastro.dDtFattextoData de Faturamento
osCadastro[].InfoCadastro.dDtInctextoData de Inclusão da Ordem de Serviço
osCadastro[].InfoCadastro.uAlttextoUsuário da Alteração. Não deve ser informado na Inclusão/Alteração.
osCadastro[].InfoCadastro.uInctextoUsuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
osCadastro[].InformacoesAdicionaisobjeto
osCadastro[].InformacoesAdicionais.DetalhesNfseobjetoDetalhes da NFSE.
osCadastro[].InformacoesAdicionais.DetalhesNfse.EventosobjetoEvento na Nfse.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cBairroEventotextoBairro do Evento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCepEventotextoCEP do Evento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeEventotextoCódigo da Cidade da Prestação de Serviços.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCidadeExtEventotextoCidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como "S".
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCodAtivEventotextoCódigo de Atividade do evento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cCodPaisEventotextoCódigo do país do evento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cComplEventotextoCompleto do endereço do evento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cEndEventotextoEndereço do envento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cEndExtEventotextoEndereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como "S".
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cExtEventotextoEvento no Exterior S/N.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cNomeEventotextoNome do evento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cNumEndEventotextoNúmero do endereço do evento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.cUfEventotextoEstado do evento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.dDtFimEventotextoData Final do Evento.
osCadastro[].InformacoesAdicionais.DetalhesNfse.Eventos.dDtIniEventotextoData de Início do Evento.
osCadastro[].InformacoesAdicionais.cCidPrestServtextoCidade da Prestação do Serviço
osCadastro[].InformacoesAdicionais.cCodARTtextoCódigo ART
osCadastro[].InformacoesAdicionais.cCodCategtextoCategoria
osCadastro[].InformacoesAdicionais.cCodObratextoCódigo da Obra
osCadastro[].InformacoesAdicionais.cContatotextoContato
osCadastro[].InformacoesAdicionais.cDadosAdicNFtextoDados Adicionais da Nota Fiscal
osCadastro[].InformacoesAdicionais.cNumContratotextoNúmero do Contrato de Venda
osCadastro[].InformacoesAdicionais.cNumPedidotextoNúmero do Pedido do Cliente
osCadastro[].InformacoesAdicionais.cNumRecibotextoNúmero do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado).
osCadastro[].InformacoesAdicionais.cUsoConsumotextoUso e consumo pessoal.
osCadastro[].InformacoesAdicionais.dDataRpstextoData da RPS
osCadastro[].InformacoesAdicionais.nCodCCnúmero inteiroCódigo da Conta Corrente
osCadastro[].InformacoesAdicionais.nCodProjnúmero inteiroCódigo do Projeto
osCadastro[].InformacoesAdicionais.nIdDestinatarionúmero inteiroID Cliente para o Destinatário.
osCadastro[].Observacoesobjeto
osCadastro[].Observacoes.cObsOStextoObservações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal).
osCadastro[].Parcelaslista de objetosPermite que o parcelamento seja realizado de forma manual.
osCadastro[].Parcelas[].categoria_adiantamentotextoCó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_adiantamentonúmero inteiroConta Corrente de Adiantamento. Informação localizada na Aba "Parcelas" da Ordem de Serviço.
osCadastro[].Parcelas[].dDtVenctextoData de Vencimento da parcela. Ex: 01/02/2016
osCadastro[].Parcelas[].meio_pagamentotextoMeio 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[].nDiasnúmero inteiroNúmero de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias.
osCadastro[].Parcelas[].nParcelanúmero inteiroNúmero da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2.
osCadastro[].Parcelas[].nPercentualdecimalPercentual do valor da parcela.
osCadastro[].Parcelas[].nValordecimalValor da Parcela. Ex: 100.23
osCadastro[].Parcelas[].nao_gerar_boletotextoNã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[].nsutextoNúmero Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico.
osCadastro[].Parcelas[].parcela_adiantamentotextoEstá é 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_documentotextoTipo 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[].ServicosPrestadoslista de objetosItem da Ordem serviço
osCadastro[].ServicosPrestados[].DeducoesIsslista de objetosInforme aqui as Deduções para o ISS.
osCadastro[].ServicosPrestados[].DeducoesIss[].cCnpjFornecedortextoCPF ou CNPJ do Fornecedor
osCadastro[].ServicosPrestados[].DeducoesIss[].cDescMateriaistextoDescrição do material.
osCadastro[].ServicosPrestados[].DeducoesIss[].cFormaDeducaotextoTipo de dedução. Informe 'P' para Percentual ou 'V' para Valor.
osCadastro[].ServicosPrestados[].DeducoesIss[].cNFReferenciatextoNota Fiscal de Referência.
osCadastro[].ServicosPrestados[].DeducoesIss[].cTipoDeduducaotextoTipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada
osCadastro[].ServicosPrestados[].DeducoesIss[].nPercDeducaodecimalPercentual de dedução.
osCadastro[].ServicosPrestados[].DeducoesIss[].nQuantMateriaisdecimalQuantidade de Material
osCadastro[].ServicosPrestados[].DeducoesIss[].nValorDeducaodecimalValor da Dedução.
osCadastro[].ServicosPrestados[].DeducoesIss[].nValorTotNfRefdecimalValor total NF de Referência
osCadastro[].ServicosPrestados[].cAcaoItemtextoAçã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[].cCodCategItemtextoCódigo da Categoria.
osCadastro[].ServicosPrestados[].cCodIntServicotextoCó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[].cCodServLC116textoCó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[].cCodServMuntextoCó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[].cCodigotextoCódigo do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.
osCadastro[].ServicosPrestados[].cDadosAdicItemtextoDados adicionais do Item.
osCadastro[].ServicosPrestados[].cDescServtextoDescriçã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[].cNaoGerarFinanceirotextoNão gerar conta a receber para este item. Informar "S" para não gerar movimento financeiro. Informar "N" para gerar movimento financeiro.
osCadastro[].ServicosPrestados[].cNbstextoCó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[].cReembolsotextoIdentificação se o item é despesa reembolsável.
osCadastro[].ServicosPrestados[].cRetemISStextoRetem ISS (S/N)
osCadastro[].ServicosPrestados[].cTpDescontotextoTipo de Desconto. Pode ser: P - Percentual V - Valor
osCadastro[].ServicosPrestados[].cTribServtextoTipo 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[].impostosobjetoDados do impostos do serviço.
osCadastro[].ServicosPrestados[].impostos.cCSTtextoCó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.cClassTribtextoCó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.cFixarCOFINStextoIndica 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.cFixarCSLLtextoIndica 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.cFixarINSStextoIndica 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.cFixarIRRFtextoIndica 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.cFixarISStextoIndica 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.cFixarPIStextoIndica 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.cIndOPertextoCó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.cManCbstextoIndica 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.cManIbsMuntextoIndica 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.cManIbsUftextoIndica 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.cRetemCOFINStextoRetém COFINS (S/N). Indica se o imposto deve ser retido ou não.
osCadastro[].ServicosPrestados[].impostos.cRetemCSLLtextoRetém CSLL (S/N). Indica se o imposto deve ser retido ou não.
osCadastro[].ServicosPrestados[].impostos.cRetemINSStextoRetém INSS (S/N). Indica se o imposto deve ser retido ou não.
osCadastro[].ServicosPrestados[].impostos.cRetemIRRFtextoRetém IRRF (S/N). Indica se o imposto deve ser retido ou não.
osCadastro[].ServicosPrestados[].impostos.cRetemPIStextoRetém PIS (S/N). Indica se o imposto deve ser retido ou não.
osCadastro[].ServicosPrestados[].impostos.cUtilizaValorImpostotextoIndica 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.lDeduzISSsim/nãoDeduz o ISS da Base de Cálculo de PIS e COFINS
osCadastro[].ServicosPrestados[].impostos.nAliqCOFINSdecimalAlí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.nAliqCSLLdecimalAlí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.nAliqCbsdecimalAlí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.nAliqEstadualIBPTdecimalAlíquota da Carga Tribut. Aproximada Estadual.
osCadastro[].ServicosPrestados[].impostos.nAliqFederalIBPTdecimalAlíquota da Carga Tribut. Aproximada Federal.
osCadastro[].ServicosPrestados[].impostos.nAliqINSSdecimalAlí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.nAliqIRRFdecimalAlí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.nAliqISSdecimalAlíquota de ISS.
osCadastro[].ServicosPrestados[].impostos.nAliqIbsMundecimalAlí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.nAliqIbsUfdecimalAlí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.nAliqMunicipalIBPTdecimalAlíquota da Carga Tribut. Aproximada Municipal.
osCadastro[].ServicosPrestados[].impostos.nAliqPISdecimalAlí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.nAliqRedBaseCOFINSdecimalPercentual de Redução da Base de Cálculo do COFINS.
osCadastro[].ServicosPrestados[].impostos.nAliqRedBaseINSSdecimalPercentual de Redução da Base de Cálculo do INSS.
osCadastro[].ServicosPrestados[].impostos.nAliqRedBasePISdecimalPercentual de Redução da Base de Cálculo do PIS.
osCadastro[].ServicosPrestados[].impostos.nBaseCalcIbsCbsdecimalValor 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.nBaseISSdecimalBase 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.nPercReducaoCbsdecimalPercentual 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.nPercReducaoIbsMundecimalPercentual 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.nPercReducaoIbsUfdecimalPercentual 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.nTotDeducaodecimalValor 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.nValorCOFINSdecimalValor 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.nValorCSLLdecimalValor 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.nValorCbsdecimalValor 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.nValorDeducaodecimalValor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem.
osCadastro[].ServicosPrestados[].impostos.nValorDeducaoIRRFdecimalValor da dedução da base do IR.
osCadastro[].ServicosPrestados[].impostos.nValorINSSdecimalValor 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.nValorIRRFdecimalValor 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.nValorISSdecimalValor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração.
osCadastro[].ServicosPrestados[].impostos.nValorIbsMundecimalValor 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.nValorIbsUfdecimalValor 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.nValorPISdecimalValor 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[].nAliqDescontodecimalAliquota do Desconto.
osCadastro[].ServicosPrestados[].nCodServiconúmero inteiroCó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[].nIdItemnúmero inteiroID 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[].nQtdedecimalQuantidade de serviços.
osCadastro[].ServicosPrestados[].nSeqItemnúmero inteiroSequencia do Item Deve ser preenchido com uma sequencia de 1 a 199.
osCadastro[].ServicosPrestados[].nValUnitdecimalValor 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[].nValorAcrescimosdecimalValor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.)
osCadastro[].ServicosPrestados[].nValorDescontodecimalValor do Desconto.
osCadastro[].ServicosPrestados[].nValorOutrasRetencoesdecimalValor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.)
osCadastro[].ServicosPrestados[].viaUnicaobjetoInformações referente ao serviço de NF modelo 21 ou 22.
osCadastro[].ServicosPrestados[].viaUnica.cCFOPtextoCó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.cClassifServicotextoCó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.cModeloNFtextoIndica 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.cTipoReceitatextoIndicador 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.cTipoUtilizacaotextoCó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[].Tarefaslista de objetosLista 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[].cCodIntTarefatexto
osCadastro[].Tarefas[].cDescricaotextoDescrição da tarefa.
osCadastro[].Tarefas[].cNomeUserAtbtexto
osCadastro[].Tarefas[].dDatatexto
osCadastro[].Tarefas[].hHoratexto
osCadastro[].Tarefas[].nCodDocnúmero inteiroId 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[].nCodTarefanúmero inteiroCódigo único da tarefa.
osCadastro[].Tarefas[].nCodUserAtbnúmero inteiroCódigo do usuário atribuído.
osCadastro[].despesasReembolsaveisobjetoDespesas reembolsáveis.
osCadastro[].despesasReembolsaveis.cCodCategReembtextoCódigo da categoria para reembolso
osCadastro[].despesasReembolsaveis.despesaReembolsavellista de objetosDespesa reembolsável
osCadastro[].despesasReembolsaveis.despesaReembolsavel[].cAcaoReembtextoPode ser: "A" - Alterar a despesa. "E" - Excluir a despesa. "I" - Incluir a despesa na alteração.
osCadastro[].despesasReembolsaveis.despesaReembolsavel[].cDescReembtextoDescrição da despesa.
osCadastro[].despesasReembolsaveis.despesaReembolsavel[].dDataReembtextoData da despesa.
osCadastro[].despesasReembolsaveis.despesaReembolsavel[].nCodReembnúmero inteiroID 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[].nValorReembdecimalValor da despesa.
osCadastro[].produtosUtilizadosobjetoProdutos Utilizados na Ordem de Serviço.
osCadastro[].produtosUtilizados.cAcaoProdUtilizadostextoPode 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.cCodCategRemtextoCódigo da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED'
osCadastro[].produtosUtilizados.produtoUtilizadolista de objetosrodutos utilizados no serviço.
osCadastro[].produtosUtilizados.produtoUtilizado[].cAcaoItemPUtextoPode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração.
osCadastro[].produtosUtilizados.produtoUtilizado[].codigo_local_estoquenúmero inteiroCódigo do Local do Estoque.
osCadastro[].produtosUtilizados.produtoUtilizado[].lote_validadelista de objetosInformaçõ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[].nIdLotenúmero inteiroId 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[].nQtdLotedecimalInforme 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[].nCodProdutoPUnúmero inteiroCódigo interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie.
osCadastro[].produtosUtilizados.produtoUtilizado[].nIdItemPUnú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[].nQtdePUdecimalQuantidade.
paginanúmero inteiro
registrosnúmero inteiro
total_de_paginasnúmero inteiro
total_de_registrosnú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"}]}'

StatusOS

consultaClaudeMCP

Retorna o Status da Ordem de Serviço

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 7Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntOStexto · até 60Código de Integração da Ordem de Serviço
lMsgsim/nãoRetornar 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".
lPdfDemosim/nãoExibir a Url do PDF do Demonstrativo da NFS-e. Pode ser: true false O padrão é false.
lPdfDestsim/nãoExibir a Url do PDF do Destinatário da NFS-e. Pode ser: true false O padrão é false.
lPdfRecibosim/nãoExibir a Url do Recibo. Pode ser: true false O padrão é false.
lRpssim/nãoExibir a Url da RPS. Pode ser: true false O padrão é false.
nCodOSnúmero inteiroID da Ordem de Serviço (Código interno)
Retorno 21O que volta numa chamada bem-sucedida
CampoTipoDescrição
ListaRpsNfselista de objetosLista de RPS geradas para a Ordem de Serviço
ListaRpsNfse[].cCNPJtextoCNPJ do Prestador
ListaRpsNfse[].cCodVeriftextoCódigo de Verificação da NFS-e gerada.
ListaRpsNfse[].cInscrMunicipalnúmero inteiroInscrição Municipal do Prestador
ListaRpsNfse[].cProtocolotextoNúmero do protocolo do envio do lote.
ListaRpsNfse[].cStatusLotetextoCó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[].cStatusRpstextoCó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[].cUrlNfsetextoLink para obter a NFS-e na prefeitura.
ListaRpsNfse[].cUrlPdfDemotextoLink para obter o PDF do Demonstrativo da NFS-e.
ListaRpsNfse[].cUrlPdfDesttextoLink para obter o PDF da nota do Destinatário.
ListaRpsNfse[].cUrlRpstextoLink para obter a RPS.
ListaRpsNfse[].danfetextoLink para o DANFE da NF-e gerada.
ListaRpsNfse[].mensagenslista de objetosMensagens de comunicação com a Prefeitura
ListaRpsNfse[].mensagens[].cAnexotextoIndica se a mensagem tem algum anexo (S/N). Esse campo só é retornado quando a tag "lMsg" enviada na request é true.
ListaRpsNfse[].mensagens[].cCodigotextoCódigo da mensagem de Erro/Aviso
ListaRpsNfse[].mensagens[].cCorrecaotextoCorreção da descrição de mensagem de erro/aviso.
ListaRpsNfse[].mensagens[].cDescricaotextoDescrição da mensagem de erro/aviso.
ListaRpsNfse[].mensagens[].cSituacaotextoSituação da mensagem. Pode ser: ERRO ALERTA SUCESSO Esse campo só é retornado quando a tag "lMsg" enviada na request é true.
ListaRpsNfse[].mensagens[].cUsuariotextoUsuário vinculado a mensagem. Esse campo só é retornado quando a tag "lMsg" enviada na request é true.
ListaRpsNfse[].mensagens[].dDatatextoData da mensagem. Esse campo só é retornado quando a tag "lMsg" enviada na request é true.
ListaRpsNfse[].mensagens[].hHoratextoHora da mensagem. Esse campo só é retornado quando a tag "lMsg" enviada na request é true.
ListaRpsNfse[].nLotenúmero inteiroNúmero do Lote de Envio da RPS
ListaRpsNfse[].nNfsetextoNúmero da NFS-e gerada.
ListaRpsNfse[].nRpstextoNúmero do Recibo Provisório de Serviços (RPS).
ListaRpsNfse[].xml_distrtextoXML de distribuição da NF-e
cAmbientetextoAmbiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção
cCanceladatextoOrdem de Serviço cancelada?
cCodIntOStextoCódigo de Integração da Ordem de Serviço (para OS geradas via API, a partir de outros aplicativos)
cEtapatextoEtapa da Ordem de Serviço
cFaturadatextoOrdem de Serviço faturada com sucesso?
cHrAlttextoHora de Alteração da Ordem de Serviço
cHrCanctextoHora do Cancelamento
cHrFattextoHora do Faturamento
cHrInctextoHora de inclusão da Ordem de Serviço
cNumContratotextoNúmero do Contrato
cNumOStextoNúmero da Ordem de Serviço (Conforme visualizada em tela pelo cliente)
cNumPedidotextoNúmero do pedido do cliente.
cNumRecibotextoNúmero do Recibo gerado.
cUrlPdfRecibotextoLink para obter o PDF do Recibo.
dDtAlttextoData de Alteração da Ordem de Serviço
dDtCanctextoData de Cancelamento
dDtFattextoData de Faturamento
dDtInctextoData de Inclusão da Ordem de Serviço
nCodOSnúmero inteiroID da Ordem de Serviço (código interno de controle).
nValorTotdecimalValor 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}]}'

TrocarEtapaOS

altera dadosClaudeMCP

Troca a Etapa da Ordem de Serviço.

Obrigatórios 1

CampoTipoDescrição
cEtapatexto · até 2Etapa 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
CampoTipoDescrição
cCodIntOStexto · até 60Có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.
cNumOStexto · até 15Número da Ordem de Serviço. Esse é o número da Ordem de Serviço no Omie, que é gerado automaticamente e exibido na tela.
nCodOSnúmero inteiroID 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
CampoTipoDescrição
cCodIntOStextoCó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.
cNumOStextoNú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_statustextoCódigo do Status do Pedido de Venda.
descricao_statustextoDescrição do status
nCodOSnúmero inteiroID 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": ""}]}'