Skip to main content
POST
Incluir rateio de um lançamento de Contas a Pagar
Campos obrigatórios ausentes ou inválidos retornam 400 com o detalhe em notifications/errors.
O corpo aceita uma lista — é possível enviar vários registros em uma única chamada.

Authorizations

Authorization
string
header
required

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

Body

application/json

Lista de linhas de rateio do lançamento CP. Não pode ser vazia.

idRateio
integer<int32>

Identificador da linha de rateio. Enviar 0 ao incluir uma nova linha.

Example:

0

codigoDoExercicio
integer<int16>

Código do Exercício do lançamento CP ao qual esta linha de rateio pertence. Necessário para localizar o lançamento.

Example:

2026

codigoDaFilial
integer<int16>

Código da Filial do lançamento CP ao qual esta linha de rateio pertence.

Example:

1

numeroDaTransacao
number

Número da Transação do lançamento CP ao qual esta linha de rateio pertence.

Example:

123456

sequenciaDaTransacao
integer<int32>

Sequência da Transação do lançamento CP ao qual esta linha de rateio pertence.

Example:

1

codigoDaFilialRateio
integer<int16> | null

Filial de destino do rateio. Junto com codigoDoItemDeLancamento e codigoDoCentroDeCusto, ao menos um dos três deve ser informado por linha.

Example:

1

codigoDoItemDeLancamento
string | null

Categoria de destino do rateio.

Example:

"DESP-ALUGUEL"

codigoDoCentroDeCusto
string | null

Centro de Custo de destino do rateio.

Example:

"ADM"

codigoDoProjeto
integer<int32> | null
codigoDoCustoABC
string | null
percentual
number<double>

Percentual desta linha em relação ao total do lançamento. A soma de todas as linhas do rateio deve totalizar 100.

Example:

50

valor
number<double>

Valor desta linha de rateio. A soma de todas as linhas deve ser igual ao valor do lançamento CP.

Example:

750

Response

Rateio incluído com sucesso. O campo data reflete o objeto de resultado interno do comando.

success
boolean
Example:

true

data
object

Resultado bruto do comando de inclusão do rateio.