Todas as coleções
APIs
Exemplos de API
Incluindo uma Conta a Pagar via API
Incluindo uma Conta a Pagar via API

Nesse artigo, descubra como incluir uma conta a pagar por API

Hugo Alves avatar
Escrito por Hugo Alves
Atualizado há mais de uma semana

Antes que possa começar de fato os testes com a nossa API, é importante que conheça alguns processos básicos:

💡 #DicaDoBem: Atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como é o caso do Postman, Insomnia e o ThunderClient (uma extensão do VS Code)

Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para o seu 😉

Nesse artigo, temos:


Obtendo os dados necessários

Para incluir a conta a receber será necessário já ter alguns dados para enviar como parâmetros nas requisições

Para a requisição padrão, é necessário já ter:


Incluindo a conta a pagar

Para esse processo utilizaremos o seguinte método: IncluirContaPagar

Aqui no exemplo, utilizaremos a requisição padrão, conforme abaixo:

{
"codigo_lancamento_integracao": "1692009888",
"codigo_cliente_fornecedor": 4214850,
"data_vencimento": "14/08/2023",
"valor_documento": 100,
"codigo_categoria": "2.04.01",
"data_previsao": "14/08/2023",
"id_conta_corrente": 4243124
}

Mas se quiser, você pode adicionar mais parâmetros disponíveis aqui:

Para realizar o teste, clique em "Executar":

No lado direito você terá disponível algumas informações bem importantes:

  • 2) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos;

  • 3) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso

  • 4) Corpo: é nessa parte que serão exibidos todos os retornos da requisição enviada. No nosso caso, como foi uma inclusão, ele retorna também o "codigo_lancamento_omie" específico dessa conta a pagar

Prontinho! Sua conta a pagar foi cadastrada com sucesso!


📌 Separamos alguns artigos relacionados que podem te ajudar bastante:

Respondeu à sua pergunta?