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

Cadastro de Serviços

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

AlterarCadastroServico

altera dadosClaudeMCP

Alteração de Serviço.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 6Campos e estruturas que você pode enviar
CampoTipoDescrição
cabecalhoobjeto
cabecalho.cCodCategtexto · até 20Código da Categoria.
cabecalho.cCodLC116texto · até 10Código do Serviço LC 116.
cabecalho.cCodServMuntexto · até 20Código do Serviço Municipal.
cabecalho.cCodigotexto · até 20Código do Serviço.
cabecalho.cDescricaotexto · até 100Descrição Resumida do serviço prestado.
cabecalho.cIdTribtexto · até 2ID da Tributação dos Serviços.
cabecalho.cTipoDesctexto · até 1Tipo do desconto. Pode ser: P - Percentual V - Valor Utilizado apenas nos métodos de Consulta/Listagem.
cabecalho.nAliqDescnúmeroPercentual do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
cabecalho.nIdNBStexto · até 9Id do NBS.
cabecalho.nPrecoUnitnúmeroPreço Unitário do Serviço.
cabecalho.nValorDescnúmeroValor do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
descricaoobjeto
descricao.cDescrCompletatextoDescrição completa do serviço prestado.
impostosobjeto
impostos.cClassTribtexto · até 6Código de Classificação Tributária.
impostos.cCstCOFINStexto · até 2Código da Situação Tributária (CST) do COFINS.
impostos.cCstIbsCbstexto · até 3Código da Situação Tributária IBS/CBS.
impostos.cCstPIStexto · até 2Código da Situação Tributária (CST) do PIS.
impostos.cIndOpertexto · até 6Código Indicador de Operação.
impostos.cRetCOFINStexto · até 1COFINS Retido (S/N).
impostos.cRetCSLLtexto · até 1CSLL Retido (S/N).
impostos.cRetINSStexto · até 1INSS Retido (S/N).
impostos.cRetIRtexto · até 1IR Retido (S/N).
impostos.cRetISStexto · até 1ISS Retido (S/N).
impostos.cRetPIStexto · até 1PIS Retido (S/N).
impostos.lDeduzISSsim/nãoDeduz o ISS da Base de Cálculo de PIS e COFINS.
impostos.nAliqApuCOFINSnúmeroAlíquota de apuração do COFINS.
impostos.nAliqApuPISnúmeroAlíquota de apuração do PIS.
impostos.nAliqCOFINSnúmeroAlíquota de COFINS.
impostos.nAliqCSLLnúmeroAlíquota de CSLL.
impostos.nAliqCbsnúmeroAlíquota da CBS
impostos.nAliqINSSnúmeroAlíquota de INSS.
impostos.nAliqIRnúmeroAlíquota do IR.
impostos.nAliqISSnúmeroAlíquota de ISS.
impostos.nAliqIbsMunnúmeroAlíquota do Alíquota do IBS Municipal.
impostos.nAliqIbsUfnúmeroAlíquota do IBS Estadual.
impostos.nAliqPISnúmeroAlíquota do PIS.
impostos.nPercReducaoCbsnúmeroPercentual redução CBS.
impostos.nPercReducaoIbsMunnúmeroPercentual redução IBS estadual.
impostos.nPercReducaoIbsUfnúmeroPercentual redução IBS municipal.
impostos.nRedBaseCOFINSnúmeroAlíquota de Redução da Base de Cálculo de COFINS
impostos.nRedBaseINSSnúmeroAlíquota de Redução da Base de Cálculo de INSS.
impostos.nRedBasePISnúmeroAlíquota de Redução da Base de Cálculo de PIS
intEditarobjeto
intEditar.cCodIntServtexto · até 60Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
intEditar.nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
produtosUtilizadosobjetoProdutos Utilizados no serviço.
produtosUtilizados.cAtualizarProdutostexto · até 1Atualiza automaticamente. (S/N). Atualiza as alterações dos produtos utilizados nas Ordens de Serviço e nos Contratos.
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[].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.
viaUnicaobjetoNF Via Única (Modelo 21 e 22)
viaUnica.cCFOPtexto · até 10Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação.
viaUnica.cClassifServicotexto · até 4Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação.
viaUnica.cModeloNFtexto · até 2Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação
viaUnica.cTipoReceitatexto · até 1Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica 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
viaUnica.cTipoUtilizacaotexto · até 1Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação.
viaUnica.cUtilizaViaUnicatexto · até 1Indica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22). Pode ser: S - Sim N - Não
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntServtextoCódigo de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
POST /api/v1/servicos/servico/
curl -s https://app.omie.com.br/api/v1/servicos/servico/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AlterarCadastroServico", "param": [{"intEditar": {"cCodIntServ": "", "nCodServ": 0}, "descricao": {"cDescrCompleta": "descricao"}, "cabecalho": {"cDescricao": "Descricao", "cCodigo": "", "cIdTrib": "", "cCodServMun": "", "cCodLC116": "", "nIdNBS": "", "nPrecoUnit": 10.99, "cCodCateg": ""}, "impostos": {"nAliqISS": 0, "cRetISS": "N", "nAliqPIS": 0, "cRetPIS": "N", "nAliqCOFINS": 0, "cRetCOFINS": "N", "nAliqCSLL": 0, "cRetCSLL": "N", "nAliqIR": 0, "cRetIR": "N", "nAliqINSS": 0, "cRetINSS": "N", "nRedBaseINSS": 0, "nRedBaseCOFINS": 0, "nRedBasePIS": 0, "lDeduzISS": false}}]}'

AssociarCodIntServico

altera dadosClaudeMCP

Associa um Código de Integração a um serviço.

Obrigatórios 2

CampoTipoDescrição
cCodIntServtexto · até 60Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntServtextoCódigo de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
POST /api/v1/servicos/servico/
curl -s https://app.omie.com.br/api/v1/servicos/servico/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AssociarCodIntServico", "param": [{"nCodServ": 0, "cCodIntServ": ""}]}'

ConsultarCadastroServico

consultaClaudeMCP

Consulta do cadastro de serviço.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntServtexto · até 60Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
Retorno 7O que volta numa chamada bem-sucedida
CampoTipoDescrição
cabecalhoobjeto
cabecalho.cCodCategtextoCódigo da Categoria.
cabecalho.cCodLC116textoCódigo do Serviço LC 116.
cabecalho.cCodServMuntextoCódigo do Serviço Municipal.
cabecalho.cCodigotextoCódigo do Serviço.
cabecalho.cDescricaotextoDescrição Resumida do serviço prestado.
cabecalho.cIdTribtextoID da Tributação dos Serviços.
cabecalho.cTipoDesctextoTipo do desconto. Pode ser: P - Percentual V - Valor Utilizado apenas nos métodos de Consulta/Listagem.
cabecalho.nAliqDescdecimalPercentual do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
cabecalho.nIdNBStextoId do NBS.
cabecalho.nPrecoUnitdecimalPreço Unitário do Serviço.
cabecalho.nValorDescdecimalValor do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
descricaoobjeto
descricao.cDescrCompletatextoDescrição completa do serviço prestado.
impostosobjeto
impostos.cClassTribtextoCódigo de Classificação Tributária.
impostos.cCstCOFINStextoCódigo da Situação Tributária (CST) do COFINS.
impostos.cCstIbsCbstextoCódigo da Situação Tributária IBS/CBS.
impostos.cCstPIStextoCódigo da Situação Tributária (CST) do PIS.
impostos.cIndOpertextoCódigo Indicador de Operação.
impostos.cRetCOFINStextoCOFINS Retido (S/N).
impostos.cRetCSLLtextoCSLL Retido (S/N).
impostos.cRetINSStextoINSS Retido (S/N).
impostos.cRetIRtextoIR Retido (S/N).
impostos.cRetISStextoISS Retido (S/N).
impostos.cRetPIStextoPIS Retido (S/N).
impostos.lDeduzISSsim/nãoDeduz o ISS da Base de Cálculo de PIS e COFINS.
impostos.nAliqApuCOFINSdecimalAlíquota de apuração do COFINS.
impostos.nAliqApuPISdecimalAlíquota de apuração do PIS.
impostos.nAliqCOFINSdecimalAlíquota de COFINS.
impostos.nAliqCSLLdecimalAlíquota de CSLL.
impostos.nAliqCbsdecimalAlíquota da CBS
impostos.nAliqINSSdecimalAlíquota de INSS.
impostos.nAliqIRdecimalAlíquota do IR.
impostos.nAliqISSdecimalAlíquota de ISS.
impostos.nAliqIbsMundecimalAlíquota do Alíquota do IBS Municipal.
impostos.nAliqIbsUfdecimalAlíquota do IBS Estadual.
impostos.nAliqPISdecimalAlíquota do PIS.
impostos.nPercReducaoCbsdecimalPercentual redução CBS.
impostos.nPercReducaoIbsMundecimalPercentual redução IBS estadual.
impostos.nPercReducaoIbsUfdecimalPercentual redução IBS municipal.
impostos.nRedBaseCOFINSdecimalAlíquota de Redução da Base de Cálculo de COFINS
impostos.nRedBaseINSSdecimalAlíquota de Redução da Base de Cálculo de INSS.
impostos.nRedBasePISdecimalAlíquota de Redução da Base de Cálculo de PIS
infoobjeto
info.cImpAPItextoImportado pela API (S/N).
info.dAlttextoData da Alteração.
info.dInctextoData da Inclusão.
info.hAlttextoHora da Alteração.
info.hInctextoHora da Inclusão.
info.inativotextoIndica se o serviço está inativo (S/N).
info.uAlttextoUsuário da Alteração.
info.uInctextoUsuário da Inclusão.
intListarobjeto
intListar.cCodIntServtextoCódigo de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
intListar.nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
produtosUtilizadosobjetoProdutos Utilizados no serviço.
produtosUtilizados.cAtualizarProdutostextoAtualiza automaticamente. (S/N). Atualiza as alterações dos produtos utilizados nas Ordens de Serviço e nos Contratos.
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[].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.
viaUnicaobjetoNF Via Única (Modelo 21 e 22)
viaUnica.cCFOPtextoCódigo CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação.
viaUnica.cClassifServicotextoCódigo da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação.
viaUnica.cModeloNFtextoIndica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação
viaUnica.cTipoReceitatextoIndicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica 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
viaUnica.cTipoUtilizacaotextoCódigo do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação.
viaUnica.cUtilizaViaUnicatextoIndica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22). Pode ser: S - Sim N - Não
POST /api/v1/servicos/servico/
curl -s https://app.omie.com.br/api/v1/servicos/servico/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarCadastroServico", "param": [{"cCodIntServ": "", "nCodServ": 0}]}'

ExcluirCadastroServico

altera dadosClaudeMCP

Exclusão do cadastro de serviço.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntServtexto · até 60Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntServtextoCódigo de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
POST /api/v1/servicos/servico/
curl -s https://app.omie.com.br/api/v1/servicos/servico/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirCadastroServico", "param": [{"cCodIntServ": "", "nCodServ": 0}]}'

IncluirCadastroServico

altera dadosClaudeMCP

Inclusão de serviço.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 6Campos e estruturas que você pode enviar
CampoTipoDescrição
cabecalhoobjeto
cabecalho.cCodCategtexto · até 20Código da Categoria.
cabecalho.cCodLC116texto · até 10Código do Serviço LC 116.
cabecalho.cCodServMuntexto · até 20Código do Serviço Municipal.
cabecalho.cCodigotexto · até 20Código do Serviço.
cabecalho.cDescricaotexto · até 100Descrição Resumida do serviço prestado.
cabecalho.cIdTribtexto · até 2ID da Tributação dos Serviços.
cabecalho.cTipoDesctexto · até 1Tipo do desconto. Pode ser: P - Percentual V - Valor Utilizado apenas nos métodos de Consulta/Listagem.
cabecalho.nAliqDescnúmeroPercentual do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
cabecalho.nIdNBStexto · até 9Id do NBS.
cabecalho.nPrecoUnitnúmeroPreço Unitário do Serviço.
cabecalho.nValorDescnúmeroValor do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
descricaoobjeto
descricao.cDescrCompletatextoDescrição completa do serviço prestado.
impostosobjeto
impostos.cClassTribtexto · até 6Código de Classificação Tributária.
impostos.cCstCOFINStexto · até 2Código da Situação Tributária (CST) do COFINS.
impostos.cCstIbsCbstexto · até 3Código da Situação Tributária IBS/CBS.
impostos.cCstPIStexto · até 2Código da Situação Tributária (CST) do PIS.
impostos.cIndOpertexto · até 6Código Indicador de Operação.
impostos.cRetCOFINStexto · até 1COFINS Retido (S/N).
impostos.cRetCSLLtexto · até 1CSLL Retido (S/N).
impostos.cRetINSStexto · até 1INSS Retido (S/N).
impostos.cRetIRtexto · até 1IR Retido (S/N).
impostos.cRetISStexto · até 1ISS Retido (S/N).
impostos.cRetPIStexto · até 1PIS Retido (S/N).
impostos.lDeduzISSsim/nãoDeduz o ISS da Base de Cálculo de PIS e COFINS.
impostos.nAliqApuCOFINSnúmeroAlíquota de apuração do COFINS.
impostos.nAliqApuPISnúmeroAlíquota de apuração do PIS.
impostos.nAliqCOFINSnúmeroAlíquota de COFINS.
impostos.nAliqCSLLnúmeroAlíquota de CSLL.
impostos.nAliqCbsnúmeroAlíquota da CBS
impostos.nAliqINSSnúmeroAlíquota de INSS.
impostos.nAliqIRnúmeroAlíquota do IR.
impostos.nAliqISSnúmeroAlíquota de ISS.
impostos.nAliqIbsMunnúmeroAlíquota do Alíquota do IBS Municipal.
impostos.nAliqIbsUfnúmeroAlíquota do IBS Estadual.
impostos.nAliqPISnúmeroAlíquota do PIS.
impostos.nPercReducaoCbsnúmeroPercentual redução CBS.
impostos.nPercReducaoIbsMunnúmeroPercentual redução IBS estadual.
impostos.nPercReducaoIbsUfnúmeroPercentual redução IBS municipal.
impostos.nRedBaseCOFINSnúmeroAlíquota de Redução da Base de Cálculo de COFINS
impostos.nRedBaseINSSnúmeroAlíquota de Redução da Base de Cálculo de INSS.
impostos.nRedBasePISnúmeroAlíquota de Redução da Base de Cálculo de PIS
intIncluirobjeto
intIncluir.cCodIntServobrigatóriotexto · até 60Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
produtosUtilizadosobjetoProdutos Utilizados no serviço.
produtosUtilizados.cAtualizarProdutostexto · até 1Atualiza automaticamente. (S/N). Atualiza as alterações dos produtos utilizados nas Ordens de Serviço e nos Contratos.
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[].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.
viaUnicaobjetoNF Via Única (Modelo 21 e 22)
viaUnica.cCFOPtexto · até 10Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação.
viaUnica.cClassifServicotexto · até 4Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação.
viaUnica.cModeloNFtexto · até 2Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação
viaUnica.cTipoReceitatexto · até 1Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica 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
viaUnica.cTipoUtilizacaotexto · até 1Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação.
viaUnica.cUtilizaViaUnicatexto · até 1Indica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22). Pode ser: S - Sim N - Não
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntServtextoCódigo de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
POST /api/v1/servicos/servico/
curl -s https://app.omie.com.br/api/v1/servicos/servico/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirCadastroServico", "param": [{"intIncluir": {"cCodIntServ": "1234"}, "descricao": {"cDescrCompleta": "descricao"}, "cabecalho": {"cDescricao": "Descricao", "cCodigo": "1234", "cIdTrib": "", "cCodServMun": "", "cCodLC116": "", "nIdNBS": "", "nPrecoUnit": 10.99, "cCodCateg": ""}, "impostos": {"nAliqISS": 0, "cRetISS": "N", "nAliqPIS": 0, "cRetPIS": "N", "nAliqCOFINS": 0, "cRetCOFINS": "N", "nAliqCSLL": 0, "cRetCSLL": "N", "nAliqIR": 0, "cRetIR": "N", "nAliqINSS": 0, "cRetINSS": "N", "nRedBaseINSS": 0, "nRedBaseCOFINS": 0, "nRedBasePIS": 0, "lDeduzISS": false}}]}'

ListarCadastroServico

consultaClaudeChatGPTMCP

Lista os serviços cadastrados.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 16Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodigotexto · até 20Código do Serviço.
cDescricaotexto · até 100Descrição Resumida do serviço prestado.
cExibirProdutostexto · até 1Exibir os produtos utilizados (S/N). Preencher com "S" ou "N".
cOrdemDecrescentetexto · até 1Se a lista será apresentada em ordem decrescente.
cOrdenarPortexto · até 100Ordem de exibição dos dados. Padrão: Código.
dAlteracaoFinaltexto · até 10Data da Alteração final.
dAlteracaoInicialtexto · até 10Data da Alteração Inicial.
dInclusaoFinaltexto · até 10Data da Inclusão final
dInclusaoInicialtexto · até 10Data da Inclusão Inicial.
hAlteracaoFinaltexto · até 8Hora da Alteração Final.
hAlteracaoInicialtexto · até 8Hora da Alteração Inicial.
hInclusaoFinaltexto · até 8Hora da Inclusão Final.
hInclusaoInicialtexto · até 8Hora da Inclusão Inicial.
inativotexto · até 1Indica se o serviço está inativo [S/N]
nPaginanúmero inteiroNúmero da página para resgatar os dados.
nRegPorPaginanúmero inteiroNúmero de registros a serem exibidos por página. Máximo 50.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cadastroslista de objetosLista os cadastros encontrados.
cadastros[].cabecalhoobjeto
cadastros[].cabecalho.cCodCategtextoCódigo da Categoria.
cadastros[].cabecalho.cCodLC116textoCódigo do Serviço LC 116.
cadastros[].cabecalho.cCodServMuntextoCódigo do Serviço Municipal.
cadastros[].cabecalho.cCodigotextoCódigo do Serviço.
cadastros[].cabecalho.cDescricaotextoDescrição Resumida do serviço prestado.
cadastros[].cabecalho.cIdTribtextoID da Tributação dos Serviços.
cadastros[].cabecalho.cTipoDesctextoTipo do desconto. Pode ser: P - Percentual V - Valor Utilizado apenas nos métodos de Consulta/Listagem.
cadastros[].cabecalho.nAliqDescdecimalPercentual do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
cadastros[].cabecalho.nIdNBStextoId do NBS.
cadastros[].cabecalho.nPrecoUnitdecimalPreço Unitário do Serviço.
cadastros[].cabecalho.nValorDescdecimalValor do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
cadastros[].descricaoobjeto
cadastros[].descricao.cDescrCompletatextoDescrição completa do serviço prestado.
cadastros[].impostosobjeto
cadastros[].impostos.cClassTribtextoCódigo de Classificação Tributária.
cadastros[].impostos.cCstCOFINStextoCódigo da Situação Tributária (CST) do COFINS.
cadastros[].impostos.cCstIbsCbstextoCódigo da Situação Tributária IBS/CBS.
cadastros[].impostos.cCstPIStextoCódigo da Situação Tributária (CST) do PIS.
cadastros[].impostos.cIndOpertextoCódigo Indicador de Operação.
cadastros[].impostos.cRetCOFINStextoCOFINS Retido (S/N).
cadastros[].impostos.cRetCSLLtextoCSLL Retido (S/N).
cadastros[].impostos.cRetINSStextoINSS Retido (S/N).
cadastros[].impostos.cRetIRtextoIR Retido (S/N).
cadastros[].impostos.cRetISStextoISS Retido (S/N).
cadastros[].impostos.cRetPIStextoPIS Retido (S/N).
cadastros[].impostos.lDeduzISSsim/nãoDeduz o ISS da Base de Cálculo de PIS e COFINS.
cadastros[].impostos.nAliqApuCOFINSdecimalAlíquota de apuração do COFINS.
cadastros[].impostos.nAliqApuPISdecimalAlíquota de apuração do PIS.
cadastros[].impostos.nAliqCOFINSdecimalAlíquota de COFINS.
cadastros[].impostos.nAliqCSLLdecimalAlíquota de CSLL.
cadastros[].impostos.nAliqCbsdecimalAlíquota da CBS
cadastros[].impostos.nAliqINSSdecimalAlíquota de INSS.
cadastros[].impostos.nAliqIRdecimalAlíquota do IR.
cadastros[].impostos.nAliqISSdecimalAlíquota de ISS.
cadastros[].impostos.nAliqIbsMundecimalAlíquota do Alíquota do IBS Municipal.
cadastros[].impostos.nAliqIbsUfdecimalAlíquota do IBS Estadual.
cadastros[].impostos.nAliqPISdecimalAlíquota do PIS.
cadastros[].impostos.nPercReducaoCbsdecimalPercentual redução CBS.
cadastros[].impostos.nPercReducaoIbsMundecimalPercentual redução IBS estadual.
cadastros[].impostos.nPercReducaoIbsUfdecimalPercentual redução IBS municipal.
cadastros[].impostos.nRedBaseCOFINSdecimalAlíquota de Redução da Base de Cálculo de COFINS
cadastros[].impostos.nRedBaseINSSdecimalAlíquota de Redução da Base de Cálculo de INSS.
cadastros[].impostos.nRedBasePISdecimalAlíquota de Redução da Base de Cálculo de PIS
cadastros[].infoobjeto
cadastros[].info.cImpAPItextoImportado pela API (S/N).
cadastros[].info.dAlttextoData da Alteração.
cadastros[].info.dInctextoData da Inclusão.
cadastros[].info.hAlttextoHora da Alteração.
cadastros[].info.hInctextoHora da Inclusão.
cadastros[].info.inativotextoIndica se o serviço está inativo (S/N).
cadastros[].info.uAlttextoUsuário da Alteração.
cadastros[].info.uInctextoUsuário da Inclusão.
cadastros[].intListarobjeto
cadastros[].intListar.cCodIntServtextoCódigo de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
cadastros[].intListar.nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
cadastros[].produtosUtilizadosobjetoProdutos Utilizados no serviço.
cadastros[].produtosUtilizados.cAtualizarProdutostextoAtualiza automaticamente. (S/N). Atualiza as alterações dos produtos utilizados nas Ordens de Serviço e nos Contratos.
cadastros[].produtosUtilizados.produtoUtilizadolista de objetosrodutos utilizados no serviço.
cadastros[].produtosUtilizados.produtoUtilizado[].cAcaoItemPUtextoPode ser: "A" - Alterar o item. "E" - Excluir o item. "I" - Incluir o item na alteração.
cadastros[].produtosUtilizados.produtoUtilizado[].codigo_local_estoquenúmero inteiroCódigo do Local do Estoque.
cadastros[].produtosUtilizados.produtoUtilizado[].nCodProdutoPUnúmero inteiroCódigo interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie.
cadastros[].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.
cadastros[].produtosUtilizados.produtoUtilizado[].nQtdePUdecimalQuantidade.
cadastros[].viaUnicaobjetoNF Via Única (Modelo 21 e 22)
cadastros[].viaUnica.cCFOPtextoCódigo CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação.
cadastros[].viaUnica.cClassifServicotextoCódigo da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação.
cadastros[].viaUnica.cModeloNFtextoIndica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação
cadastros[].viaUnica.cTipoReceitatextoIndicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica 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
cadastros[].viaUnica.cTipoUtilizacaotextoCódigo do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação.
cadastros[].viaUnica.cUtilizaViaUnicatextoIndica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22). Pode ser: S - Sim N - Não
nPaginanúmero inteiroNúmero da página retornada
nRegistrosnúmero inteiroNúmero de registros retornados na página.
nTotPaginasnúmero inteiroNúmero total de páginas
nTotRegistrosnúmero inteirototal de registros encontrados
POST /api/v1/servicos/servico/
curl -s https://app.omie.com.br/api/v1/servicos/servico/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarCadastroServico", "param": [{"nPagina": 1, "nRegPorPagina": 20}]}'

UpsertCadastroServico

altera dadosClaudeMCP

Upsert de serviço.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 5Campos e estruturas que você pode enviar
CampoTipoDescrição
cabecalhoobjeto
cabecalho.cCodCategtexto · até 20Código da Categoria.
cabecalho.cCodLC116texto · até 10Código do Serviço LC 116.
cabecalho.cCodServMuntexto · até 20Código do Serviço Municipal.
cabecalho.cCodigotexto · até 20Código do Serviço.
cabecalho.cDescricaotexto · até 100Descrição Resumida do serviço prestado.
cabecalho.cIdTribtexto · até 2ID da Tributação dos Serviços.
cabecalho.cTipoDesctexto · até 1Tipo do desconto. Pode ser: P - Percentual V - Valor Utilizado apenas nos métodos de Consulta/Listagem.
cabecalho.nAliqDescnúmeroPercentual do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
cabecalho.nIdNBStexto · até 9Id do NBS.
cabecalho.nPrecoUnitnúmeroPreço Unitário do Serviço.
cabecalho.nValorDescnúmeroValor do desconto. Utilizado apenas nos métodos de Consulta/Listagem.
descricaoobjeto
descricao.cDescrCompletatextoDescrição completa do serviço prestado.
impostosobjeto
impostos.cClassTribtexto · até 6Código de Classificação Tributária.
impostos.cCstCOFINStexto · até 2Código da Situação Tributária (CST) do COFINS.
impostos.cCstIbsCbstexto · até 3Código da Situação Tributária IBS/CBS.
impostos.cCstPIStexto · até 2Código da Situação Tributária (CST) do PIS.
impostos.cIndOpertexto · até 6Código Indicador de Operação.
impostos.cRetCOFINStexto · até 1COFINS Retido (S/N).
impostos.cRetCSLLtexto · até 1CSLL Retido (S/N).
impostos.cRetINSStexto · até 1INSS Retido (S/N).
impostos.cRetIRtexto · até 1IR Retido (S/N).
impostos.cRetISStexto · até 1ISS Retido (S/N).
impostos.cRetPIStexto · até 1PIS Retido (S/N).
impostos.lDeduzISSsim/nãoDeduz o ISS da Base de Cálculo de PIS e COFINS.
impostos.nAliqApuCOFINSnúmeroAlíquota de apuração do COFINS.
impostos.nAliqApuPISnúmeroAlíquota de apuração do PIS.
impostos.nAliqCOFINSnúmeroAlíquota de COFINS.
impostos.nAliqCSLLnúmeroAlíquota de CSLL.
impostos.nAliqCbsnúmeroAlíquota da CBS
impostos.nAliqINSSnúmeroAlíquota de INSS.
impostos.nAliqIRnúmeroAlíquota do IR.
impostos.nAliqISSnúmeroAlíquota de ISS.
impostos.nAliqIbsMunnúmeroAlíquota do Alíquota do IBS Municipal.
impostos.nAliqIbsUfnúmeroAlíquota do IBS Estadual.
impostos.nAliqPISnúmeroAlíquota do PIS.
impostos.nPercReducaoCbsnúmeroPercentual redução CBS.
impostos.nPercReducaoIbsMunnúmeroPercentual redução IBS estadual.
impostos.nPercReducaoIbsUfnúmeroPercentual redução IBS municipal.
impostos.nRedBaseCOFINSnúmeroAlíquota de Redução da Base de Cálculo de COFINS
impostos.nRedBaseINSSnúmeroAlíquota de Redução da Base de Cálculo de INSS.
impostos.nRedBasePISnúmeroAlíquota de Redução da Base de Cálculo de PIS
intEditarobjeto
intEditar.cCodIntServtexto · até 60Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
intEditar.nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
viaUnicaobjetoNF Via Única (Modelo 21 e 22)
viaUnica.cCFOPtexto · até 10Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "nCodigo" do método "ListarCFOP" da API /api/v1/produtos/cfop/ para obter essa informação.
viaUnica.cClassifServicotexto · até 4Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarClassificacaoServico" da API /api/v1/servicos/classificacaoservico/ para obter essa informação.
viaUnica.cModeloNFtexto · até 2Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação
viaUnica.cTipoReceitatexto · até 1Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica 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
viaUnica.cTipoUtilizacaotexto · até 1Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a "S". Utilize a tag "cCodigo" do método "ListarTipoUtilizacao" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação.
viaUnica.cUtilizaViaUnicatexto · até 1Indica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22). Pode ser: S - Sim N - Não
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntServtextoCódigo de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodServnúmero inteiroCódigo do serviço. (Gerado internamente, não é visualizado na tela)
POST /api/v1/servicos/servico/
curl -s https://app.omie.com.br/api/v1/servicos/servico/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "UpsertCadastroServico", "param": [{"intEditar": {"cCodIntServ": "", "nCodServ": 0}, "descricao": {"cDescrCompleta": "descricao"}, "cabecalho": {"cDescricao": "Descricao", "cCodigo": "", "cIdTrib": "", "cCodServMun": "", "cCodLC116": "", "nIdNBS": "", "nPrecoUnit": 10.99, "cCodCateg": ""}, "impostos": {"nAliqISS": 0, "cRetISS": "N", "nAliqPIS": 0, "cRetPIS": "N", "nAliqCOFINS": 0, "cRetCOFINS": "N", "nAliqCSLL": 0, "cRetCSLL": "N", "nAliqIR": 0, "cRetIR": "N", "nAliqINSS": 0, "cRetINSS": "N", "nRedBaseINSS": 0, "nRedBaseCOFINS": 0, "nRedBasePIS": 0, "lDeduzISS": false}}]}'