Retorna lançamentos paginados

Requisição

Parâmetros Path

page

integer

requerido

Número da página. Tamanho da página 100 registros

Parâmetros Query

status

string

opcional

Filtro de status opcional, valores possíveis "Em aberto", "Quitado", "Cancelado"

type

string

opcional

Filtro de tipo opcional, valores possíveis "A pagar", "A receber", "Transferência"

person

string

opcional

Filtro de pessoa opcional, _id da pessoa a ser filtrada

account

string

opcional

Filtro de conta bancária opcional, _id da conta a ser filtrada

Respostas

🟢200OK

application/json

Response

Body

success

boolean

opcional

Padrão:

true

message

string

opcional

Padrão:

Transactions found

response

array[object (transaction) {49}]

opcional

company

string

opcional

Empresa em que o lançamento será cadastrado, já existe a busca da empresa por meio do token informado.

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

originalTotal

number <float>

opcional

Valor total do lançamento, onde o backend adiciona o valor.

total

number <float>

requerido

Valor total do lançamento.

dateCreated

string <date>

opcional

Data de criação do lançamento, é adicionado automáticamente pelo backend.

dueDate

string <date>

requerido

Vencimento do lançamento.

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 categiria como referência. A receber (61b11bfd87a9551e88966340), Transferências (61b11bfd87a9551e8896636c) e A pagar (61b11bfd87a9551e88966368)

orig

string

opcional

Origem do lançamento.

cte

string

opcional

Id do cte, conhecimento de transporte eletrônico, cadastrado no banco de dados.

nfe

string

opcional

Id do NFe cadastrada no banco de dados. É adicionado no lançamento quando este faz parte de um pedido.

nfce

string

opcional

Id do NFCe cadastrado no banco de dados. É adicionado no lançamento quando este faz parte de um pedido.

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.

contract

string

opcional

Id do contrato. Esta opção é para associar um contrato ao lançamento.

takeFromContract

boolean

opcional

Deduz o total do contrato ao quitar. Quando habilitado.

Padrão:

true

totalAccounted

number <float>

opcional

Total a ser contabilizado no lançamento.

totalOpen

number <float>

opcional

Total em aberto.

reconciled

boolean

opcional

Quando por meio de importação do OFX, é conciliado os valores representados no arquivo e os valores representados no lançamento.

Padrão:

false

reconciledId

string

opcional

Id da conciliação cadastrado no banco de dados.

boleto

string

opcional

Esta propriedade é preenchida quando o método de pagamento é o 'Boleto bancário' e o tipo do lançamento seja 'A receber'.

digNossoNumero

string

opcional

Esta propriedade é preenchida quando o método de pagamento é o 'Boleto bancário' e o tipo do lançamento seja 'A receber'.

numero_documento

string

opcional

Esta propriedade é preenchida quando o método de pagamento é o 'Boleto bancário' e o tipo do lançamento seja 'A receber'.

boletoGeneratedDate

string <date>

opcional

Data do processamento do boleto.

moneyAccount

string

opcional

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

destMoneyAccount

string

opcional

Id da conta de destino. É 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.

aprovedBy

string

opcional

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

approvedDate

string <date>

opcional

Data da aprovação do lançamento.

sharingCost

object (transaction_sharingCost)

opcional

remessa

string

opcional

Número da remessa gerada.

remessaId

string

opcional

Id da remessa gerada.

paymentMethod

string

opcional

Método de pagamento.

acquirerFee

string

opcional

Taxa adicional.

details

string

opcional

Observações no lançamento.

sendEmail

boolean

opcional

Padrão:

false

attachments

array[object (transaction_attachments) {4}]

opcional

Informações de arquivos anexados junto ao lançamento, os arquivos são adicionados por meio de upload.

payments

array[object (transactionPostObject_payments) {9}]

opcional

user

string

opcional

Id do usuário que criou o lançamento, já existe a inserção por meio do token informado.

emailsSends

array[object (transaction_emailsSends) {2}]

opcional

Lista de emails onde os boletos foram enviados, é adicionado automáticamente pelo sistema.

customFields

array[object (item_customFields) {2}]

opcional

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

updates

array[object (transaction_updates) {3}]

opcional

As atualizações são adicionadas automaticamente quando é feito alguma mudança no lançamento.

Exemplo

{
  "success": true,
  "message": "Transactions found",
  "response": [
    {
      "company": "string",
      "child": "string",
      "type": "A pagar",
      "status": "Em aberto",
      "originalTotal": 0,
      "total": 0,
      "dateCreated": "2019-08-24",
      "dueDate": "2019-08-24",
      "accrualDate": "2019-08-24",
      "datePaid": "2019-08-24",
      "person": "string",
      "tags": [
        {
          "tagId": "string"
        }
      ],
      "description": "string",
      "category": "string",
      "orig": "string",
      "cte": "string",
      "nfe": "string",
      "nfce": "string",
      "quota": "1/4",
      "sale": "string",
      "contract": "string",
      "takeFromContract": true,
      "totalAccounted": 0,
      "totalOpen": 0,
      "reconciled": false,
      "reconciledId": "string",
      "boleto": "string",
      "digNossoNumero": "string",
      "numero_documento": "string",
      "boletoGeneratedDate": "2019-08-24",
      "moneyAccount": "string",
      "destMoneyAccount": "string",
      "costCenter": "string",
      "approved": true,
      "aprovedBy": "string",
      "approvedDate": "2019-08-24",
      "sharingCost": {
        "sharingTable": "string",
        "fields": [
          {
            "costCenter": "string",
            "percentage": "string"
          }
        ]
      },
      "remessa": "string",
      "remessaId": "string",
      "paymentMethod": "string",
      "acquirerFee": "string",
      "details": "string",
      "sendEmail": false,
      "attachments": [
        {
          "name": "string",
          "size": "string",
          "key": "string",
          "url": "string"
        }
      ],
      "payments": [
        {
          "valuePaid": 0,
          "datePaid": "2019-08-24",
          "paymentMethod": "string",
          "details": "string",
          "juros": 0,
          "multa": 0,
          "discount": 0,
          "user": "string",
          "moneyAccount": "string"
        }
      ],
      "user": "string",
      "emailsSends": [
        {
          "dateSent": "2019-08-24",
          "email": "user@example.com"
        }
      ],
      "customFields": [
        {
          "fieldId": "string",
          "value": "string"
        }
      ],
      "updates": [
        {
          "user": "string",
          "timestamp": "YYYY-MM-DD HH:mm:ss",
          "description": "string"
        }
      ]
    }
  ]
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Retorna lançamentos paginados

Requisição

Exemplos de Requisição

Respostas