Cadastrar um novo lançamento financeiro

Lançamentos no Sensio podem ser contas a pagar ou a receber. Com esse endpoint você pode cadastrar um novo lançamento. É obrigatório o tipo, total, vencimento e descrição. Para registrar um lançamento associado a um pedido, você pode passar o id do pedido no atributo sale. O array payments só deve ser passado se já houve quitação do lançamento. Nessa rota você pode passar tanto um objeto do tipo transactionPostObject quanto um array de objetos desse tipo, para registrar vários lançamentos de uma vez.

Requisição

Parâmetros Bodyapplication/json

child

string

opcional

Em caso de a empresa ser uma filial.

type

enum<string>

requerido

Valores permitidos:

A pagarA receberTransferencia

status

enum<string>

opcional

Valores permitidos:

Em abertoQuitado

total

number <float>

requerido

Valor total do lançamento.

dueDate

string <date>

requerido

Vencimento do lançamento. Enviar no formato YYYY-MM-DD

accrualDate

string <date>

opcional

Data de competência , utilizado nos tipos 'A pagar' e 'A receber'

datePaid

string <date>

opcional

Data de quitação do lançamento, utilizado somente quando seu status for quitado.

person

string

opcional

Id do cliente para que foi feito o lançamento.

category

string

requerido

Id da categoria, a categoria deve ser conforme o tipo do laçamento, se utiliza a propriedade 'group' da categoria como referência. A receber (61b11bfd87a9551e88966340), Transferências (61b11bfd87a9551e8896636c) e A pagar (61b11bfd87a9551e88966368)

orig

string

opcional

Origem do lançamento.

quota

string

opcional

Número da parcela que o lançamento faz referência.

Exemplo:

1/4

sale

string

opcional

Id do pedido. Adicionar o id quando o lançamento faz parte também do pedido.

moneyAccount

string

opcional

Id da conta do lançamento. É obrigatório e utilizado quando o tipo do lançamento é 'Transferência'.

destMoneyAccount

string

opcional

Id da conta de destino para transferências. É obrigatório e utilizado quando o tipo do lançamento é 'Transferência'.

costCenter

string

opcional

Id do centro de custo.

approved

boolean

opcional

Informa se o lançamento esta aprovado.

Padrão:

true

aprovedBy

string

opcional

Id do usuário que aprovou o lançamento.

approvedDate

string <date>

opcional

Data da aprovação do lançamento.

paymentMethod

string

opcional

Método de pagamento.

details

string

opcional

Observações no lançamento.

payments

array[object (transactionPostObject_payments) {9}]

opcional

valuePaid

number <float>

opcional

Valor do pagamento.

datePaid

string <date>

opcional

Data do pagamento.

paymentMethod

string

opcional

Método de pagamento.

details

string

opcional

Observações.

juros

number <float>

opcional

Juros aplicados sobre o valor do lançamento.

multa

number

opcional

discount

number <float>

opcional

Desconto aplicado sobre o valor do lançamento.

user

string

opcional

Id do usuário que fez o pagamento, já existe a inserção por meio do token informado.

moneyAccount

string

opcional

Id da conta bancária a ser feito as alterações dos valores.

customFields

array[object (item_customFields) {2}]

opcional

Campos personalizáveis para adição de novas informações no lançamento.

fieldId

string

requerido

value

string

requerido

Exemplo

Respostas

🟢201Created

application/json

Sucesso

Body

success

boolean

opcional

Padrão:

true

message

string

opcional

Padrão:

Lançamento registrado com sucesso

response

string

opcional

Id do lançamento registrado

Padrão:

Id do lançamento registrado

Exemplo

{
  "success": true,
  "message": "Lançamento registrado com sucesso",
  "response": "Id do lançamento registrado"
}

Cadastrar um novo lançamento financeiro

Requisição

Exemplos de Requisição

Respostas