Atualizar Transação Bancária
Atualiza informações editáveis de uma transação bancária, identificada por transactionId.
Use este endpoint para enriquecer transações no seu fluxo de conciliação ou ERP — por exemplo, registrar contexto da operação, conciliar a transação ou classificá-la por categoria, centro de custo e fornecedor.
Campos editáveis hoje:
notes— observação da transação (máximo 1000 caracteres). Envie string vazia ("") para limpar.isConciled— marca a transação como conciliada. Aceita apenastrue; a conciliação é irreversível via API.categoryId— ID numérico da categoria.costCenterId— UUID do centro de custo (use o valor do campoidretornado em GET /cost-centers/v1/cost-centers).supplierId— ID numérico do fornecedor (use o valor do campoidretornado em GET /suppliers/v1/suppliers). Envienullpara remover o fornecedor da transação.
Regras:
- O
transactionIddeve ser oidda transação retornado no extrato (GET /statements/v1/banking). - Ao menos um campo deve ser informado no corpo.
- Enviar
isConciled: falseretorna 400 Bad Request. - Um
categoryId,costCenterIdousupplierIdque não aparece na respectiva listagem (GET /categories/v1/categories,GET /cost-centers/v1/cost-centers,GET /suppliers/v1/suppliers) retorna 400 Bad Request. - Um
categoryIdousupplierIdque não seja inteiro positivo retorna 400 Bad Request. - Quando a conciliação não pode ser concluída, a API retorna 409 Conflict.
- Em caso de sucesso, a API retorna 204 No Content (sem corpo).
Exemplo:
curl -X PATCH https://api-sandbox.contasimples.com/statements/v1/banking/106615 \
-H "Authorization: Bearer {TOKEN}" \
-H "Content-Type: application/json" \
-d '{"notes":"Pagamento fornecedor","isConciled":true,"categoryId":1146,"supplierId":16}'
curl -X PATCH "https://api-sandbox.contasimples.com/statements/v1/banking/106615" \
-H "Content-Type: application/json" \
-H "Signature-Input: example_string" \
-H "Signature: example_string" \
-H "Content-Digest: example_string" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"notes": "Pagamento fornecedor",
"isConciled": true,
"categoryId": 1146,
"costCenterId": "a02f8f63-8b1b-4328-9d7d-0d2e351b8118",
"supplierId": 16
}'
import requests
import json
url = "https://api-sandbox.contasimples.com/statements/v1/banking/106615"
headers = {
"Content-Type": "application/json",
"Signature-Input": "example_string",
"Signature": "example_string",
"Content-Digest": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"notes": "Pagamento fornecedor",
"isConciled": true,
"categoryId": 1146,
"costCenterId": "a02f8f63-8b1b-4328-9d7d-0d2e351b8118",
"supplierId": 16
}
response = requests.patch(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api-sandbox.contasimples.com/statements/v1/banking/106615", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Signature-Input": "example_string",
"Signature": "example_string",
"Content-Digest": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"notes": "Pagamento fornecedor",
"isConciled": true,
"categoryId": 1146,
"costCenterId": "a02f8f63-8b1b-4328-9d7d-0d2e351b8118",
"supplierId": 16
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"notes": "Pagamento fornecedor",
"isConciled": true,
"categoryId": 1146,
"costCenterId": "a02f8f63-8b1b-4328-9d7d-0d2e351b8118",
"supplierId": 16
}`)
req, err := http.NewRequest("PATCH", "https://api-sandbox.contasimples.com/statements/v1/banking/106615", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Signature-Input", "example_string")
req.Header.Set("Signature", "example_string")
req.Header.Set("Content-Digest", "example_string")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api-sandbox.contasimples.com/statements/v1/banking/106615')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Signature-Input'] = 'example_string'
request['Signature'] = 'example_string'
request['Content-Digest'] = 'example_string'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"notes": "Pagamento fornecedor",
"isConciled": true,
"categoryId": 1146,
"costCenterId": "a02f8f63-8b1b-4328-9d7d-0d2e351b8118",
"supplierId": 16
}'
response = http.request(request)
puts response.body
{}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"details": [
"isConciled only accepts true — unmarking a transaction as reconciled is no longer supported"
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "The request is not allowed for the current credentials",
"code": 403,
"details": {
"requiredScope": "listCategories"
},
"requestId": "123e4567-e89b-12d3-a456-426614174000"
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Conflict",
"message": "The request conflicts with the current state of the resource",
"code": 409,
"requestId": "123e4567-e89b-12d3-a456-426614174000"
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/statements/v1/banking/{transactionId}Target server for requests. Edit to use your own host.
Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
Bearer TOKENID da transação bancária — use o valor do campo id retornado em GET /statements/v1/banking (ex.: 106615).
The media type of the request body
O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.
A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.
Hash do corpo da requisição no formato da RFC 9530, com sha-256 ou sha-512, por exemplo sha-256=:X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE=:. É obrigatório quando a requisição tem corpo e a credencial tem chave pública, e nesse caso o Signature-Input precisa incluir o componente content-digest.
Observação da transação. Envie string vazia ("") para limpar.
Marca a transação como conciliada. Aceita apenas true — a conciliação é irreversível via API.
ID da categoria — use o valor do campo id retornado em GET /categories/v1/categories.
UUID do centro de custo — use o valor do campo id retornado em GET /cost-centers/v1/cost-centers.
ID do fornecedor — use o valor do campo id retornado em GET /suppliers/v1/suppliers. Envie null para remover o fornecedor da transação; sem o campo, o fornecedor atual é mantido.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
Path Parameters
ID da transação bancária — use o valor do campo id retornado em GET /statements/v1/banking (ex.: 106615).
106615Headers
O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.
A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.
Hash do corpo da requisição no formato da RFC 9530, com sha-256 ou sha-512, por exemplo sha-256=:X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE=:. É obrigatório quando a requisição tem corpo e a credencial tem chave pública, e nesse caso o Signature-Input precisa incluir o componente content-digest.
Body
Observação da transação. Envie string vazia ("") para limpar.
Pagamento fornecedorMarca a transação como conciliada. Aceita apenas true — a conciliação é irreversível via API.
trueID da categoria — use o valor do campo id retornado em GET /categories/v1/categories.
1146UUID do centro de custo — use o valor do campo id retornado em GET /cost-centers/v1/cost-centers.
a02f8f63-8b1b-4328-9d7d-0d2e351b8118ID do fornecedor — use o valor do campo id retornado em GET /suppliers/v1/suppliers. Envie null para remover o fornecedor da transação; sem o campo, o fornecedor atual é mantido.
16