Skip to main content
PUT
Alterar Carteira
PUT substitui o registro inteiro — envie todos os campos, não apenas os alterados.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Carteira de cobrança bancária, vinculada a uma Conta Corrente. Usada tanto na inclusão (POST) quanto na alteração (PUT) e nas respostas de consulta. Na alteração, codigoDaCarteira é obrigatório para identificar a Carteira.

codigoDaContaCorrente
integer<int16> | null
required

Código da Conta Corrente vinculada à Carteira. Obrigatório e deve ser uma Conta Corrente válida.

Example:

1

tipoDeCobranca
enum<string>
required

Tipo de Cobrança da Carteira. Obrigatório. Valores aceitos: Simples, Descontada, Vinculada, Vendor.

Available options:
Simples,
Descontada,
Vinculada,
Vendor
Example:

"Simples"

codigoDaCarteira
integer<int16>

Código da Carteira. Ignorado e gerado automaticamente na inclusão; obrigatório na alteração.

Example:

3

descricaoDaCarteira
string | null

Descrição da carteira.

Example:

"Carteira Simples - Banco do Brasil"

codigoCarteiraConvenio
string | null

Código da Carteira/Convênio junto ao banco.

Example:

"17"

nossoNumero
number

Próximo Nosso Número a ser usado na emissão de boletos desta Carteira.

Example:

1

instrucaoCaixa
string | null

Instrução de caixa impressa no boleto.

percentualMulta
number<double>
Example:

2

percentualJuros
number<double>
Example:

1

percentualDesconto
number<double>
Example:

0

Response

Carteira alterada com sucesso.

success
boolean
Example:

true

data
object

Carteira de cobrança bancária, vinculada a uma Conta Corrente. Usada tanto na inclusão (POST) quanto na alteração (PUT) e nas respostas de consulta. Na alteração, codigoDaCarteira é obrigatório para identificar a Carteira.