Inserir Previsão de Contas a Receber

curl --request POST \
  --url https://api.gestio.com.br/v2/financeiro/previsaocontasreceber \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "codigoDaFilial": 1,
  "codigoDoCliente": 1523,
  "codigoDoItemDeLancamento": "<string>",
  "historico": "Aluguel da matriz",
  "id": 42,
  "lancamentoRecorrente": true,
  "lancamentoUnico": true,
  "lancamentoFinalizado": true,
  "frequencia": "M",
  "numeroDeParcelas": 12,
  "numeroDaProximaParcela": 3,
  "diasAntesDoProximoVencimento": 30,
  "dataDoProximoVencimento": "2026-08-10T00:00:00",
  "periodoDeCompetencia": "2023-11-07T05:31:56Z",
  "descricaoDoItemDeLancamento": "<string>",
  "valorDoLancamento": 1500.5,
  "codigoDoCentroDeCusto": "<string>",
  "codigoDaContaCorrente": 123,
  "codigoDaCarteira": 123,
  "codigoDoProjeto": 123,
  "codigoDaClassificacaoAuxiliar": 123,
  "codigoDoTipoDeDocumento": 123,
  "codigoDaFormaDePagamento": 123,
  "numeroDoDocumento": "<string>",
  "numeroDaNFe": 123,
  "observacao": "<string>",
  "tags": [
    "<string>"
  ],
  "ativo": true
}
'

import requests

url = "https://api.gestio.com.br/v2/financeiro/previsaocontasreceber"

payload = {
    "codigoDaFilial": 1,
    "codigoDoCliente": 1523,
    "codigoDoItemDeLancamento": "<string>",
    "historico": "Aluguel da matriz",
    "id": 42,
    "lancamentoRecorrente": True,
    "lancamentoUnico": True,
    "lancamentoFinalizado": True,
    "frequencia": "M",
    "numeroDeParcelas": 12,
    "numeroDaProximaParcela": 3,
    "diasAntesDoProximoVencimento": 30,
    "dataDoProximoVencimento": "2026-08-10T00:00:00",
    "periodoDeCompetencia": "2023-11-07T05:31:56Z",
    "descricaoDoItemDeLancamento": "<string>",
    "valorDoLancamento": 1500.5,
    "codigoDoCentroDeCusto": "<string>",
    "codigoDaContaCorrente": 123,
    "codigoDaCarteira": 123,
    "codigoDoProjeto": 123,
    "codigoDaClassificacaoAuxiliar": 123,
    "codigoDoTipoDeDocumento": 123,
    "codigoDaFormaDePagamento": 123,
    "numeroDoDocumento": "<string>",
    "numeroDaNFe": 123,
    "observacao": "<string>",
    "tags": ["<string>"],
    "ativo": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    codigoDaFilial: 1,
    codigoDoCliente: 1523,
    codigoDoItemDeLancamento: '<string>',
    historico: 'Aluguel da matriz',
    id: 42,
    lancamentoRecorrente: true,
    lancamentoUnico: true,
    lancamentoFinalizado: true,
    frequencia: 'M',
    numeroDeParcelas: 12,
    numeroDaProximaParcela: 3,
    diasAntesDoProximoVencimento: 30,
    dataDoProximoVencimento: '2026-08-10T00:00:00',
    periodoDeCompetencia: '2023-11-07T05:31:56Z',
    descricaoDoItemDeLancamento: '<string>',
    valorDoLancamento: 1500.5,
    codigoDoCentroDeCusto: '<string>',
    codigoDaContaCorrente: 123,
    codigoDaCarteira: 123,
    codigoDoProjeto: 123,
    codigoDaClassificacaoAuxiliar: 123,
    codigoDoTipoDeDocumento: 123,
    codigoDaFormaDePagamento: 123,
    numeroDoDocumento: '<string>',
    numeroDaNFe: 123,
    observacao: '<string>',
    tags: ['<string>'],
    ativo: true
  })
};

fetch('https://api.gestio.com.br/v2/financeiro/previsaocontasreceber', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gestio.com.br/v2/financeiro/previsaocontasreceber",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'codigoDaFilial' => 1,
    'codigoDoCliente' => 1523,
    'codigoDoItemDeLancamento' => '<string>',
    'historico' => 'Aluguel da matriz',
    'id' => 42,
    'lancamentoRecorrente' => true,
    'lancamentoUnico' => true,
    'lancamentoFinalizado' => true,
    'frequencia' => 'M',
    'numeroDeParcelas' => 12,
    'numeroDaProximaParcela' => 3,
    'diasAntesDoProximoVencimento' => 30,
    'dataDoProximoVencimento' => '2026-08-10T00:00:00',
    'periodoDeCompetencia' => '2023-11-07T05:31:56Z',
    'descricaoDoItemDeLancamento' => '<string>',
    'valorDoLancamento' => 1500.5,
    'codigoDoCentroDeCusto' => '<string>',
    'codigoDaContaCorrente' => 123,
    'codigoDaCarteira' => 123,
    'codigoDoProjeto' => 123,
    'codigoDaClassificacaoAuxiliar' => 123,
    'codigoDoTipoDeDocumento' => 123,
    'codigoDaFormaDePagamento' => 123,
    'numeroDoDocumento' => '<string>',
    'numeroDaNFe' => 123,
    'observacao' => '<string>',
    'tags' => [
        '<string>'
    ],
    'ativo' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gestio.com.br/v2/financeiro/previsaocontasreceber"

	payload := strings.NewReader("{\n  \"codigoDaFilial\": 1,\n  \"codigoDoCliente\": 1523,\n  \"codigoDoItemDeLancamento\": \"<string>\",\n  \"historico\": \"Aluguel da matriz\",\n  \"id\": 42,\n  \"lancamentoRecorrente\": true,\n  \"lancamentoUnico\": true,\n  \"lancamentoFinalizado\": true,\n  \"frequencia\": \"M\",\n  \"numeroDeParcelas\": 12,\n  \"numeroDaProximaParcela\": 3,\n  \"diasAntesDoProximoVencimento\": 30,\n  \"dataDoProximoVencimento\": \"2026-08-10T00:00:00\",\n  \"periodoDeCompetencia\": \"2023-11-07T05:31:56Z\",\n  \"descricaoDoItemDeLancamento\": \"<string>\",\n  \"valorDoLancamento\": 1500.5,\n  \"codigoDoCentroDeCusto\": \"<string>\",\n  \"codigoDaContaCorrente\": 123,\n  \"codigoDaCarteira\": 123,\n  \"codigoDoProjeto\": 123,\n  \"codigoDaClassificacaoAuxiliar\": 123,\n  \"codigoDoTipoDeDocumento\": 123,\n  \"codigoDaFormaDePagamento\": 123,\n  \"numeroDoDocumento\": \"<string>\",\n  \"numeroDaNFe\": 123,\n  \"observacao\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"ativo\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gestio.com.br/v2/financeiro/previsaocontasreceber")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoDaFilial\": 1,\n  \"codigoDoCliente\": 1523,\n  \"codigoDoItemDeLancamento\": \"<string>\",\n  \"historico\": \"Aluguel da matriz\",\n  \"id\": 42,\n  \"lancamentoRecorrente\": true,\n  \"lancamentoUnico\": true,\n  \"lancamentoFinalizado\": true,\n  \"frequencia\": \"M\",\n  \"numeroDeParcelas\": 12,\n  \"numeroDaProximaParcela\": 3,\n  \"diasAntesDoProximoVencimento\": 30,\n  \"dataDoProximoVencimento\": \"2026-08-10T00:00:00\",\n  \"periodoDeCompetencia\": \"2023-11-07T05:31:56Z\",\n  \"descricaoDoItemDeLancamento\": \"<string>\",\n  \"valorDoLancamento\": 1500.5,\n  \"codigoDoCentroDeCusto\": \"<string>\",\n  \"codigoDaContaCorrente\": 123,\n  \"codigoDaCarteira\": 123,\n  \"codigoDoProjeto\": 123,\n  \"codigoDaClassificacaoAuxiliar\": 123,\n  \"codigoDoTipoDeDocumento\": 123,\n  \"codigoDaFormaDePagamento\": 123,\n  \"numeroDoDocumento\": \"<string>\",\n  \"numeroDaNFe\": 123,\n  \"observacao\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"ativo\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gestio.com.br/v2/financeiro/previsaocontasreceber")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoDaFilial\": 1,\n  \"codigoDoCliente\": 1523,\n  \"codigoDoItemDeLancamento\": \"<string>\",\n  \"historico\": \"Aluguel da matriz\",\n  \"id\": 42,\n  \"lancamentoRecorrente\": true,\n  \"lancamentoUnico\": true,\n  \"lancamentoFinalizado\": true,\n  \"frequencia\": \"M\",\n  \"numeroDeParcelas\": 12,\n  \"numeroDaProximaParcela\": 3,\n  \"diasAntesDoProximoVencimento\": 30,\n  \"dataDoProximoVencimento\": \"2026-08-10T00:00:00\",\n  \"periodoDeCompetencia\": \"2023-11-07T05:31:56Z\",\n  \"descricaoDoItemDeLancamento\": \"<string>\",\n  \"valorDoLancamento\": 1500.5,\n  \"codigoDoCentroDeCusto\": \"<string>\",\n  \"codigoDaContaCorrente\": 123,\n  \"codigoDaCarteira\": 123,\n  \"codigoDoProjeto\": 123,\n  \"codigoDaClassificacaoAuxiliar\": 123,\n  \"codigoDoTipoDeDocumento\": 123,\n  \"codigoDaFormaDePagamento\": 123,\n  \"numeroDoDocumento\": \"<string>\",\n  \"numeroDaNFe\": 123,\n  \"observacao\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"ativo\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "codigoDaFilial": 1,
    "codigoDoCliente": 1523,
    "codigoDoItemDeLancamento": "<string>",
    "historico": "Aluguel da matriz",
    "id": 42,
    "lancamentoRecorrente": true,
    "lancamentoUnico": true,
    "lancamentoFinalizado": true,
    "frequencia": "M",
    "numeroDeParcelas": 12,
    "numeroDaProximaParcela": 3,
    "diasAntesDoProximoVencimento": 30,
    "dataDoProximoVencimento": "2026-08-10T00:00:00",
    "dataDaUltimaEmissao": "2023-11-07T05:31:56Z",
    "periodoDeCompetencia": "2023-11-07T05:31:56Z",
    "descricaoDaFilial": "Matriz",
    "descricaoDoCliente": "<string>",
    "descricaoDoItemDeLancamento": "<string>",
    "valorDoLancamento": 1500.5,
    "codigoDoCentroDeCusto": "<string>",
    "codigoDaContaCorrente": 123,
    "codigoDaCarteira": 123,
    "codigoDoProjeto": 123,
    "descricaoDoProjeto": "<string>",
    "codigoDaClassificacaoAuxiliar": 123,
    "codigoDoTipoDeDocumento": 123,
    "codigoDaFormaDePagamento": 123,
    "descricaoDaFormaDePagamento": "<string>",
    "numeroDoDocumento": "<string>",
    "numeroDaNFe": 123,
    "observacao": "<string>",
    "descricaoDaParcela": "<string>",
    "status": "<string>",
    "tags": [
      "<string>"
    ],
    "ativo": true,
    "ultimaAtualizacao": "<string>"
  }
}

{
  "success": false,
  "errors": [
    {
      "key": "<string>",
      "value": "<string>",
      "dateOccurred": "2023-11-07T05:31:56Z"
    }
  ]
}

POST

financeiro

previsaocontasreceber

Inserir Previsão de Contas a Receber

curl --request POST \
  --url https://api.gestio.com.br/v2/financeiro/previsaocontasreceber \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "codigoDaFilial": 1,
  "codigoDoCliente": 1523,
  "codigoDoItemDeLancamento": "<string>",
  "historico": "Aluguel da matriz",
  "id": 42,
  "lancamentoRecorrente": true,
  "lancamentoUnico": true,
  "lancamentoFinalizado": true,
  "frequencia": "M",
  "numeroDeParcelas": 12,
  "numeroDaProximaParcela": 3,
  "diasAntesDoProximoVencimento": 30,
  "dataDoProximoVencimento": "2026-08-10T00:00:00",
  "periodoDeCompetencia": "2023-11-07T05:31:56Z",
  "descricaoDoItemDeLancamento": "<string>",
  "valorDoLancamento": 1500.5,
  "codigoDoCentroDeCusto": "<string>",
  "codigoDaContaCorrente": 123,
  "codigoDaCarteira": 123,
  "codigoDoProjeto": 123,
  "codigoDaClassificacaoAuxiliar": 123,
  "codigoDoTipoDeDocumento": 123,
  "codigoDaFormaDePagamento": 123,
  "numeroDoDocumento": "<string>",
  "numeroDaNFe": 123,
  "observacao": "<string>",
  "tags": [
    "<string>"
  ],
  "ativo": true
}
'

import requests

url = "https://api.gestio.com.br/v2/financeiro/previsaocontasreceber"

payload = {
    "codigoDaFilial": 1,
    "codigoDoCliente": 1523,
    "codigoDoItemDeLancamento": "<string>",
    "historico": "Aluguel da matriz",
    "id": 42,
    "lancamentoRecorrente": True,
    "lancamentoUnico": True,
    "lancamentoFinalizado": True,
    "frequencia": "M",
    "numeroDeParcelas": 12,
    "numeroDaProximaParcela": 3,
    "diasAntesDoProximoVencimento": 30,
    "dataDoProximoVencimento": "2026-08-10T00:00:00",
    "periodoDeCompetencia": "2023-11-07T05:31:56Z",
    "descricaoDoItemDeLancamento": "<string>",
    "valorDoLancamento": 1500.5,
    "codigoDoCentroDeCusto": "<string>",
    "codigoDaContaCorrente": 123,
    "codigoDaCarteira": 123,
    "codigoDoProjeto": 123,
    "codigoDaClassificacaoAuxiliar": 123,
    "codigoDoTipoDeDocumento": 123,
    "codigoDaFormaDePagamento": 123,
    "numeroDoDocumento": "<string>",
    "numeroDaNFe": 123,
    "observacao": "<string>",
    "tags": ["<string>"],
    "ativo": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    codigoDaFilial: 1,
    codigoDoCliente: 1523,
    codigoDoItemDeLancamento: '<string>',
    historico: 'Aluguel da matriz',
    id: 42,
    lancamentoRecorrente: true,
    lancamentoUnico: true,
    lancamentoFinalizado: true,
    frequencia: 'M',
    numeroDeParcelas: 12,
    numeroDaProximaParcela: 3,
    diasAntesDoProximoVencimento: 30,
    dataDoProximoVencimento: '2026-08-10T00:00:00',
    periodoDeCompetencia: '2023-11-07T05:31:56Z',
    descricaoDoItemDeLancamento: '<string>',
    valorDoLancamento: 1500.5,
    codigoDoCentroDeCusto: '<string>',
    codigoDaContaCorrente: 123,
    codigoDaCarteira: 123,
    codigoDoProjeto: 123,
    codigoDaClassificacaoAuxiliar: 123,
    codigoDoTipoDeDocumento: 123,
    codigoDaFormaDePagamento: 123,
    numeroDoDocumento: '<string>',
    numeroDaNFe: 123,
    observacao: '<string>',
    tags: ['<string>'],
    ativo: true
  })
};

fetch('https://api.gestio.com.br/v2/financeiro/previsaocontasreceber', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gestio.com.br/v2/financeiro/previsaocontasreceber",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'codigoDaFilial' => 1,
    'codigoDoCliente' => 1523,
    'codigoDoItemDeLancamento' => '<string>',
    'historico' => 'Aluguel da matriz',
    'id' => 42,
    'lancamentoRecorrente' => true,
    'lancamentoUnico' => true,
    'lancamentoFinalizado' => true,
    'frequencia' => 'M',
    'numeroDeParcelas' => 12,
    'numeroDaProximaParcela' => 3,
    'diasAntesDoProximoVencimento' => 30,
    'dataDoProximoVencimento' => '2026-08-10T00:00:00',
    'periodoDeCompetencia' => '2023-11-07T05:31:56Z',
    'descricaoDoItemDeLancamento' => '<string>',
    'valorDoLancamento' => 1500.5,
    'codigoDoCentroDeCusto' => '<string>',
    'codigoDaContaCorrente' => 123,
    'codigoDaCarteira' => 123,
    'codigoDoProjeto' => 123,
    'codigoDaClassificacaoAuxiliar' => 123,
    'codigoDoTipoDeDocumento' => 123,
    'codigoDaFormaDePagamento' => 123,
    'numeroDoDocumento' => '<string>',
    'numeroDaNFe' => 123,
    'observacao' => '<string>',
    'tags' => [
        '<string>'
    ],
    'ativo' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gestio.com.br/v2/financeiro/previsaocontasreceber"

	payload := strings.NewReader("{\n  \"codigoDaFilial\": 1,\n  \"codigoDoCliente\": 1523,\n  \"codigoDoItemDeLancamento\": \"<string>\",\n  \"historico\": \"Aluguel da matriz\",\n  \"id\": 42,\n  \"lancamentoRecorrente\": true,\n  \"lancamentoUnico\": true,\n  \"lancamentoFinalizado\": true,\n  \"frequencia\": \"M\",\n  \"numeroDeParcelas\": 12,\n  \"numeroDaProximaParcela\": 3,\n  \"diasAntesDoProximoVencimento\": 30,\n  \"dataDoProximoVencimento\": \"2026-08-10T00:00:00\",\n  \"periodoDeCompetencia\": \"2023-11-07T05:31:56Z\",\n  \"descricaoDoItemDeLancamento\": \"<string>\",\n  \"valorDoLancamento\": 1500.5,\n  \"codigoDoCentroDeCusto\": \"<string>\",\n  \"codigoDaContaCorrente\": 123,\n  \"codigoDaCarteira\": 123,\n  \"codigoDoProjeto\": 123,\n  \"codigoDaClassificacaoAuxiliar\": 123,\n  \"codigoDoTipoDeDocumento\": 123,\n  \"codigoDaFormaDePagamento\": 123,\n  \"numeroDoDocumento\": \"<string>\",\n  \"numeroDaNFe\": 123,\n  \"observacao\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"ativo\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gestio.com.br/v2/financeiro/previsaocontasreceber")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoDaFilial\": 1,\n  \"codigoDoCliente\": 1523,\n  \"codigoDoItemDeLancamento\": \"<string>\",\n  \"historico\": \"Aluguel da matriz\",\n  \"id\": 42,\n  \"lancamentoRecorrente\": true,\n  \"lancamentoUnico\": true,\n  \"lancamentoFinalizado\": true,\n  \"frequencia\": \"M\",\n  \"numeroDeParcelas\": 12,\n  \"numeroDaProximaParcela\": 3,\n  \"diasAntesDoProximoVencimento\": 30,\n  \"dataDoProximoVencimento\": \"2026-08-10T00:00:00\",\n  \"periodoDeCompetencia\": \"2023-11-07T05:31:56Z\",\n  \"descricaoDoItemDeLancamento\": \"<string>\",\n  \"valorDoLancamento\": 1500.5,\n  \"codigoDoCentroDeCusto\": \"<string>\",\n  \"codigoDaContaCorrente\": 123,\n  \"codigoDaCarteira\": 123,\n  \"codigoDoProjeto\": 123,\n  \"codigoDaClassificacaoAuxiliar\": 123,\n  \"codigoDoTipoDeDocumento\": 123,\n  \"codigoDaFormaDePagamento\": 123,\n  \"numeroDoDocumento\": \"<string>\",\n  \"numeroDaNFe\": 123,\n  \"observacao\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"ativo\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gestio.com.br/v2/financeiro/previsaocontasreceber")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoDaFilial\": 1,\n  \"codigoDoCliente\": 1523,\n  \"codigoDoItemDeLancamento\": \"<string>\",\n  \"historico\": \"Aluguel da matriz\",\n  \"id\": 42,\n  \"lancamentoRecorrente\": true,\n  \"lancamentoUnico\": true,\n  \"lancamentoFinalizado\": true,\n  \"frequencia\": \"M\",\n  \"numeroDeParcelas\": 12,\n  \"numeroDaProximaParcela\": 3,\n  \"diasAntesDoProximoVencimento\": 30,\n  \"dataDoProximoVencimento\": \"2026-08-10T00:00:00\",\n  \"periodoDeCompetencia\": \"2023-11-07T05:31:56Z\",\n  \"descricaoDoItemDeLancamento\": \"<string>\",\n  \"valorDoLancamento\": 1500.5,\n  \"codigoDoCentroDeCusto\": \"<string>\",\n  \"codigoDaContaCorrente\": 123,\n  \"codigoDaCarteira\": 123,\n  \"codigoDoProjeto\": 123,\n  \"codigoDaClassificacaoAuxiliar\": 123,\n  \"codigoDoTipoDeDocumento\": 123,\n  \"codigoDaFormaDePagamento\": 123,\n  \"numeroDoDocumento\": \"<string>\",\n  \"numeroDaNFe\": 123,\n  \"observacao\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"ativo\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "codigoDaFilial": 1,
    "codigoDoCliente": 1523,
    "codigoDoItemDeLancamento": "<string>",
    "historico": "Aluguel da matriz",
    "id": 42,
    "lancamentoRecorrente": true,
    "lancamentoUnico": true,
    "lancamentoFinalizado": true,
    "frequencia": "M",
    "numeroDeParcelas": 12,
    "numeroDaProximaParcela": 3,
    "diasAntesDoProximoVencimento": 30,
    "dataDoProximoVencimento": "2026-08-10T00:00:00",
    "dataDaUltimaEmissao": "2023-11-07T05:31:56Z",
    "periodoDeCompetencia": "2023-11-07T05:31:56Z",
    "descricaoDaFilial": "Matriz",
    "descricaoDoCliente": "<string>",
    "descricaoDoItemDeLancamento": "<string>",
    "valorDoLancamento": 1500.5,
    "codigoDoCentroDeCusto": "<string>",
    "codigoDaContaCorrente": 123,
    "codigoDaCarteira": 123,
    "codigoDoProjeto": 123,
    "descricaoDoProjeto": "<string>",
    "codigoDaClassificacaoAuxiliar": 123,
    "codigoDoTipoDeDocumento": 123,
    "codigoDaFormaDePagamento": 123,
    "descricaoDaFormaDePagamento": "<string>",
    "numeroDoDocumento": "<string>",
    "numeroDaNFe": 123,
    "observacao": "<string>",
    "descricaoDaParcela": "<string>",
    "status": "<string>",
    "tags": [
      "<string>"
    ],
    "ativo": true,
    "ultimaAtualizacao": "<string>"
  }
}

{
  "success": false,
  "errors": [
    {
      "key": "<string>",
      "value": "<string>",
      "dateOccurred": "2023-11-07T05:31:56Z"
    }
  ]
}

Para lançamento recorrente envie lancamentoRecorrente, frequencia e numeroDeParcelas; para lançamento único use lancamentoUnico.

Authorizations

Authorization

string

header

required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Previsão (lançamento previsto/recorrente) de Contas a Receber. Usada na inclusão (POST) e nas respostas de consulta. Na inclusão o id é ignorado e gerado automaticamente.

codigoDaFilial

integer<int16>

required

Código da Filial. Deve ser uma Filial válida da empresa.

Example:

1

codigoDoCliente

integer<int32>

required

Código do Cliente. Deve ser um Cliente válido da empresa.

Example:

1523

codigoDoItemDeLancamento

string | null

required

Código da Categoria (Item de Lançamento) do movimento.

historico

string | null

required

Histórico/descrição do lançamento previsto.

Example:

"Aluguel da matriz"

number<decimal>

Id da previsão. Ignorado e gerado automaticamente na inclusão (POST).

Example:

42

lancamentoRecorrente

boolean

Indica previsão recorrente, que gera um título a cada parcela.

lancamentoUnico

boolean

Indica previsão de parcela única.

lancamentoFinalizado

boolean

Indica que a previsão já gerou todas as parcelas previstas.

frequencia

string | null

Código da frequência da previsão: U (única), M (mensal), W (semanal), Q (quinzenal), B (bimestral), T (trimestral), S (semestral) ou A (anual). Na inclusão também aceita a descrição (ex.: Mensal).

Example:

"M"

numeroDeParcelas

integer<int16>

Quantidade total de parcelas previstas.

Example:

12

numeroDaProximaParcela

integer<int16>

Número da próxima parcela a ser gerada.

Example:

3

diasAntesDoProximoVencimento

integer<int16>

Quantos dias antes do vencimento o título é gerado. Padrão de 30 dias quando não informado.

Example:

30

dataDoProximoVencimento

string<date-time> | null

Data de vencimento da próxima parcela.

Example:

"2026-08-10T00:00:00"

periodoDeCompetencia

string<date-time> | null

Período de competência do lançamento.

descricaoDoItemDeLancamento

string | null

valorDoLancamento

number<double>

Valor previsto de cada parcela.

Example:

1500.5

codigoDoCentroDeCusto

string | null

Código do Centro de Custo do movimento.

codigoDaContaCorrente

integer<int16> | null

Código da Conta Corrente usada na geração do título.

codigoDaCarteira

integer<int16> | null

Código da Carteira de cobrança, quando aplicável.

codigoDoProjeto

integer<int32> | null

Código do Projeto; quando informado deve ser um Projeto válido da empresa.

codigoDaClassificacaoAuxiliar

integer<int32> | null

Código da Classificação Auxiliar do movimento.

codigoDoTipoDeDocumento

integer<int16> | null

Código do Tipo de Documento do título gerado.

codigoDaFormaDePagamento

integer<int16> | null

Código da Forma de Pagamento do título gerado.

numeroDoDocumento

string | null

Número do documento do título gerado.

numeroDaNFe

number | null

Número da NF-e vinculada à previsão, quando aplicável.

observacao

string | null

Response

Previsão inserida com sucesso.

success

boolean

Example:

true

data

object

Previsão (lançamento previsto/recorrente) de Contas a Receber. Usada na inclusão (POST) e nas respostas de consulta. Na inclusão o id é ignorado e gerado automaticamente.

Show child attributes

Primeiros passos

Autenticação

Cadastro

Compras

Estoque

Financeiro

Vendas

Webhooks

Utilitários

Inserir Previsão de Contas a Receber

Authorizations

Body

Response