VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/ERP Financeiro

Contas bancárias

Cadastra as contas bancárias do seller e calcula o saldo realizado de cada uma.

Listar contas bancárias

As contas bancárias do seller servem para dizer por onde o dinheiro passou em cada baixa e para a conciliação de extratos. A lista não tem paginação.

GET/api/v1/vendor/erp/financeiro/bank-accountsSeller

Lista as contas bancárias

Exemplo de requisição: Listar contas bancárias

bash
curl "$BASE_URL/api/v1/vendor/erp/financeiro/bank-accounts" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Listar contas bancárias

200Contas retornadas
json
{
  "bank_accounts": [
    {
      "id": "a1c3e5f7-2b4d-4f6a-8c0e-1d3f5a7b9c21",
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "bank": "Banco Inter",
      "agency": "0001",
      "account": "1234567-8",
      "active": true,
      "created_at": "2026-10-11T14:30:00Z",
      "updated_at": "2026-10-11T14:30:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

bank_accountsarray

Contas.

iduuid
Id da conta.
vendor_iduuid
Seller dono.
bankstring
Nome do banco.
agencystring
Agência. Vazio se não informada.
accountstring
Conta. Vazio se não informada.
activeboolean
Se está ativa.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.
totalinteger
Quantidade devolvida.

Erros: Listar contas bancárias

StatusQuandoCorpo
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}

Saldos das contas

Calcula, por conta, o que entrou e o que saiu a partir das baixas registradas nela. É o realizado, não um saldo bancário: não existe saldo inicial e juros e multa ficam de fora.

GET/api/v1/vendor/erp/financeiro/bank-accounts/balancesSeller

Saldo realizado por conta bancária

Exemplo de requisição: Saldos das contas

bash
curl "$BASE_URL/api/v1/vendor/erp/financeiro/bank-accounts/balances" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Saldos das contas

200Saldos
json
{
  "balances": [
    {
      "bank_account_id": "a1c3e5f7-2b4d-4f6a-8c0e-1d3f5a7b9c21",
      "bank": "Banco Inter",
      "agency": "0001",
      "account": "1234567-8",
      "active": true,
      "inflow_cents": 120000,
      "outflow_cents": 52400,
      "balance_cents": 67600
    }
  ],
  "total": 1
}

Campos da resposta

balancesarray

Uma linha por conta, ativas primeiro.

bank_account_iduuid
Conta.
bankstring
Banco.
agencystring
Agência.
accountstring
Conta.
activeboolean
Ativa.
inflow_centsinteger
Soma das baixas de contas a receber.
outflow_centsinteger
Soma das baixas de contas a pagar.
balance_centsinteger
inflow_cents menos outflow_cents.
totalinteger
Quantidade devolvida.

Erros: Saldos das contas

StatusQuandoCorpo
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}
Conciliação não entra aqui

Títulos quitados pela conciliação de extrato não geram baixa, então não aparecem nestes saldos nem na série diária do fluxo de caixa.

Criar conta bancária

POST/api/v1/vendor/erp/financeiro/bank-accountsSeller

Cria uma conta bancária

Corpo da requisição

bankstringobrigatório
Nome do banco. Obrigatório.
agencystring
Agência.
accountstring
Conta.
activebooleanpadrão: true
Se a conta está ativa.

Exemplo de requisição: Criar conta bancária

bash
curl -X POST "$BASE_URL/api/v1/vendor/erp/financeiro/bank-accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "bank": "Banco Inter",
  "agency": "0001",
  "account": "1234567-8"
}'

Resposta: Criar conta bancária

201Conta criada
json
{
  "id": "a1c3e5f7-2b4d-4f6a-8c0e-1d3f5a7b9c21",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "bank": "Banco Inter",
  "agency": "0001",
  "account": "1234567-8",
  "active": true,
  "created_at": "2026-10-11T14:30:00Z",
  "updated_at": "2026-10-11T14:30:00Z"
}

Campos da resposta

iduuid
Id da conta.
vendor_iduuid
Seller dono.
bankstring
Nome do banco.
agencystring
Agência. Vazio se não informada.
accountstring
Conta. Vazio se não informada.
activeboolean
Se está ativa.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.

Erros: Criar conta bancária

StatusQuandoCorpo
400Corpo não é um JSON válido.{"error":"invalid request body","detail":"invalid character 'b' looking for beginning of object key string"}
400bank em branco.{"error":"vendorerp: bank required"}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}

Alterar conta bancária

PUT/api/v1/vendor/erp/financeiro/bank-accounts/{id}Seller

Altera uma conta bancária

Parâmetros de caminho

iduuidobrigatório
Id (UUID) da conta bancária.

Corpo da requisição

bankstringobrigatório
Nome do banco. Obrigatório.
agencystring
Agência.
accountstring
Conta.
activebooleanpadrão: true
Se a conta está ativa.

Exemplo de requisição: Alterar conta bancária

bash
curl -X PUT "$BASE_URL/api/v1/vendor/erp/financeiro/bank-accounts/3f6c1c1e-8d0b-4a55-9a52-1d6f6a4a7b10" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "bank": "Banco Inter",
  "agency": "0001",
  "account": "1234567-8",
  "active": true
}'

Resposta: Alterar conta bancária

200Conta alterada
json
{
  "id": "a1c3e5f7-2b4d-4f6a-8c0e-1d3f5a7b9c21",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "bank": "Banco Inter",
  "agency": "0001",
  "account": "1234567-8",
  "active": true,
  "created_at": "2026-10-11T14:30:00Z",
  "updated_at": "2026-10-11T14:30:00Z"
}

Campos da resposta

iduuid
Id da conta.
vendor_iduuid
Seller dono.
bankstring
Nome do banco.
agencystring
Agência. Vazio se não informada.
accountstring
Conta. Vazio se não informada.
activeboolean
Se está ativa.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.

Erros: Alterar conta bancária

StatusQuandoCorpo
400Corpo não é um JSON válido.{"error":"invalid request body","detail":"invalid character 'b' looking for beginning of object key string"}
400bank em branco.{"error":"vendorerp: bank required"}
404A conta bancária não existe ou é de outro seller.{"error":"bank account not found"}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}
Omitir active reativa a conta

active vale true quando não vem no corpo, e agência e conta omitidas são apagadas.

Apagar conta bancária

Exclusão lógica. Baixas já registradas nela continuam contando nos saldos, mas a conta deixa de aparecer na lista e em Saldos das contas.

DELETE/api/v1/vendor/erp/financeiro/bank-accounts/{id}Seller

Apaga uma conta bancária

Parâmetros de caminho

iduuidobrigatório
Id (UUID) da conta bancária.

Exemplo de requisição: Apagar conta bancária

bash
curl -X DELETE "$BASE_URL/api/v1/vendor/erp/financeiro/bank-accounts/3f6c1c1e-8d0b-4a55-9a52-1d6f6a4a7b10" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Apagar conta bancária

200Conta apagada
json
{
  "message": "bank account deleted"
}

Campos da resposta

messagestring
Sempre bank account deleted.

Erros: Apagar conta bancária

StatusQuandoCorpo
404A conta bancária não existe ou é de outro seller.{"error":"bank account not found"}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}

Veja também

  • Baixa de contas a pagar
  • Conciliação bancária
Anterior
Baixa de contas a receber
Próxima
Fluxo de caixa
Nesta página
  • Listar contas bancárias
  • Exemplo de requisição: Listar contas bancárias
  • Resposta: Listar contas bancárias
  • Erros: Listar contas bancárias
  • Saldos das contas
  • Exemplo de requisição: Saldos das contas
  • Resposta: Saldos das contas
  • Erros: Saldos das contas
  • Criar conta bancária
  • Exemplo de requisição: Criar conta bancária
  • Resposta: Criar conta bancária
  • Erros: Criar conta bancária
  • Alterar conta bancária
  • Exemplo de requisição: Alterar conta bancária
  • Resposta: Alterar conta bancária
  • Erros: Alterar conta bancária
  • Apagar conta bancária
  • Exemplo de requisição: Apagar conta bancária
  • Resposta: Apagar conta bancária
  • Erros: Apagar conta bancária
  • Veja também