Financeiro › Faturas

Pesquisar

get/invoices

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/invoices
  • 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 da fatura.

Example:1
filter[id2]string

ID da fatura por empresa.

Example:1
filter[type]string

Tipo da fatura. Valores permitidos:

  • single: Avulsa
  • contract: Contrato
Example:single
filter[payer_id]integer

ID do pagador.

Example:1
filter[contract_id]integer

ID do contrato.

Example:2
filter[business_id]integer

ID da empresa.

Example:3
filter[account_id]integer

ID da conta bancária.

Example:4
filter[billing_id]integer

ID do método de cobrança automático.

Example:5
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[paid]boolean

Filtra faturas pagas.

Example:true
filter[paid_at]string

date Data do pagamento.

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

date Data do crédito.

Example:2024-01-02
filter[payment_error]boolean

Erro no pagamento.

Example:true
filter[description]string

Descrição da fatura.

Example:Fatura X
filter[total]string

Valor total da fatura.

Example:1200
filter[date]string

date Competência.

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

date Data de vencimento.

Example:2024-01-10
filter[guaranteed_transfer]boolean

Repasse garantido.

Example:true
filter[period_initial]string

date Data de início da fatura, aluguel.

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

date Data final da fatura, aluguel.

Example:2024-01-31
filter[tag]string[]

Tags da fatura.

[
  123,
  456,
  789
]
filter[ticket_registered]boolean

Boleto registrado.

filter[ticket_date]string

date Data do boleto.

Example:2024-01-01 00:00:00
filter[ticket_key]string

ID da cobrança dentro do banco integrador (Asaas).

Example:abc123
filter[ticket_id]integer

ID do boleto.

Example:1
filter[ticket_fee]string

Taxa do boleto.

Example:12.0
filter[ticket_link]string

Link do boleto.

Example:https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1
filter[ticket_barcode]string

Código de barras do boleto .

Example:12395828200001760000010003821587100516853008
filter[ticket_info]string

Informações do boleto.

Example:Este boleto...
filter[ticket_digitable]string

Linha digitável do boleto.

Example:12390.01007 03821.587106 05168.530086 5 82820000176000
filter[ticket_without_pix]boolean

Boleto sem pix.

filter[ticket_late_fee]boolean

Adicionar Multa e Juros para contratos de Locação.

Example:true
filter[ticket_late_fee_item_id]integer

ID do item que será aplicado a multa.

Example:1
filter[ticket_late_fee_percentage]integer

Multa (%).

Example:12
filter[ticket_late_fee_interest]integer

Juros (%).

Example:13
filter[ticket_discount]boolean

Adicionar Desconto de Pontualidade.

Example:true
filter[ticket_discount_mode]string

Modo de desconto. Valores permitidos:

  • fixed: Valor Fixo
  • percentage: Porcentagem
Example:percentage
filter[ticket_discount_fixed]string

Desconto (R$).

Example:123.20
filter[ticket_discount_percentage]string

Desconto(%).

Example:10
filter[ticket_discount_action]string

Ação do desconto de pontualidade. Valores permitidos:

  • business: Reter desconto para imobiliária
  • owner: Repassar desconto ao proprietário
Example:business
filter[ticket_discount_days]integer

Quantidade de dias antes do vencimento.

Example:12
filter[transfer_auto_disabled]boolean

Desativar repasse automático.

filter[protest]string

json Protesto.

Example:{"status":"PENDING"}
filter[ticketIdIn][]string[]

Filtra faturas por IDs de ticket (chave do integrador).

filter[idOldIn][]integer[]

Filtra faturas por IDs antigos (id2).

filter[referenceId]string

Filtra faturas por ID de referência.

Example:REF-001
filter[emptyProtest]boolean

Filtra faturas sem protesto.

Example:true
filter[protestIdIn][]integer[]

Filtra faturas por IDs de protesto.

filter[unpaid]boolean

Filtra faturas não pagas.

Example:true
filter[overdue]boolean

Filtra faturas vencidas.

Example:true
filter[early]boolean

Filtra faturas a vencer.

Example:true
filter[contractIn][]integer[]

Filtra faturas por IDs de contrato.

filter[contractIdIn][]integer[]

Filtra faturas por IDs de contrato (id2).

filter[buildingIn][]integer[]

Filtra faturas por IDs de imóvel.

filter[buildingId2In][]integer[]

Filtra faturas por IDs de imóvel (id2).

filter[dateMin]string

Filtra faturas por data mínima.

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

Filtra faturas por data máxima.

Example:2024-01-31
filter[dueDateMin]string

Filtra faturas por data de vencimento mínima.

Example:2024-01-10
filter[businessIn][]integer[]

Filtra faturas por IDs de empresa.

filter[accountIn][]integer[]

Filtra faturas por IDs de conta financeira.

filter[payerIn][]integer[]

Filtra faturas por IDs de pagador.

filter[ownerIn][]integer[]

Filtra faturas por IDs de proprietário.

filter[tenantIn][]integer[]

Filtra faturas por IDs de inquilino.

filter[registered]boolean

Filtra faturas registradas.

Example:true
filter[registeredOrPix]boolean

Filtra faturas registradas ou com Pix.

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

Filtra faturas por métodos de cobrança.

filter[tagIn][]integer[]

Filtra faturas por tags.

filter[autoTransferStatus][]string[]

Filtra faturas por status de transferência automática.

filter[periodContains]string

Filtra faturas cujo período contém a data especificada.

Example:2024-01-15
filter[payerTaxIdIn][]string[]

Filtra faturas por CPF/CNPJ do pagador.

include[items]string
Example:unde
include[itemsPayer]string
Example:illo
include[itemsAllGroupTransfer]string
Example:voluptatum
include[itemsAll]string
Example:nihil
include[autoTransactions]string
Example:pariatur
include[building]string
Example:consequatur
include[billing]string
Example:esse
include[payer]string

Retorna os dados do pagador.

Example:id,name,type
include[account]string
Example:doloremque
include[contract]string

Retorna os dados do contrato.

Example:*
include[business]string

Retorna os dados da empresa.

Example:id,name
include[lateFeeItem]string
Example:iusto
include[files]string

Retorna os anexos da fatura.

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

Retorna as tags.

Example:id,description
include[messages]string

Retorna as mensagens referente à fatura.

Example:id,type,Message

Changes

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