Financeiro › Contas a Pagar e Receber

Pesquisar

get/transactions

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/transactions
  • Auth: HTTP bearer

Query parameters

sortstring

Campo para ordenar os registros

Example:id
fieldsstring

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:id,type,total
filter[id]string

ID do lançamento.

Example:1
filter[company_id]integer

ID da empresa.

Example:1
filter[split]string

Filtra lançamentos por ID de agrupamento

Example:50
filter[invoice_id]integer

ID da fatura.

Example:1
filter[transfer_id]integer

ID da transferência.

Example:1
filter[morph_key]string

Chave do módulo.

Example:invoice
filter[mode]string

Modo do lançamento. Valores permitidos:

  • transaction: Lançamentos
  • invoice: Faturas
  • transfer: Repasses
  • commission: Comissões
  • transfer_commission: Repasses de Comissões
  • guaranteed_rent: Aluguel Garantido
  • chargeback: Estornos
Example:transaction
filter[type]string

Tipo do lançamento. Valores permitidos:

  • debit: Despesa
  • credit: Crédito
  • transfer: Transferência
Example:debit
filter[account_id]integer

ID da conta bancária.

Example:1
filter[business_id]integer

ID da empresa.

Example:1
filter[plan_id]integer

ID do plano de contas.

Example:1
filter[user_id]integer

ID do usuário.

Example:1
filter[item_id]integer

ID do item.

Example:1
filter[guaranteed_transfer_id]integer

ID da transferência garantida.

Example:1
filter[person_id]integer

ID da pessoa.

Example:1
filter[building_id]integer

ID do imóvel.

Example:1
filter[contract_id]integer

ID do contrato.

Example:1
filter[broker_id]integer

ID do corretor.

Example:1
filter[owner_id]integer

ID do proprietário.

Example:1
filter[tenant_id]integer

ID do inquilino.

Example:1
filter[extract]string

Extrato. Valores permitidos:

  • business: Imobiliária/Empresa
  • owner: Proprietário
  • customer: Cliente
  • broker: Corretor/Vendedor
Example:owner
filter[date]string

date Data do lançamento.

Example:2024-01-01
filter[position]integer

Posição.

Example:1
filter[amount]string

decimal Valor.

Example:100.00
filter[amount_primary]string

decimal Valor original.

Example:100.00
filter[percentage]string

decimal Porcentagem.

Example:10.00
filter[competence]string

date Competência.

Example:2024-01-01
filter[description]string

Descrição.

Example:Conta de Luz
filter[paid]boolean

Filtra lançamentos pagos

Example:true
filter[due_date]string

date Data de vencimento.

Example:2024-01-10
filter[billing_method]string

Método de cobrança. Valores permitidos:

  • ticket: Boleto
  • cash: Dinheiro
  • deposit: Depósito
  • pix: PIX
  • ted: DOC/TED
  • credit: Cartão de Crédito
  • debit: Cartão de Débito
  • check: Cheque
  • debit_account: Débito em Conta
Example:pix
filter[onlyVisible]boolean

Filtra apenas lançamentos visíveis

Example:true
filter[transfer]boolean

Filtra lançamentos do modo transferência

Example:true
filter[brokerTransfer]boolean

Filtra lançamentos do modo transferência de comissão

Example:true
filter[autoTransfer]boolean

Filtra lançamentos de transferência automática

Example:true
filter[manualTransfer]boolean

Filtra lançamentos de transferência manual

Example:true
filter[bill]boolean

Filtra lançamentos relacionados a contas a pagar

Example:true
filter[guaranteedTransferIn][]integer[]

Filtra lançamentos por IDs de transferência garantida

filter[haveTransfer][]integer[]

Filtra lançamentos que possuem as transferências com os IDs especificados

filter[personIn][]integer[]

Filtra lançamentos por IDs de pessoa

filter[tenantIn][]integer[]

Filtra lançamentos por IDs de inquilino

filter[ownerIn][]integer[]

Filtra lançamentos por IDs de proprietário

filter[ownerPlan]boolean

Filtra lançamentos com plano de contas de proprietário

Example:true
filter[brokerPlan]boolean

Filtra lançamentos com plano de contas de corretor

Example:true
filter[tenantPlan]boolean

Filtra lançamentos com plano de contas de inquilino

Example:true
filter[brokerIn][]integer[]

Filtra lançamentos por IDs de corretor

filter[buildingIn][]integer[]

Filtra lançamentos por IDs de imóvel

filter[accountIn][]integer[]

Filtra lançamentos por IDs de conta financeira

filter[businessIn][]integer[]

Filtra lançamentos por IDs de empresa

filter[businessAllowedIn][]integer[]

Filtra lançamentos por IDs de empresas permitidas

filter[itemIn][]integer[]

Filtra lançamentos por IDs de item

filter[status]string

Filtra lançamentos por status (paid ou unpaid)

Example:paid
filter[invoiceStatus]string

Filtra lançamentos por status da fatura (paid, unpaid, overdue, in_protest, refunded, partially_paid, canceled ou uncollectible)

Example:unpaid
filter[unpaid]boolean

Filtra lançamentos não pagos

Example:true
filter[paidOrGuaranteed]boolean

Filtra lançamentos pagos ou com repasse garantido

Example:true
filter[typeIn][]integer[]

Filtra lançamentos por tipos (credit, debit, transfer)

filter[typeInvoiceIn][]string[]

Filtra lançamentos por tipo de fatura (geralmente credit)

filter[modeIn][]string[]

Filtra lançamentos por modos

filter[itemType][]string[]

Filtra lançamentos por tipo de item

filter[contractTypeIn][]string[]

Filtra lançamentos por tipo de contrato

filter[planIn][]integer[]

Filtra lançamentos por IDs de plano de contas

filter[planAllIn][]integer[]

Filtra lançamentos por IDs de plano de contas (incluindo pais)

filter[contractIn][]integer[]

Filtra lançamentos por IDs de contrato

filter[contractIdIn][]integer[]

Filtra lançamentos por IDs de contrato (id2)

filter[contractActiveIn][]integer[]

Filtra lançamentos por status de atividade do contrato

filter[invoiceIn][]integer[]

Filtra lançamentos por IDs de fatura

filter[isNotInvoice]boolean

Filtra lançamentos que não são faturas

Example:true
filter[invoiceIdIn][]integer[]

Filtra lançamentos por IDs de fatura (id2)

filter[positionMin]integer

Filtra lançamentos por posição mínima (timestamp + position)

Example:1678886400
filter[positionMax]integer

Filtra lançamentos por posição máxima (timestamp + position)

Example:1678972800
filter[onlyAllowed]boolean

Filtra lançamentos permitidos ao usuário logado

Example:true
filter[billingMethodIn][]string[]

Filtra lançamentos por métodos de cobrança. Valores comuns incluem pix, bank_transfer, etc.

filter[ticketRegister]string

Filtra lançamentos por registro de ticket (registered ou unregistered)

Example:registered
filter[onlyInvoice]boolean

Filtra apenas lançamentos que são faturas

Example:true
filter[itemListOwnerReport]boolean

Filtra lançamentos para relatório do proprietário

Example:true
filter[extractIn][]string[]

Filtra lançamentos por extrato

filter[overdue]boolean

Filtra lançamentos vencidos

Example:true
filter[early]boolean

Filtra lançamentos a vencer

Example:true
filter[forBusiness]boolean

Filtra lançamentos do extrato da empresa

Example:true
filter[forOwner]boolean

Filtra lançamentos do extrato do proprietário

Example:true
filter[forBroker]boolean

Filtra lançamentos do extrato do corretor

Example:true
filter[forTenant]boolean

Filtra lançamentos do extrato do inquilino

Example:true
filter[forPayer]boolean

Filtra lançamentos do extrato do pagador

Example:true
filter[tagIn][]integer[]

Filtra lançamentos por tags

filter[invoiceTypeIn]boolean

Filtra lançamentos por tipo de fatura 'single'

Example:true
filter[paidGuaranteedOrTransfer]boolean

Filtra lançamentos pagos, garantidos ou de transferência

Example:true
filter[billIdIn][]integer[]

Filtra lançamentos por IDs de contas a pagar

filter[billPayment]boolean

Filtra lançamentos relacionados a pagamentos de contas

Example:true
filter[brokerCommission]boolean

Filtra lançamentos de comissão do corretor logado

Example:true
filter[invoicePaidIn]string

Filtra lançamentos por status de pagamento da fatura (paid ou unpaid)

Example:paid
include[item]string

Retorna os dados do item da transação.

Example:id,description
include[commissionItem]string

Retorna os dados do item de comissão.

Example:id,description
include[contract]string

Retorna os dados do contrato.

Example:id,number
include[owner]string

Retorna os dados do proprietário.

Example:id,name
include[person]string

Retorna os dados da pessoa.

Example:id,name
include[tenant]string

Retorna os dados do inquilino.

Example:id,name
include[building]string

Retorna os dados do imóvel.

Example:id,name
include[account]string

Retorna os dados da conta financeira.

Example:id,name
include[plan]string

Retorna os dados do plano de contas.

Example:id,name
include[invoice]string

Retorna os dados da fatura.

Example:id,number
include[files]string

Retorna os anexos da transação.

Example:id,name,file_name
include[tags]string

Retorna as tags.

Example:id,description
include[transferredBy]string

Retorna as transações que geraram esta transferência.

Example:id,amount
include[transferredItems]string

Retorna os itens transferidos.

Example:id,amount

Changes

No recorded changes to this operation across all 1 revision of this API.