Cadastrar um novo lançamento financeiro

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

{
    "child": "string",
    "type": "A pagar",
    "status": "Em aberto",
    "total": 0,
    "dueDate": "2019-08-24",
    "accrualDate": "2019-08-24",
    "datePaid": "2019-08-24",
    "person": "string",
    "tags": [
        {
            "tagId": "string"
        }
    ],
    "description": "string",
    "category": "string",
    "orig": "string",
    "quota": "1/4",
    "sale": "string",
    "moneyAccount": "string",
    "destMoneyAccount": "string",
    "costCenter": "string",
    "approved": true,
    "aprovedBy": "string",
    "approvedDate": "2019-08-24",
    "paymentMethod": "string",
    "details": "string",
    "payments": [
        {
            "valuePaid": 0,
            "datePaid": "2019-08-24",
            "paymentMethod": "string",
            "details": "string",
            "juros": 0,
            "multa": 0,
            "discount": 0,
            "user": "string",
            "moneyAccount": "string"
        }
    ],
    "customFields": [
        {
            "fieldId": "string",
            "value": "string"
        }
    ]
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/transactions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "child": "string",
    "type": "A pagar",
    "status": "Em aberto",
    "total": 0,
    "dueDate": "2019-08-24",
    "accrualDate": "2019-08-24",
    "datePaid": "2019-08-24",
    "person": "string",
    "tags": [
        {
            "tagId": "string"
        }
    ],
    "description": "string",
    "category": "string",
    "orig": "string",
    "quota": "1/4",
    "sale": "string",
    "moneyAccount": "string",
    "destMoneyAccount": "string",
    "costCenter": "string",
    "approved": true,
    "aprovedBy": "string",
    "approvedDate": "2019-08-24",
    "paymentMethod": "string",
    "details": "string",
    "payments": [
        {
            "valuePaid": 0,
            "datePaid": "2019-08-24",
            "paymentMethod": "string",
            "details": "string",
            "juros": 0,
            "multa": 0,
            "discount": 0,
            "user": "string",
            "moneyAccount": "string"
        }
    ],
    "customFields": [
        {
            "fieldId": "string",
            "value": "string"
        }
    ]
}'

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"
}