Registrar pagamento parcial de uma transação

curl --request POST \
  --url https://api.juridiq.com.br/financial/transactions/{id}/payments \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "value": 123,
  "paymentDate": "<string>",
  "observation": "<string>"
}
'

import requests

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

payload = {
    "value": 123,
    "paymentDate": "<string>",
    "observation": "<string>"
}
headers = {
    "x-juridiq-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: 123, paymentDate: '<string>', observation: '<string>'})
};

fetch('https://api.juridiq.com.br/financial/transactions/{id}/payments', 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}/payments",
  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([
    'value' => 123,
    'paymentDate' => '<string>',
    'observation' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"value\": 123,\n  \"paymentDate\": \"<string>\",\n  \"observation\": \"<string>\"\n}")

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

	req.Header.Add("x-juridiq-api-key", "<api-key>")
	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.juridiq.com.br/financial/transactions/{id}/payments")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": 123,\n  \"paymentDate\": \"<string>\",\n  \"observation\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/financial/transactions/{id}/payments")

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

request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": 123,\n  \"paymentDate\": \"<string>\",\n  \"observation\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "value": 123,
  "paymentDate": "<string>",
  "paymentMethod": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "observation": "<string>"
}

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

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

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

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

Financial

Registrar pagamento parcial de uma transação

Registra um pagamento (valor, data e forma) do lançamento. A soma dos pagamentos não pode passar do valor do lançamento (400). Se o lançamento tem baixa parcial antiga, sem pagamentos registrados, ela vira antes um pagamento com forma OTHER, na data de vencimento ou na do novo pagamento, a que for anterior. Quando a soma alcança o valor, o lançamento fica pago na data do pagamento mais recente. Nos períodos por data efetiva e por data de pagamento, cada pagamento de lançamento pendente conta no mês da própria data. Exige permissão de editar o financeiro com JWT; aceita o header x-juridiq-api-key.

POST

financial

transactions

{id}

payments

Registrar pagamento parcial de uma transação

curl --request POST \
  --url https://api.juridiq.com.br/financial/transactions/{id}/payments \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "value": 123,
  "paymentDate": "<string>",
  "observation": "<string>"
}
'

import requests

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

payload = {
    "value": 123,
    "paymentDate": "<string>",
    "observation": "<string>"
}
headers = {
    "x-juridiq-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: 123, paymentDate: '<string>', observation: '<string>'})
};

fetch('https://api.juridiq.com.br/financial/transactions/{id}/payments', 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}/payments",
  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([
    'value' => 123,
    'paymentDate' => '<string>',
    'observation' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"value\": 123,\n  \"paymentDate\": \"<string>\",\n  \"observation\": \"<string>\"\n}")

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

	req.Header.Add("x-juridiq-api-key", "<api-key>")
	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.juridiq.com.br/financial/transactions/{id}/payments")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": 123,\n  \"paymentDate\": \"<string>\",\n  \"observation\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/financial/transactions/{id}/payments")

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

request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": 123,\n  \"paymentDate\": \"<string>\",\n  \"observation\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "value": 123,
  "paymentDate": "<string>",
  "paymentMethod": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "observation": "<string>"
}

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

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

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

Path Parameters

string

required

ID da transação

Body

application/json

value

number

required

Valor pago

paymentDate

string

required

Data do pagamento: YYYY-MM-DD, que conta como meia-noite UTC. Com hora ISO 8601, o dia e o mês contam em UTC, e hora sem fuso segue o fuso do servidor; para o dia local, envie só a data

paymentMethod

enum<string>

required

Forma de pagamento

Available options:

CASH,

PIX,

BOLETO,

CREDIT_CARD,

DEBIT_CARD,

BANK_TRANSFER,

CHECK,

OTHER

observation

string

Observação

Response

Default Response

string<uuid>

required

ID do pagamento

transactionId

string<uuid>

required

ID da transação

officeId

string<uuid>

required

ID do escritório

value

number

required

Valor pago

paymentDate

required

Data do pagamento

paymentMethod

string

required

Forma de pagamento

createdAt

required

Criado em

updatedAt

required

Atualizado em

observation

string | null

Observação

Primeiros Passos

API Reference

Registrar pagamento parcial de uma transação

Authorizations

Path Parameters

Body

Response