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

API Resumida de Ordem de serviço

POSThttps://app.omie.com.br/api/v1/servicos/ordemservico/WSDL
0consultas
2alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato

AdicionarItemOs

altera dadosClaudeMCP

Solicitação de inclusão de item para a OS.

Obrigatórios 2

CampoTipoDescrição
nCodServiconúmero inteiroCódigo interno do serviço conforme cadastrado na tabela de serviços. Obrigatório. Possível identificar através do método: https://app.omie.com.br/api/v1/geral/servicos/#ListarServicos Acessando a tag "nCodServ" dentro do objeto "cabec".
nValUnitnúmeroValor unitário do serviço. Obrigatório e maior que zero.
Opcionais 12Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodCategtexto · até 20Código da Categoria.
cCodIntOStexto · até 60Código de integração da ordem de serviço. Informe nCodOS, cCodIntOS ou cNumOS.
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.
cNumOStexto · até 15Número da ordem de serviço. Conforme visualizado na tela pelo cliente.
cRetemISStexto · até 1Retém ISS (S/N).
cTpDescontotexto · até 1Pode ser: P - Percentual V - Valor
cTribServtexto · até 2Tipo de tributação do serviço. Possível identificar através do método: https://app.omie.com.br/api/v1/servicos/tipotrib/#ListarTiposTrib Acessando a tag "cIdTrib".
nAliqDescontonúmeroAlíquota do desconto.
nAliqISSnúmeroAlíquota de ISS do item.
nCodOSnúmero inteiroCódigo da ordem de serviço. Informe nCodOS, cCodIntOS ou cNumOS.
nQtdenúmeroQuantidade de serviços. Padrão 1; precisa ser maior que zero.
nValorDescontonúmeroValor do desconto.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo de Status
cDesStatustextoDescrição do Status
cNumOStextoNúmero da ordem de serviço.
nCodItemnúmero inteiroCódigo do item criado na ordem de serviço.
nCodOSnúmero inteiroCódigo da ordem de serviço.
POST /api/v1/servicos/ordemservico/
curl -s https://app.omie.com.br/api/v1/servicos/ordemservico/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AdicionarItemOs", "param": [{"nCodOS": 0, "cCodIntOS": "", "cNumOS": "", "nCodServico": 0, "nQtde": 1, "nValUnit": 25, "cTpDesconto": "V", "nValorDesconto": 0, "nAliqDesconto": 0, "nAliqISS": 5, "cRetemISS": "S", "cTribServ": "01", "cCodCateg": "1.01.02", "cNaoGerarFinanceiro": "N"}]}'

AdicionarOs

altera dadosClaudeMCP

Solicitação de inclusão de OS resumida.

Obrigatórios 3

CampoTipoDescrição
cCidPrestServtexto · até 40Cidade da prestação do serviço, no formato "CIDADE (UF)". Obrigatório. É validada no cadastro de cidades.
cCodCategtexto · até 20Código da categoria de receita da OS. Obrigatório.
nCodCCnúmero inteiroCódigo da conta corrente da OS. Obrigatório. Para enviar PIX (cEnvPix "S"), a conta precisa ter PIX habilitado.
Opcionais 21Campos e estruturas que você pode enviar
CampoTipoDescrição
ServicosPrestadoslista de objetosServiços prestados. Obrigatório, com ao menos um item.
ServicosPrestados[].cCodCategItemtexto · até 20Código da Categoria.
ServicosPrestados[].cCodServLC116texto · até 20Código do serviço conforme Lei Complementar (LC 116).
ServicosPrestados[].cCodServMuntexto · até 20Código do serviço municipal ou CNAE. 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[].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[].cTpDescontotexto · até 1Pode ser: P - Percentual V - Valor
ServicosPrestados[].cTribServtexto · até 2Tipo de tributação do serviço. Possível identificar através do método: https://app.omie.com.br/api/v1/servicos/tipotrib/#ListarTiposTrib Acessando a tag "cIdTrib".
ServicosPrestados[].impostosobjetoImpostos do item.
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.cDeduzISStexto · até 1Deduz o ISS da base de cálculo de PIS e COFINS (S/N).
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.cRetemCOFINStexto · até 1Retém COFINS (S/N). Padrão é "N". Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemCSLLtexto · até 1Retém CSLL (S/N). Padrão é "N". Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemINSStexto · até 1Retém INSS (S/N). Padrão é "N". Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemIRRFtexto · até 1Retém IRRF (S/N). Padrão é "N". Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemISStexto · até 1Retém ISS (S/N). Padrão é "N". Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cRetemPIStexto · até 1Retém PIS (S/N). Padrão é "N". Indica se o imposto deve ser retido ou não.
ServicosPrestados[].impostos.cUtilizaValorImpostotexto · até 1Aceita S/N, mas hoje não tem efeito nesta operação: PIS, COFINS, CSLL, IR e INSS são sempre calculados a partir da alíquota, e os valores informados desses impostos são ignorados.
ServicosPrestados[].impostos.nAliqCOFINSnúmeroAlíquota de COFINS. Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente.
ServicosPrestados[].impostos.nAliqCSLLnúmeroAlíquota de CSLL. Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente.
ServicosPrestados[].impostos.nAliqCbsnúmeroAlíquota do 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.nAliqINSSnúmeroAlíquota de INSS. Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente.
ServicosPrestados[].impostos.nAliqIRRFnúmeroAlíquota de IRRF. 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 Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie.
ServicosPrestados[].impostos.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.nAliqPISnúmeroAlíquota de PIS. 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 deduçã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.
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.nValorCOFINSnúmeroValor do COFINS. Ignorado nesta operação: o Omie calcula o valor pela alíquota informada.
ServicosPrestados[].impostos.nValorCSLLnúmeroValor de CSLL. Ignorado nesta operação: o Omie calcula o valor pela alíquota informada.
ServicosPrestados[].impostos.nValorDeducaonúmeroValor de dedução. 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.nValorDeducaoIRRFnúmeroValor da dedução do IR.
ServicosPrestados[].impostos.nValorINSSnúmeroValor de INSS. Ignorado nesta operação: o Omie calcula o valor pela alíquota informada.
ServicosPrestados[].impostos.nValorIRRFnúmeroValor do IRRF. Ignorado nesta operação: o Omie calcula o valor pela alíquota informada.
ServicosPrestados[].impostos.nValorISSnúmeroValor do ISS. Se informado, é gravado como valor do ISS do item; senão, o Omie calcula pela alíquota.
ServicosPrestados[].impostos.nValorPISnúmeroValor do PIS. Ignorado nesta operação: o Omie calcula o valor pela alíquota informada.
ServicosPrestados[].nAliqDescontonúmeroAlíquota do desconto.
ServicosPrestados[].nCodServicoobrigatóriotexto · até 20Código interno do serviço conforme cadastrado na tabela de serviços. Obrigatório. Possível identificar através do método: https://app.omie.com.br/api/v1/geral/servicos/#ListarServicos Acessando a tag "nCodServ" dentro do objeto "cabec".
ServicosPrestados[].nQtdenúmeroQuantidade de serviços. Padrão 1; precisa ser maior que zero.
ServicosPrestados[].nValUnitobrigatórionúmeroValor unitário do serviço. Obrigatório e maior que zero.
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.
cCnpjCpftexto · até 20CNPJ ou CPF do cliente. Obrigatório caso não enviar [nIdCliente]. O documento é validado e o cliente precisa já estar cadastrado (esta operação não cadastra cliente).
cCodARTtexto · até 20Código da ART (Anotação de Responsabilidade Técnica).
cCodObratexto · até 15Código da obra (construção civil).
cCodParctexto · até 3Código da condição de pagamento (parcelas). Padrão 999. Utilize o método "ListarParcelas" da API /api/v1/geral/parcelas/ para obter os códigos.
cDadosAdicNFtextoDados adicionais para a NFS-e. Use | (pipe) como separador de linhas.
cEnvBoletotexto · até 1Enviar boleto por e-mail (S/N). Não pode ser "S" junto com cEnvPix.
cEnvLinktexto · até 1Enviar o link da NFS-e por e-mail (S/N).
cEnvPixtexto · até 1Enviar PIX por e-mail (S/N). Exige conta corrente com PIX; não pode ser "S" junto com cEnvBoleto.
cEnvRecibotexto · até 1Enviar recibo (S/N). Padrão N.
cEnvViaUnicatexto · até 1Enviar via única (S/N). Padrão N.
cEnviarParatextoE-mails para onde a NFS-e e os anexos serão enviados quando a OS for faturada.
cEtapatexto · até 2Etapa da OS: 00, 10, 20, 30, 40 ou 50. Padrão 10. Só posiciona a OS; esta operação não fatura.
cObservacaotextoObservações internas da OS. Use | (pipe) como separador de linhas.
cOrigemtexto · até 3Indica qual a origem da ordem de serviço. Default: API - Importado via API
cUsoConsumotexto · até 1Uso ou consumo pessoal (S/N), para a Reforma Tributária. Padrão N.
dDataCompetenciatexto · até 10Data de competência da NFS-e (dd/mm/aaaa). Não pode ser anterior a 365 dias atrás.
dDataPrevisaotexto · até 10Data de previsão (dd/mm/aaaa). Padrão hoje. Não pode ser anterior a 365 dias atrás.
nCodVendnúmero inteiroCódigo do vendedor.
nIdClientenúmero inteiroCódigo do cliente. Obrigatório envio caso não enviar [cCnpjCpf].
nIdDestinatarionúmero inteiroCódigo do cliente destinatário, quando diferente do tomador (Reforma Tributária).
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo de Status
cDesStatustextoDescrição do Status
cNumOStextoNúmero da ordem de serviço gerada.
nCodOSnúmero inteiroCódigo da ordem de serviço gerada.
POST /api/v1/servicos/ordemservico/
curl -s https://app.omie.com.br/api/v1/servicos/ordemservico/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AdicionarOs", "param": [{"nCodCC": 0, "nIdCliente": 0, "nCodVend": 0, "cCnpjCpf": "455.763.860-00", "cCodParc": "000", "cCodCateg": "1.01.02", "cCidPrestServ": "BELO HORIZONTE (MG)", "cEtapa": "50", "cCodObra": "", "cCodART": "", "cDadosAdicNF": "OS da proposta 60895665", "cEnviarPara": "nfse.marketplace@mercantil.com.br", "cEnvLink": "N", "cEnvBoleto": "N", "cEnvPix": "N", "cEnvViaUnica": "N", "cEnvRecibo": "N", "dDataPrevisao": "23/09/2026", "dDataCompetencia": "23/09/2026", "cOrigem": "", "cObservacao": "", "ServicosPrestados": [{"nCodServico": 0, "nQtde": 1, "nValUnit": 25, "cTpDesconto": "V", "nValorDesconto": 5, "nAliqDesconto": 0, "nValorOutrasRetencoes": 0, "nValorAcrescimos": 0, "cTribServ": "01", "cCodCategItem": "1.01.02", "cCodServLC116": "1.04", "cCodServMun": "", "cNaoGerarFinanceiro": "N", "impostos": {"nValorDeducao": 0, "cUtilizaValorImposto": "N", "cDeduzISS": "N", "cRetemISS": "N", "nAliqISS": 0, "nValorISS": 0, "cRetemCSLL": "N", "nAliqCSLL": 0, "nValorCSLL": 0, "cRetemIRRF": "N", "nAliqIRRF": 0, "nValorIRRF": 0, "nValorDeducaoIRRF": 0, "cRetemINSS": "N", "nAliqINSS": 0, "nValorINSS": 0, "nAliqRedBaseINSS": 0, "cRetemPIS": "N", "nAliqPIS": 0, "nValorPIS": 0, "nAliqRedBasePIS": 0, "cRetemCOFINS": "N", "nAliqCOFINS": 0, "nValorCOFINS": 0, "nAliqRedBaseCOFINS": 0}}]}]}'