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

Retorna informações do faturamento de serviços

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

ObterDemonst

consultaClaudeMCP

Retorna as informações de um Demonstrativo de nota.

Obrigatórios 1

CampoTipoDescrição
nIdNfnúmero inteiroID do documento fiscal. Essa informação pode ser obtida pela API: /api/v1/mobile/faturamento/ Retornado na tag "nIdDoc"
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustexto
cDesStatustexto
cLinkPortaltextoLink para acessar os documentos no portal Omie.
cNumOstextoNúmero da Ordem de Serviço.
cPdfDemonsttextoLink para obter o PDF do Demonstrativo.
POST /api/v1/servicos/osdocs/
curl -s https://app.omie.com.br/api/v1/servicos/osdocs/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterDemonst", "param": [{"nIdNf": 0}]}'

ObterNFSe

consultaClaudeChatGPTMCP

Retorna as informações do faturamento de uma NFS-e

Obrigatórios 1

CampoTipoDescrição
nIdNfnúmero inteiroID do documento fiscal. Essa informação pode ser obtida pela API: /api/v1/mobile/faturamento/ Retornado na tag "nIdDoc"
Retorno 10O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustexto
cCodVeriftextoCódigo de Verificação da NFS-e.
cDesStatustexto
cLinkPortaltextoLink para acessar os documentos no portal Omie.
cNumNFSetextoNúmero da NFS-e.
cNumOstextoNúmero da Ordem de Serviço.
cPdfNFSetextoLink para obter o PDF da NFS-e
cSerieNFSetextoSérie da NFS-e.
cUrlNFSetextoLink para obter a NFS-e na prefeitura.
cXmlNFSetextoXML da NFS-e.
POST /api/v1/servicos/osdocs/
curl -s https://app.omie.com.br/api/v1/servicos/osdocs/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterNFSe", "param": [{"nIdNf": 0}]}'

ObterOS

consultaClaudeMCP

Retorna as informações de uma Ordem de Serviço.

Obrigatórios 1

CampoTipoDescrição
nIdOsnúmero inteiro
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustexto
cDesStatustexto
cLinkPortaltextoLink para acessar os documentos no portal Omie.
cNumOstextoNúmero da Ordem de Serviço.
cPdfOstextoLink para obter o PDF da Ordem de Serviço.
POST /api/v1/servicos/osdocs/
curl -s https://app.omie.com.br/api/v1/servicos/osdocs/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterOS", "param": [{"nIdOs": 0}]}'

ObterRPS

consultaClaudeMCP

Retorna as informações do faturamento de um RPS.

Obrigatórios 1

CampoTipoDescrição
nIdNfnúmero inteiroID do documento fiscal. Essa informação pode ser obtida pela API: /api/v1/mobile/faturamento/ Retornado na tag "nIdDoc"
Retorno 7O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustexto
cDesStatustexto
cLinkPortaltextoLink para acessar os documentos no portal Omie.
cNumOstextoNúmero da Ordem de Serviço.
cNumRPStextoNúmero do RPS.
cPdfRPStextoLink para obter o PDF do RPS.
cSerieRPStextoSérie do RPS.
POST /api/v1/servicos/osdocs/
curl -s https://app.omie.com.br/api/v1/servicos/osdocs/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterRPS", "param": [{"nIdNf": 0}]}'

ObterRecibo

consultaClaudeMCP

Retorna as informações do recibo.

Obrigatórios 1

CampoTipoDescrição
nIdRecnúmero inteiroID do recibo. Informe aqui o ID do recibo. Essa informação pode ser obtida pela API: api/v1/servicos/os/#osStatus
Retorno 6O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustexto
cDesStatustexto
cLinkPortaltextoLink para acessar os documentos no portal Omie.
cNumOstextoNúmero da Ordem de Serviço.
cNumRecibotextoNúmero do recibo
cPdfRecibotextoLink para obter o PDF do recibo
POST /api/v1/servicos/osdocs/
curl -s https://app.omie.com.br/api/v1/servicos/osdocs/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterRecibo", "param": [{"nIdRec": 0}]}'

ObterViaUnica

consultaClaudeMCP

Retorna as informações do faturamento de uma nota Via Única

Obrigatórios 1

CampoTipoDescrição
nIdNfnúmero inteiroID do documento fiscal. Essa informação pode ser obtida pela API: /api/v1/mobile/faturamento/ Retornado na tag "nIdDoc"
Retorno 8O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustexto
cDesStatustexto
cLinkPortaltextoLink para acessar os documentos no portal Omie.
cModelotextoModelo da nota fiscal Via Única.
cNumOstextoNúmero da Ordem de Serviço.
cNumViaUnicatextoNúmero da nota fiscal Via Única.
cPdfViaUnicatextoLink para obter o PDF da nota fiscal Via Única.
cSerieViaUnicatextoSérie da nota fiscal Via Única.
POST /api/v1/servicos/osdocs/
curl -s https://app.omie.com.br/api/v1/servicos/osdocs/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterViaUnica", "param": [{"nIdNf": 0}]}'