Geral · Parcelas

Cadastro de parcelas

POSThttps://app.omie.com.br/api/v1/geral/parcelas/WSDL

1consulta

1alteração

Claude · MCPpelos assistentes de IA

JSON · XMLformato

IncluirParcela

altera dadosClaudeMCP

Método para a criação de uma parcela.

Obrigatórios 1

Campo	Tipo	Descrição
`cParcela`	texto	Descrição da parcela a ser criada Possíveis formatos: "10/20/30/40" - Com este tipo de formatação, o sistema entenderá que deve cadastrar 4 Parcelas. Sendo a primeira para 10 dias, a segunda para 20 dias e, assim, sucessivamente. "A Vista/40/60" - Nesta formatação, será cadastrada para 3 Parcelas. Sendo a primeira a vista, a segunda para 40 dias e, a terceira, para 60 dias. "Para 93 dias" - Com esse preenchimento, será cadastrada uma Parcela para 93 dias após o faturamento. "50" - Ao indicar um número único, o sistema entenderá que se trata da quantidade total de Parcelas. Neste caso, será cadastrado 50 Parcelas.Ex.: `10/20/30/40`, `A Vista/40/60`, `Para 93 dias`

Retorno 4O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodParcela`	texto	Código da parcela gerada.
`cCodStatus`	texto	Código de status da operação ("0" para sucesso).
`cDesParcela`	texto	Descrição da parcela gerada.
`cDesStatus`	texto	Descrição textual do status da operação.

POST /api/v1/geral/parcelas/

curl -s https://app.omie.com.br/api/v1/geral/parcelas/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirParcela", "param": [{"cParcela": ""}]}'

import os
import requests

corpo = {'call': 'IncluirParcela', 'param': [{'cParcela': ''}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/parcelas/",
    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/geral/parcelas/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "IncluirParcela",
    "param": [
      {
        "cParcela": ""
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/parcelas/");
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": "IncluirParcela",
    "param": [
        {
            "cParcela": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/parcelas/")
corpo = <<~'JSON'
{
  "call": "IncluirParcela",
  "param": [
    {
      "cParcela": ""
    }
  ]
}
JSON

resp = Net::HTTP.post(uri, corpo,
  "Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
  "Content-Type" => "application/json")
puts resp.body

import java.net.URI;
import java.net.http.*;

var corpo = """
{
  "call": "IncluirParcela",
  "param": [
    {
      "cParcela": ""
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/parcelas/"))
    .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/geral/parcelas/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""IncluirParcela"", ""param"": [{""cParcela"": """"}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarParcelas

consultaClaudeMCP

Lista de Parcelas cadastradas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 6Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`apenas_importado_api`	texto · até 1	Exibir apenas os registros gerados pela APIEx.: `S`, `N`
`filtrar_por_descricao`	texto · até 100	Filtrar parcelas por descrição.
`ordem_decrescente`	texto · até 1	Se a lista será apresentada em ordem decrescente.Ex.: `S`, `N`
`ordenar_por`	texto · até 100	Ordem de exibição dos dados. Padrão: Código.Ex.: `CODIGO`
`pagina`	número inteiro	Número da página para resgatar os dados.
`registros_por_pagina`	número inteiro	Número de registros a serem exibidos por página. Máximo 50.

Retorno 5O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cadastros`	lista de objetos	Lista os cadastros encontrados.
`cadastros[].cDescricao`	texto	Descrição da parcela.
`cadastros[].nCodigo`	texto	Código da parcela.
`cadastros[].nParcelas`	número inteiro	Número de parcelas.
`pagina`	número inteiro	Número da página retornada
`registros`	número inteiro	Número de registros retornados na página.
`total_de_paginas`	número inteiro	Número total de páginas
`total_de_registros`	número inteiro	Total de registros encontrados.

POST /api/v1/geral/parcelas/

curl -s https://app.omie.com.br/api/v1/geral/parcelas/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarParcelas", "param": [{"pagina": 1, "registros_por_pagina": 50}]}'

import os
import requests

corpo = {'call': 'ListarParcelas', 'param': [{'pagina': 1, 'registros_por_pagina': 50}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/parcelas/",
    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/geral/parcelas/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ListarParcelas",
    "param": [
      {
        "pagina": 1,
        "registros_por_pagina": 50
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/parcelas/");
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": "ListarParcelas",
    "param": [
        {
            "pagina": 1,
            "registros_por_pagina": 50
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/parcelas/")
corpo = <<~'JSON'
{
  "call": "ListarParcelas",
  "param": [
    {
      "pagina": 1,
      "registros_por_pagina": 50
    }
  ]
}
JSON

resp = Net::HTTP.post(uri, corpo,
  "Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
  "Content-Type" => "application/json")
puts resp.body

import java.net.URI;
import java.net.http.*;

var corpo = """
{
  "call": "ListarParcelas",
  "param": [
    {
      "pagina": 1,
      "registros_por_pagina": 50
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/parcelas/"))
    .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/geral/parcelas/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ListarParcelas"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 50}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

Operações

IncluirParcela
ListarParcelas