Empresa
Apply changes to multiple transactions independently.
Edição em lote é parcial: cada item é processado independentemente e o mesmo conjunto de alterações é aplicado a todos os ids.
A resposta é sempre 200 quando o envelope é válido; o resultado é reportado por item em results.
Somente campos não-nil em changes são alterados. Não permite alterar status (derivado) nem payment_date (pagamento é por /pay).
Item com efeito financeiro (valor, conta ou tipo em lançamento pago) exige reason; sem ele o item falha com reason_required e permanece intacto.
Item de outra empresa falha com 404 naquele item sem expor dados.
Item não tentado por prazo do lote esgotado ou cancelamento falha com not_processed (503).
Envelope inválido devolve 422 ErrorResponseDTO sem processar nada: invalid_envelope (ids vazio, acima de 100, ou changes sem nenhum campo), invalid_id (UUID inválido) ou duplicate_ids (ids repetidos). Limite: 1..100 ids.
PATCH
/
companies
/
transactions
/
batch
Apply changes to multiple transactions independently.
curl --request PATCH \
--url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-company-id: <x-company-id>' \
--data '
{
"ids": [
"<string>"
],
"changes": {
"amount": 123,
"bank_account_id": "<string>",
"coa_id": 123,
"competence": "2023-12-25",
"contact": "<string>",
"cost_center_id": "<string>",
"credit_card_account_id": "<string>",
"due_date": "2023-12-25",
"more_infos": "<string>",
"reference": "<string>",
"supplier_id": "<string>",
"tags": [
"<string>"
],
"type": "<string>",
"url": "<string>"
},
"reason": "<string>"
}
'import requests
url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch"
payload = {
"ids": ["<string>"],
"changes": {
"amount": 123,
"bank_account_id": "<string>",
"coa_id": 123,
"competence": "2023-12-25",
"contact": "<string>",
"cost_center_id": "<string>",
"credit_card_account_id": "<string>",
"due_date": "2023-12-25",
"more_infos": "<string>",
"reference": "<string>",
"supplier_id": "<string>",
"tags": ["<string>"],
"type": "<string>",
"url": "<string>"
},
"reason": "<string>"
}
headers = {
"x-company-id": "<x-company-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-company-id': '<x-company-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
ids: ['<string>'],
changes: {
amount: 123,
bank_account_id: '<string>',
coa_id: 123,
competence: '2023-12-25',
contact: '<string>',
cost_center_id: '<string>',
credit_card_account_id: '<string>',
due_date: '2023-12-25',
more_infos: '<string>',
reference: '<string>',
supplier_id: '<string>',
tags: ['<string>'],
type: '<string>',
url: '<string>'
},
reason: '<string>'
})
};
fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch', 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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'<string>'
],
'changes' => [
'amount' => 123,
'bank_account_id' => '<string>',
'coa_id' => 123,
'competence' => '2023-12-25',
'contact' => '<string>',
'cost_center_id' => '<string>',
'credit_card_account_id' => '<string>',
'due_date' => '2023-12-25',
'more_infos' => '<string>',
'reference' => '<string>',
'supplier_id' => '<string>',
'tags' => [
'<string>'
],
'type' => '<string>',
'url' => '<string>'
],
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-company-id: <x-company-id>"
],
]);
$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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch"
payload := strings.NewReader("{\n \"ids\": [\n \"<string>\"\n ],\n \"changes\": {\n \"amount\": 123,\n \"bank_account_id\": \"<string>\",\n \"coa_id\": 123,\n \"competence\": \"2023-12-25\",\n \"contact\": \"<string>\",\n \"cost_center_id\": \"<string>\",\n \"credit_card_account_id\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"more_infos\": \"<string>\",\n \"reference\": \"<string>\",\n \"supplier_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-company-id", "<x-company-id>")
req.Header.Add("Authorization", "<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.patch("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch")
.header("x-company-id", "<x-company-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"<string>\"\n ],\n \"changes\": {\n \"amount\": 123,\n \"bank_account_id\": \"<string>\",\n \"coa_id\": 123,\n \"competence\": \"2023-12-25\",\n \"contact\": \"<string>\",\n \"cost_center_id\": \"<string>\",\n \"credit_card_account_id\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"more_infos\": \"<string>\",\n \"reference\": \"<string>\",\n \"supplier_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"<string>\"\n ],\n \"changes\": {\n \"amount\": 123,\n \"bank_account_id\": \"<string>\",\n \"coa_id\": 123,\n \"competence\": \"2023-12-25\",\n \"contact\": \"<string>\",\n \"cost_center_id\": \"<string>\",\n \"credit_card_account_id\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"more_infos\": \"<string>\",\n \"reference\": \"<string>\",\n \"supplier_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"replayed": true,
"results": [
{
"code": "<string>",
"http_status": 123,
"id": "<string>",
"index": 123,
"message": "<string>",
"status": "<string>"
}
],
"series_id": "<string>",
"summary": {
"failed": 123,
"succeeded": 123,
"total": 123
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Token da sessão no cabeçalho Authorization, no formato Bearer (mesmo esquema ApiKeyAuth do contrato).
Headers
Company ID (UUID)
Body
application/json
Batch patch request
Lista de IDs a editar (UUIDs). Limite: 1..100, sem duplicatas. Ids de outra empresa falham com 404 naquele item. swagger:example ["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001"]
Required array length:
1 - 100 elementsAlterações a aplicar a todos os ids. Somente os campos preenchidos (não nil) são alterados.
Show child attributes
Show child attributes
Motivo da alteração (opcional). Obrigatório quando a edição altera uma transação paga com efeito financeiro (valor, conta, tipo de lançamento). Para transações não pagas, é ignorado.
Response
Processamento completado. Cada item em results traz seu status. summary mostra total, sucessos e falhas.
Indica se a resposta é um replay de uma request anterior (idempotência). True: mesma chave de idempotência foi processada antes, nenhum efeito novo. False: request foi processada normalmente. Omitido em PATCH e DELETE.
Resultados por item, na ordem da request original.
Show child attributes
Show child attributes
Identificador da série criada (somente em POST /batch com status 201). Omitido em caso de erro no nível da request.
Resumo agregado dos resultados.
Show child attributes
Show child attributes
⌘I
Apply changes to multiple transactions independently.
curl --request PATCH \
--url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-company-id: <x-company-id>' \
--data '
{
"ids": [
"<string>"
],
"changes": {
"amount": 123,
"bank_account_id": "<string>",
"coa_id": 123,
"competence": "2023-12-25",
"contact": "<string>",
"cost_center_id": "<string>",
"credit_card_account_id": "<string>",
"due_date": "2023-12-25",
"more_infos": "<string>",
"reference": "<string>",
"supplier_id": "<string>",
"tags": [
"<string>"
],
"type": "<string>",
"url": "<string>"
},
"reason": "<string>"
}
'import requests
url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch"
payload = {
"ids": ["<string>"],
"changes": {
"amount": 123,
"bank_account_id": "<string>",
"coa_id": 123,
"competence": "2023-12-25",
"contact": "<string>",
"cost_center_id": "<string>",
"credit_card_account_id": "<string>",
"due_date": "2023-12-25",
"more_infos": "<string>",
"reference": "<string>",
"supplier_id": "<string>",
"tags": ["<string>"],
"type": "<string>",
"url": "<string>"
},
"reason": "<string>"
}
headers = {
"x-company-id": "<x-company-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-company-id': '<x-company-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
ids: ['<string>'],
changes: {
amount: 123,
bank_account_id: '<string>',
coa_id: 123,
competence: '2023-12-25',
contact: '<string>',
cost_center_id: '<string>',
credit_card_account_id: '<string>',
due_date: '2023-12-25',
more_infos: '<string>',
reference: '<string>',
supplier_id: '<string>',
tags: ['<string>'],
type: '<string>',
url: '<string>'
},
reason: '<string>'
})
};
fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch', 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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'<string>'
],
'changes' => [
'amount' => 123,
'bank_account_id' => '<string>',
'coa_id' => 123,
'competence' => '2023-12-25',
'contact' => '<string>',
'cost_center_id' => '<string>',
'credit_card_account_id' => '<string>',
'due_date' => '2023-12-25',
'more_infos' => '<string>',
'reference' => '<string>',
'supplier_id' => '<string>',
'tags' => [
'<string>'
],
'type' => '<string>',
'url' => '<string>'
],
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-company-id: <x-company-id>"
],
]);
$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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch"
payload := strings.NewReader("{\n \"ids\": [\n \"<string>\"\n ],\n \"changes\": {\n \"amount\": 123,\n \"bank_account_id\": \"<string>\",\n \"coa_id\": 123,\n \"competence\": \"2023-12-25\",\n \"contact\": \"<string>\",\n \"cost_center_id\": \"<string>\",\n \"credit_card_account_id\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"more_infos\": \"<string>\",\n \"reference\": \"<string>\",\n \"supplier_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-company-id", "<x-company-id>")
req.Header.Add("Authorization", "<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.patch("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch")
.header("x-company-id", "<x-company-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"<string>\"\n ],\n \"changes\": {\n \"amount\": 123,\n \"bank_account_id\": \"<string>\",\n \"coa_id\": 123,\n \"competence\": \"2023-12-25\",\n \"contact\": \"<string>\",\n \"cost_center_id\": \"<string>\",\n \"credit_card_account_id\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"more_infos\": \"<string>\",\n \"reference\": \"<string>\",\n \"supplier_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"<string>\"\n ],\n \"changes\": {\n \"amount\": 123,\n \"bank_account_id\": \"<string>\",\n \"coa_id\": 123,\n \"competence\": \"2023-12-25\",\n \"contact\": \"<string>\",\n \"cost_center_id\": \"<string>\",\n \"credit_card_account_id\": \"<string>\",\n \"due_date\": \"2023-12-25\",\n \"more_infos\": \"<string>\",\n \"reference\": \"<string>\",\n \"supplier_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"replayed": true,
"results": [
{
"code": "<string>",
"http_status": 123,
"id": "<string>",
"index": 123,
"message": "<string>",
"status": "<string>"
}
],
"series_id": "<string>",
"summary": {
"failed": 123,
"succeeded": 123,
"total": 123
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}