Obter transação

curl --request GET \
  --url https://api.juridiq.com.br/financial/transactions/{id} \
  --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/{id}', 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/{id}",
  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/{id}"

	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/{id}")

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

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

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

GET

financial

transactions

{id}

Obter transação

curl --request GET \
  --url https://api.juridiq.com.br/financial/transactions/{id} \
  --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/{id}', 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/{id}",
  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/{id}"

	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/{id}")

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

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

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

Path Parameters

string

required

ID da transação

Response

Default Response

description

string

required

Descrição

type

string

required

incoming ou outcoming

value

number

required

Valor

date

required

Data

officeId

string<uuid>

required

ID do escritório

string<uuid>

ID da transação

transactionId

string<uuid>

ID da transação

partialValue

number | null

Valor parcial

paymentDate

Data de pagamento

personId

string<uuid> | null

ID da pessoa

billId

string<uuid> | null

ID da conta

categoryId

string<uuid> | null

ID da categoria

lawSuitId

string<uuid> | null

ID do processo

isPaid

boolean

Pago

isFixed

boolean

Fixa

hasScheduling

boolean

Possui parcelamento

installmentLabel

string | null

Rótulo da parcela

annotations

string | null

Anotações

billName

string

Nome da conta

billIcon

string

Ícone da conta

billIsPrivate

boolean

Conta privada

categoryName

string | null

Nome da categoria

categoryColor

string | null

Cor da categoria

categoryIcon

string | null

Ícone da categoria

personName

string | null

Nome da pessoa

lawSuitProcessNumber

string | null

Número do processo

isExternalGateway

boolean

Gateway externo

gateway

object | null

Dados do gateway

Show child attributes

Primeiros Passos

API Reference

Obter transação

Authorizations

Path Parameters

Response