Listar transações

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

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

fetch('https://api.juridiq.com.br/financial/transactions', 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",
  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"

	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")

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

{
  "data": [
    {
      "description": "<string>",
      "type": "<string>",
      "value": 123,
      "date": "<string>",
      "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partialValue": 123,
      "paymentDate": "<string>",
      "personId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lawSuitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isPaid": true,
      "isFixed": true,
      "hasScheduling": true,
      "installmentLabel": "<string>",
      "annotations": "<string>",
      "billName": "<string>",
      "billIcon": "<string>",
      "billIsPrivate": true,
      "categoryName": "<string>",
      "categoryColor": "<string>",
      "categoryIcon": "<string>",
      "personName": "<string>",
      "lawSuitProcessNumber": "<string>",
      "isExternalGateway": true,
      "gateway": {
        "kind": "PAYMENT",
        "value": 123,
        "createdAt": "<string>",
        "status": "<string>",
        "dueDate": "<string>",
        "paymentDate": "<string>",
        "installmentNumber": 123,
        "discount": {
          "value": 123,
          "dueDateLimitDays": 1,
          "type": "FIXED"
        },
        "fine": {
          "value": 123,
          "type": "FIXED"
        },
        "interest": {
          "value": 123
        },
        "invoiceUrl": "<string>",
        "gatewayPaymentUrl": "<string>"
      }
    }
  ],
  "totals": {
    "total": 123,
    "incoming": 123,
    "outcoming": 123
  },
  "chartIncome": {
    "partialValue": 123,
    "totalValue": 123
  },
  "chartOutcome": {
    "partialValue": 123,
    "totalValue": 123
  },
  "totalResults": 123,
  "totalPages": 123,
  "currentPage": 123
}

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

GET

financial

transactions

Listar transações

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

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

fetch('https://api.juridiq.com.br/financial/transactions', 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",
  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"

	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")

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

{
  "data": [
    {
      "description": "<string>",
      "type": "<string>",
      "value": 123,
      "date": "<string>",
      "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partialValue": 123,
      "paymentDate": "<string>",
      "personId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lawSuitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isPaid": true,
      "isFixed": true,
      "hasScheduling": true,
      "installmentLabel": "<string>",
      "annotations": "<string>",
      "billName": "<string>",
      "billIcon": "<string>",
      "billIsPrivate": true,
      "categoryName": "<string>",
      "categoryColor": "<string>",
      "categoryIcon": "<string>",
      "personName": "<string>",
      "lawSuitProcessNumber": "<string>",
      "isExternalGateway": true,
      "gateway": {
        "kind": "PAYMENT",
        "value": 123,
        "createdAt": "<string>",
        "status": "<string>",
        "dueDate": "<string>",
        "paymentDate": "<string>",
        "installmentNumber": 123,
        "discount": {
          "value": 123,
          "dueDateLimitDays": 1,
          "type": "FIXED"
        },
        "fine": {
          "value": 123,
          "type": "FIXED"
        },
        "interest": {
          "value": 123
        },
        "invoiceUrl": "<string>",
        "gatewayPaymentUrl": "<string>"
      }
    }
  ],
  "totals": {
    "total": 123,
    "incoming": 123,
    "outcoming": 123
  },
  "chartIncome": {
    "partialValue": 123,
    "totalValue": 123
  },
  "chartOutcome": {
    "partialValue": 123,
    "totalValue": 123
  },
  "totalResults": 123,
  "totalPages": 123,
  "currentPage": 123
}

{
  "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

page

string

Página

limit

string

Itens por página

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

periodType

string

monthly, annual ou custom

startDate

string

Data inicial

endDate

string

Data final

dateFilterType

enum<string>

Campo de data

Available options:

date,

paymentAt

periodByDate

enum<string>

Período por data

Available options:

date,

paymentDate

orderBy

string

Ordenação

orderByField

string

Campo de ordenação

description

string

Descrição

value

string

Valor

date

string

Data

personId

string

ID da pessoa

accountId

string

ID da conta

lawSuitId

string

ID do processo

month

string

Mês

year

string

Ano

start

string

Início do período

end

string

Fim do período

isPaid

string

true ou false

isDefaulters

string

true ou false

Response

Default Response

data

object[]

required

Transações

Show child attributes

totals

object

required

Totais

Show child attributes

chartIncome

object

required

Gráfico de entradas

Show child attributes

chartOutcome

object

required

Gráfico de saídas

Show child attributes

totalResults

number

required

Total de registros

totalPages

number

required

Total de páginas

currentPage

number

required

Página atual

Primeiros Passos

API Reference

Listar transações

Authorizations

Query Parameters

Response