Criar transação
curl --request POST \
--url https://api.juridiq.com.br/financial/transactions \
--header 'Content-Type: application/json' \
--header 'x-juridiq-api-key: <api-key>' \
--data '
{
"description": "<string>",
"value": 123,
"date": "<string>",
"officeId": "<string>",
"personId": "<string>",
"billId": "<string>",
"categoryId": "<string>",
"lawSuitId": "<string>",
"isPaid": true,
"installmentCount": 123,
"repetitionTransactionType": "<string>",
"repetitionType": "<string>",
"annotations": "<string>",
"partialValue": "<string>",
"paymentDate": "<string>"
}
'import requests
url = "https://api.juridiq.com.br/financial/transactions"
payload = {
"description": "<string>",
"value": 123,
"date": "<string>",
"officeId": "<string>",
"personId": "<string>",
"billId": "<string>",
"categoryId": "<string>",
"lawSuitId": "<string>",
"isPaid": True,
"installmentCount": 123,
"repetitionTransactionType": "<string>",
"repetitionType": "<string>",
"annotations": "<string>",
"partialValue": "<string>",
"paymentDate": "<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({
description: '<string>',
value: 123,
date: '<string>',
officeId: '<string>',
personId: '<string>',
billId: '<string>',
categoryId: '<string>',
lawSuitId: '<string>',
isPaid: true,
installmentCount: 123,
repetitionTransactionType: '<string>',
repetitionType: '<string>',
annotations: '<string>',
partialValue: '<string>',
paymentDate: '<string>'
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'value' => 123,
'date' => '<string>',
'officeId' => '<string>',
'personId' => '<string>',
'billId' => '<string>',
'categoryId' => '<string>',
'lawSuitId' => '<string>',
'isPaid' => true,
'installmentCount' => 123,
'repetitionTransactionType' => '<string>',
'repetitionType' => '<string>',
'annotations' => '<string>',
'partialValue' => '<string>',
'paymentDate' => '<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"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"value\": 123,\n \"date\": \"<string>\",\n \"officeId\": \"<string>\",\n \"personId\": \"<string>\",\n \"billId\": \"<string>\",\n \"categoryId\": \"<string>\",\n \"lawSuitId\": \"<string>\",\n \"isPaid\": true,\n \"installmentCount\": 123,\n \"repetitionTransactionType\": \"<string>\",\n \"repetitionType\": \"<string>\",\n \"annotations\": \"<string>\",\n \"partialValue\": \"<string>\",\n \"paymentDate\": \"<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")
.header("x-juridiq-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"value\": 123,\n \"date\": \"<string>\",\n \"officeId\": \"<string>\",\n \"personId\": \"<string>\",\n \"billId\": \"<string>\",\n \"categoryId\": \"<string>\",\n \"lawSuitId\": \"<string>\",\n \"isPaid\": true,\n \"installmentCount\": 123,\n \"repetitionTransactionType\": \"<string>\",\n \"repetitionType\": \"<string>\",\n \"annotations\": \"<string>\",\n \"partialValue\": \"<string>\",\n \"paymentDate\": \"<string>\"\n}")
.asString();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::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"value\": 123,\n \"date\": \"<string>\",\n \"officeId\": \"<string>\",\n \"personId\": \"<string>\",\n \"billId\": \"<string>\",\n \"categoryId\": \"<string>\",\n \"lawSuitId\": \"<string>\",\n \"isPaid\": true,\n \"installmentCount\": 123,\n \"repetitionTransactionType\": \"<string>\",\n \"repetitionType\": \"<string>\",\n \"annotations\": \"<string>\",\n \"partialValue\": \"<string>\",\n \"paymentDate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"description": "<string>",
"type": "<string>",
"value": 123,
"date": "<string>",
"officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isPaid": true,
"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",
"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>"
}{
"message": "<string>",
"statusCode": 123,
"translateMessage": "<string>"
}Financial
Criar transação
POST
/
financial
/
transactions
Criar transação
curl --request POST \
--url https://api.juridiq.com.br/financial/transactions \
--header 'Content-Type: application/json' \
--header 'x-juridiq-api-key: <api-key>' \
--data '
{
"description": "<string>",
"value": 123,
"date": "<string>",
"officeId": "<string>",
"personId": "<string>",
"billId": "<string>",
"categoryId": "<string>",
"lawSuitId": "<string>",
"isPaid": true,
"installmentCount": 123,
"repetitionTransactionType": "<string>",
"repetitionType": "<string>",
"annotations": "<string>",
"partialValue": "<string>",
"paymentDate": "<string>"
}
'import requests
url = "https://api.juridiq.com.br/financial/transactions"
payload = {
"description": "<string>",
"value": 123,
"date": "<string>",
"officeId": "<string>",
"personId": "<string>",
"billId": "<string>",
"categoryId": "<string>",
"lawSuitId": "<string>",
"isPaid": True,
"installmentCount": 123,
"repetitionTransactionType": "<string>",
"repetitionType": "<string>",
"annotations": "<string>",
"partialValue": "<string>",
"paymentDate": "<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({
description: '<string>',
value: 123,
date: '<string>',
officeId: '<string>',
personId: '<string>',
billId: '<string>',
categoryId: '<string>',
lawSuitId: '<string>',
isPaid: true,
installmentCount: 123,
repetitionTransactionType: '<string>',
repetitionType: '<string>',
annotations: '<string>',
partialValue: '<string>',
paymentDate: '<string>'
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'value' => 123,
'date' => '<string>',
'officeId' => '<string>',
'personId' => '<string>',
'billId' => '<string>',
'categoryId' => '<string>',
'lawSuitId' => '<string>',
'isPaid' => true,
'installmentCount' => 123,
'repetitionTransactionType' => '<string>',
'repetitionType' => '<string>',
'annotations' => '<string>',
'partialValue' => '<string>',
'paymentDate' => '<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"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"value\": 123,\n \"date\": \"<string>\",\n \"officeId\": \"<string>\",\n \"personId\": \"<string>\",\n \"billId\": \"<string>\",\n \"categoryId\": \"<string>\",\n \"lawSuitId\": \"<string>\",\n \"isPaid\": true,\n \"installmentCount\": 123,\n \"repetitionTransactionType\": \"<string>\",\n \"repetitionType\": \"<string>\",\n \"annotations\": \"<string>\",\n \"partialValue\": \"<string>\",\n \"paymentDate\": \"<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")
.header("x-juridiq-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"value\": 123,\n \"date\": \"<string>\",\n \"officeId\": \"<string>\",\n \"personId\": \"<string>\",\n \"billId\": \"<string>\",\n \"categoryId\": \"<string>\",\n \"lawSuitId\": \"<string>\",\n \"isPaid\": true,\n \"installmentCount\": 123,\n \"repetitionTransactionType\": \"<string>\",\n \"repetitionType\": \"<string>\",\n \"annotations\": \"<string>\",\n \"partialValue\": \"<string>\",\n \"paymentDate\": \"<string>\"\n}")
.asString();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::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"value\": 123,\n \"date\": \"<string>\",\n \"officeId\": \"<string>\",\n \"personId\": \"<string>\",\n \"billId\": \"<string>\",\n \"categoryId\": \"<string>\",\n \"lawSuitId\": \"<string>\",\n \"isPaid\": true,\n \"installmentCount\": 123,\n \"repetitionTransactionType\": \"<string>\",\n \"repetitionType\": \"<string>\",\n \"annotations\": \"<string>\",\n \"partialValue\": \"<string>\",\n \"paymentDate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"description": "<string>",
"type": "<string>",
"value": 123,
"date": "<string>",
"officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isPaid": true,
"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",
"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>"
}{
"message": "<string>",
"statusCode": 123,
"translateMessage": "<string>"
}Authorizations
Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key.
Body
application/json
Descrição
Tipo
Available options:
incoming, outcoming Valor
Data
ID do escritório
ID da pessoa
ID da conta
ID da categoria
ID do processo
Pago
Quantidade de parcelas
Tipo de repetição da transação
Tipo de repetição
Anotações
Valor parcial
Data de pagamento
Response
Default Response
Descrição
incoming ou outcoming
Valor
Data
ID do escritório
Pago
ID da transação
ID da transação
Valor parcial
Data de pagamento
ID da pessoa
ID da conta
ID da categoria
ID do processo
Fixa
Possui parcelamento
Rótulo da parcela
Anotações
Nome da conta
Ícone da conta
Conta privada
Nome da categoria
Cor da categoria
Ícone da categoria
Nome da pessoa
Número do processo
Gateway externo
Dados do gateway
Show child attributes
Show child attributes
⌘I