Serviços ·
OrdemServicoLoteFaturamento para Ordens de Serviços em Lote
3consultas
1alteração
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Faturar Ordens de serviço em lote a partir da etapa informada.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 1Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cEtapa | texto · até 2 | Etapa da Operação de Venda. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API /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 |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | |
cDesStatus | texto | |
nIdLoteFat | número inteiro | Id do Lote de Processamento |
nQtdeFat | número inteiro | Qtde de Ordens de Serviço faturadas. |
POST /api/v1/servicos/oslote/
curl -s https://app.omie.com.br/api/v1/servicos/oslote/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "FaturarLoteOS", "param": [{"cEtapa": "50"}]}'import os
import requests
corpo = {'call': 'FaturarLoteOS', 'param': [{'cEtapa': '50'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/oslote/",
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/oslote/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "FaturarLoteOS",
"param": [
{
"cEtapa": "50"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/oslote/");
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": "FaturarLoteOS",
"param": [
{
"cEtapa": "50"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/oslote/")
corpo = <<~'JSON'
{
"call": "FaturarLoteOS",
"param": [
{
"cEtapa": "50"
}
]
}
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": "FaturarLoteOS",
"param": [
{
"cEtapa": "50"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/oslote/"))
.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/oslote/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""FaturarLoteOS"", ""param"": [{""cEtapa"": ""50""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosListar Ordens de serviço faturadas a partir do status informado.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 4Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cStatusLote | texto · até 3 | Có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. |
dDtFat | texto · até 10 | Data de Faturamento |
nPagina | número inteiro | |
nRegistros | número inteiro |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
nPagina | número inteiro | |
nRegistros | número inteiro | |
nTotPaginas | número inteiro | |
nTotRegistros | número inteiro | |
nfseLote | lista de objetos | Notas encontradas para o Status e data de faturamento enviadas |
nfseLote[].cCodVerif | texto | Código de Verificação da NFS-e gerada. |
nfseLote[].cNumContrato | texto | Número do Contrato |
nfseLote[].cNumNfse | texto | Número da NFS-e gerada. |
nfseLote[].cNumOs | texto | Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente) |
nfseLote[].cNumRps | texto | Número do Recibo Provisório de Serviços (RPS). |
nfseLote[].cStatusLote | texto | Có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. |
nfseLote[].dDtFat | texto | Data de Faturamento |
nfseLote[].nCodNF | número inteiro | Código da Nota Fiscal gerada. (Gerado Internamente, não é exibido na tela) |
nfseLote[].nCodOS | número inteiro | ID da Ordem de Serviço (código interno de controle). |
nfseLote[].nLote | número inteiro | Lote da NFS-e gerada. |
POST /api/v1/servicos/oslote/
curl -s https://app.omie.com.br/api/v1/servicos/oslote/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarLoteNfse", "param": [{"dDtFat": "30/09/2026", "cStatusLote": "001"}]}'import os
import requests
corpo = {'call': 'ListarLoteNfse', 'param': [{'dDtFat': '30/09/2026', 'cStatusLote': '001'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/oslote/",
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/oslote/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarLoteNfse",
"param": [
{
"dDtFat": "30/09/2026",
"cStatusLote": "001"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/oslote/");
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": "ListarLoteNfse",
"param": [
{
"dDtFat": "30/09/2026",
"cStatusLote": "001"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/oslote/")
corpo = <<~'JSON'
{
"call": "ListarLoteNfse",
"param": [
{
"dDtFat": "30/09/2026",
"cStatusLote": "001"
}
]
}
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": "ListarLoteNfse",
"param": [
{
"dDtFat": "30/09/2026",
"cStatusLote": "001"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/oslote/"))
.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/oslote/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarLoteNfse"", ""param"": [{""dDtFat"": ""30/09/2026"", ""cStatusLote"": ""001""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosLista status das Ordens de serviço faturadas a partir da data de procesasmento do lote
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 6Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cExibirDetalhes | texto · até 1 | Exibe detalhamento do processamento por lote (S/N). Default "N" |
dDtIncAte | texto · até 10 | Data de Inclusão até do processamento |
dDtIncDe | texto · até 10 | Data de Inclusão do processamento |
nIdLoteFat | número inteiro | Id do Lote de Processamento |
nPagina | número inteiro | |
nRegistros | número inteiro |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
lotes | lista de objetos | Notas encontradas para data de faturamento enviadas |
lotes[].cOrigem | texto | Origem do faturamento. MAN-Manual SCH-Scheduler API - Integração |
lotes[].cStatus | texto | Status do faturamento. RUNNING DONE ERROR |
lotes[].dConclusaoProc | texto | |
lotes[].dInicioProc | texto | |
lotes[].dUltimaAtual | texto | |
lotes[].detalhes | objeto | Ordens de serviços que foram processadas pelo lote filtrado |
lotes[].detalhes.cMensagem | texto | Detalhamento do Status do processamento. |
lotes[].detalhes.cStatus | texto | Status do faturamento. RUNNING DONE ERROR |
lotes[].detalhes.nIdPedido | número inteiro | Id do pedido processado |
lotes[].hConclusaoProc | texto | |
lotes[].hInicioProc | texto | |
lotes[].hUltimaAtual | texto | |
lotes[].nIdLoteFat | número inteiro | Id do Lote de Faturamento da Ordem de Serviço |
lotes[].nQtdeProcessadas | número inteiro | Quantidade de Contrato de Serviços processados |
lotes[].nQtdeTotal | número inteiro | Quantidade de Contrato de Serviço na Fila |
nPagina | número inteiro | |
nRegistros | número inteiro | |
nTotPaginas | número inteiro | |
nTotRegistros | número inteiro |
POST /api/v1/servicos/oslote/
curl -s https://app.omie.com.br/api/v1/servicos/oslote/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarLotesOS", "param": [{"dDtIncDe": "30/09/2026", "dDtIncAte": "30/09/2026"}]}'import os
import requests
corpo = {'call': 'ListarLotesOS',
'param': [{'dDtIncDe': '30/09/2026', 'dDtIncAte': '30/09/2026'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/oslote/",
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/oslote/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarLotesOS",
"param": [
{
"dDtIncDe": "30/09/2026",
"dDtIncAte": "30/09/2026"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/oslote/");
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": "ListarLotesOS",
"param": [
{
"dDtIncDe": "30/09/2026",
"dDtIncAte": "30/09/2026"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/oslote/")
corpo = <<~'JSON'
{
"call": "ListarLotesOS",
"param": [
{
"dDtIncDe": "30/09/2026",
"dDtIncAte": "30/09/2026"
}
]
}
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": "ListarLotesOS",
"param": [
{
"dDtIncDe": "30/09/2026",
"dDtIncAte": "30/09/2026"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/oslote/"))
.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/oslote/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarLotesOS"", ""param"": [{""dDtIncDe"": ""30/09/2026"", ""dDtIncAte"": ""30/09/2026""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosStatus do lote faturado a partir do ID.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 1Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
nIdLoteFat | número inteiro | Id do Lote de Faturamento da Ordem de Serviço |
Retorno 11O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cOrigem | texto | Origem do faturamento. MAN-Manual SCH-Scheduler API - Integração |
cStatus | texto | Status do faturamento. RUNNING DONE ERROR |
dConclusaoProc | texto | |
dInicioProc | texto | |
dUltimaAtual | texto | |
hConclusaoProc | texto | |
hInicioProc | texto | |
hUltimaAtual | texto | |
nIdLoteFat | número inteiro | Id do Lote de Faturamento da Ordem de Serviço |
nQtdeProcessadas | número inteiro | Quantidade de Ordens de Serviço processadas |
nQtdeTotal | número inteiro | Quantidade de Ordens de Serviço na Fila |
POST /api/v1/servicos/oslote/
curl -s https://app.omie.com.br/api/v1/servicos/oslote/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "StatusLoteOS", "param": [{"nIdLoteFat": 45223245}]}'import os
import requests
corpo = {'call': 'StatusLoteOS', 'param': [{'nIdLoteFat': 45223245}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/servicos/oslote/",
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/oslote/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "StatusLoteOS",
"param": [
{
"nIdLoteFat": 45223245
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/servicos/oslote/");
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": "StatusLoteOS",
"param": [
{
"nIdLoteFat": 45223245
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/servicos/oslote/")
corpo = <<~'JSON'
{
"call": "StatusLoteOS",
"param": [
{
"nIdLoteFat": 45223245
}
]
}
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": "StatusLoteOS",
"param": [
{
"nIdLoteFat": 45223245
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/servicos/oslote/"))
.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/oslote/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""StatusLoteOS"", ""param"": [{""nIdLoteFat"": 45223245}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados