Relatório mensal de transações por conta

curl --request GET \
  --url https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report \
  --header 'x-juridiq-api-key: <api-key>'

import requests

url = "https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report"

headers = {"x-juridiq-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report', 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.juridiq.com.br/financial/transactions/by-tags/monthly-report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report")

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

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

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

{
  "periods": [
    "<string>"
  ],
  "totalsByPeriod": {},
  "grandTotals": {
    "income": 123,
    "expense": 123,
    "balance": 123
  },
  "rows": [
    {
      "categoryId": "<string>",
      "categoryName": "<string>",
      "totals": {
        "income": 123,
        "expense": 123,
        "balance": 123
      },
      "months": {},
      "billId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billName": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Financial

Relatório mensal de transações por conta

Receitas, despesas e saldo por mês, de start a end (YYYY-MM ou data, até 24 meses), agrupados por conta. Cada lançamento entra no mês da data de periodByDate; sem periodByDate nem dateFilterType, lançamento pago entra no mês da data de pagamento (sem data registrada, no do vencimento) e pendente no do vencimento; pendente soma só a baixa parcial. Fora de periodByDate=date, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado (com status=pending, isPaid=false ou isDefaulters, pelo vencimento). Contas privadas só aparecem para Suporte ou responsáveis da conta. Exige permissão de ver o saldo financeiro (403). Aceita JWT ou o header x-juridiq-api-key.

GET

financial

transactions

by-tags

monthly-report

Relatório mensal de transações por conta

curl --request GET \
  --url https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report \
  --header 'x-juridiq-api-key: <api-key>'

import requests

url = "https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report"

headers = {"x-juridiq-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report', 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.juridiq.com.br/financial/transactions/by-tags/monthly-report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/financial/transactions/by-tags/monthly-report")

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

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

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

{
  "periods": [
    "<string>"
  ],
  "totalsByPeriod": {},
  "grandTotals": {
    "income": 123,
    "expense": 123,
    "balance": 123
  },
  "rows": [
    {
      "categoryId": "<string>",
      "categoryName": "<string>",
      "totals": {
        "income": 123,
        "expense": 123,
        "balance": 123
      },
      "months": {},
      "billId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billName": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Query Parameters

start

string

Data inicial

end

string

Data final

startPeriod

string

Período inicial (alternativo)

endPeriod

string

Período final (alternativo)

query

string

Busca geral

descriptionSearch

string

Busca por descrição

clientSearch

string

Busca por cliente

categoryId

string

ID da categoria

type

string

incoming ou outcoming

billId

string

ID da conta

status

string

paid ou pending

dateFilterType

enum<string>

Forma antiga de periodByDate: date (vencimento) ou paymentAt (pagamento); periodByDate prevalece

Available options:

date,

paymentAt

periodByDate

enum<string>

Campo de data do período: date (vencimento) ou paymentDate (pagamento). Omitido, junto com dateFilterType: lançamento pago entra pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento. Fora de date, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado (com status=pending, isPaid=false ou isDefaulters, pelo vencimento)

Available options:

date,

paymentDate

description

string

Descrição

value

string

Valor

personId

string

ID da pessoa

lawSuitId

string

ID do processo

partnerId

string

ID do parceiro financeiro

isPaid

string

true ou false

isDefaulters

string

true ou false

Response

Default Response

periods

string[]

required

Períodos

totalsByPeriod

object

required

Totais por período

Show child attributes

grandTotals

object

required

Totais gerais

Show child attributes

rows

object[]

required

Linhas do relatório

Show child attributes

Primeiros Passos

API Reference

Relatório mensal de transações por conta

Authorizations

Query Parameters

Response