Serviços ·
OsDocsRetorna informações do faturamento de serviços
6consultas
0alterações
Claude 6 de 6 · ChatGPT 1 de 6 · MCP 6 de 6pelos assistentes de IA
JSON · XMLformato
Retorna as informações de um Demonstrativo de nota.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
nIdNf | número inteiro | ID 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
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | |
cDesStatus | texto | |
cLinkPortal | texto | Link para acessar os documentos no portal Omie. |
cNumOs | texto | Número da Ordem de Serviço. |
cPdfDemonst | texto | Link 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}]}'import os
import requests
corpo = {'call': 'ObterDemonst', 'param': [{'nIdNf': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/osdocs/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ObterDemonst",
"param": [
{
"nIdNf": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/osdocs/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ObterDemonst",
"param": [
{
"nIdNf": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/osdocs/")
corpo = <<~'JSON'
{
"call": "ObterDemonst",
"param": [
{
"nIdNf": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ObterDemonst",
"param": [
{
"nIdNf": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/osdocs/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ObterDemonst"", ""param"": [{""nIdNf"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRetorna as informações do faturamento de uma NFS-e
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
nIdNf | número inteiro | ID 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
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | |
cCodVerif | texto | Código de Verificação da NFS-e. |
cDesStatus | texto | |
cLinkPortal | texto | Link para acessar os documentos no portal Omie. |
cNumNFSe | texto | Número da NFS-e. |
cNumOs | texto | Número da Ordem de Serviço. |
cPdfNFSe | texto | Link para obter o PDF da NFS-e |
cSerieNFSe | texto | Série da NFS-e. |
cUrlNFSe | texto | Link para obter a NFS-e na prefeitura. |
cXmlNFSe | texto | XML 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}]}'import os
import requests
corpo = {'call': 'ObterNFSe', 'param': [{'nIdNf': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/osdocs/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ObterNFSe",
"param": [
{
"nIdNf": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/osdocs/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ObterNFSe",
"param": [
{
"nIdNf": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/osdocs/")
corpo = <<~'JSON'
{
"call": "ObterNFSe",
"param": [
{
"nIdNf": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ObterNFSe",
"param": [
{
"nIdNf": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/osdocs/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ObterNFSe"", ""param"": [{""nIdNf"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRetorna as informações de uma Ordem de Serviço.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
nIdOs | número inteiro |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | |
cDesStatus | texto | |
cLinkPortal | texto | Link para acessar os documentos no portal Omie. |
cNumOs | texto | Número da Ordem de Serviço. |
cPdfOs | texto | Link 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}]}'import os
import requests
corpo = {'call': 'ObterOS', 'param': [{'nIdOs': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/osdocs/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ObterOS",
"param": [
{
"nIdOs": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/osdocs/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ObterOS",
"param": [
{
"nIdOs": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/osdocs/")
corpo = <<~'JSON'
{
"call": "ObterOS",
"param": [
{
"nIdOs": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ObterOS",
"param": [
{
"nIdOs": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/osdocs/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ObterOS"", ""param"": [{""nIdOs"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRetorna as informações do faturamento de um RPS.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
nIdNf | número inteiro | ID 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
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | |
cDesStatus | texto | |
cLinkPortal | texto | Link para acessar os documentos no portal Omie. |
cNumOs | texto | Número da Ordem de Serviço. |
cNumRPS | texto | Número do RPS. |
cPdfRPS | texto | Link para obter o PDF do RPS. |
cSerieRPS | texto | Sé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}]}'import os
import requests
corpo = {'call': 'ObterRPS', 'param': [{'nIdNf': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/osdocs/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ObterRPS",
"param": [
{
"nIdNf": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/osdocs/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ObterRPS",
"param": [
{
"nIdNf": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/osdocs/")
corpo = <<~'JSON'
{
"call": "ObterRPS",
"param": [
{
"nIdNf": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ObterRPS",
"param": [
{
"nIdNf": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/osdocs/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ObterRPS"", ""param"": [{""nIdNf"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRetorna as informações do recibo.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
nIdRec | número inteiro | ID 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
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | |
cDesStatus | texto | |
cLinkPortal | texto | Link para acessar os documentos no portal Omie. |
cNumOs | texto | Número da Ordem de Serviço. |
cNumRecibo | texto | Número do recibo |
cPdfRecibo | texto | Link 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}]}'import os
import requests
corpo = {'call': 'ObterRecibo', 'param': [{'nIdRec': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/osdocs/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ObterRecibo",
"param": [
{
"nIdRec": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/osdocs/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ObterRecibo",
"param": [
{
"nIdRec": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/osdocs/")
corpo = <<~'JSON'
{
"call": "ObterRecibo",
"param": [
{
"nIdRec": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ObterRecibo",
"param": [
{
"nIdRec": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/osdocs/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ObterRecibo"", ""param"": [{""nIdRec"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRetorna as informações do faturamento de uma nota Via Única
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
nIdNf | número inteiro | ID 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
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | |
cDesStatus | texto | |
cLinkPortal | texto | Link para acessar os documentos no portal Omie. |
cModelo | texto | Modelo da nota fiscal Via Única. |
cNumOs | texto | Número da Ordem de Serviço. |
cNumViaUnica | texto | Número da nota fiscal Via Única. |
cPdfViaUnica | texto | Link para obter o PDF da nota fiscal Via Única. |
cSerieViaUnica | texto | Sé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}]}'import os
import requests
corpo = {'call': 'ObterViaUnica', 'param': [{'nIdNf': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/servicos/osdocs/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ObterViaUnica",
"param": [
{
"nIdNf": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/osdocs/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ObterViaUnica",
"param": [
{
"nIdNf": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/osdocs/")
corpo = <<~'JSON'
{
"call": "ObterViaUnica",
"param": [
{
"nIdNf": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ObterViaUnica",
"param": [
{
"nIdNf": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/osdocs/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/servicos/osdocs/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ObterViaUnica"", ""param"": [{""nIdNf"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados