Listar parcelas de transação

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

import requests

url = "https://api.juridiq.com.br/financial/transactions/{id}/installments"

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/{id}/installments', 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}/installments",
  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}/installments"

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

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

{
  "schedulingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "totalValue": 123,
  "installmentCount": 123,
  "individualValue": 123,
  "paidCount": 123,
  "paidSum": 123,
  "installments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "installmentNumber": 123,
      "totalInstallments": 123,
      "value": 123,
      "date": "<string>",
      "isPaid": true,
      "paymentDate": "<string>"
    }
  ]
}

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

GET

financial

transactions

{id}

installments

Listar parcelas de transação

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

import requests

url = "https://api.juridiq.com.br/financial/transactions/{id}/installments"

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/{id}/installments', 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}/installments",
  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}/installments"

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

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

{
  "schedulingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "totalValue": 123,
  "installmentCount": 123,
  "individualValue": 123,
  "paidCount": 123,
  "paidSum": 123,
  "installments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "installmentNumber": 123,
      "totalInstallments": 123,
      "value": 123,
      "date": "<string>",
      "isPaid": true,
      "paymentDate": "<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.

Path Parameters

string

required

ID da transação

Response

Default Response

schedulingId

string<uuid> | null

required

ID do agendamento

totalValue

number

required

Valor total

installmentCount

number

required

Quantidade de parcelas

individualValue

number

required

Valor individual

paidCount

number

required

Parcelas pagas

paidSum

number

required

Soma paga

installments

object[]

required

Parcelas

Show child attributes

Primeiros Passos

API Reference

Listar parcelas de transação

Authorizations

Path Parameters

Response