Financeiro › Contratos » Itens

Pesquisar

<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contrato</aside>
get/financial/contracts/{contract_id}/items

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/financial/contracts/{contract_id}/items
  • 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,description,contract_id
filter[mode]string

Filtra por modo do item. Valores permitidos:

  • item: Padrão
  • commission: Comissão
  • service: Serviço
Example:item
filter[item_id]integer

Filtra por ID do tipo de item

Example:1
filter[parent_id]integer

Filtra por ID do item pai

Example:1
filter[contract_id]integer

Filtra por ID do contrato

Example:1
filter[transfer_owner_id]integer

Filtra por ID do proprietário da transferência

Example:1
filter[broker_id]integer

Filtra por ID do corretor

Example:1
filter[start_at]string

date Filtra por mês inicial

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

date Filtra por mês final

Example:2024-12-31
filter[description]string

Filtra por descritivo do Item

Example:Aluguel
filter[amount]number

Filtra por valor

Example:1000
filter[calculate_mode]string

Filtra por tipo de valor. Valores permitidos:

  • percentage: Porcentagem
  • fixed: Valor fixo
Example:fixed
filter[percentage]number

Filtra por porcentagem

Example:10
filter[percentage_mode]string

Filtra por base de cálculo de porcentagem. Valores permitidos:

  • rental_value: Valor da Locação
  • recurring_commission: Comissão Recorrente
  • first_commission: Primeira Comissão
Example:rental_value
filter[commissioned_type]string

Filtra por tipo de comissionado. Valores permitidos:

  • seller: Corretor Vendedor
  • broker: Corretor Agenciador
  • pickup: Captador/Angariador
  • indicator: Indicador
  • partner: Parceria
  • manager: Gerente
  • director: Diretor
  • supervisor: Supervisor
  • marketing: Marketing
  • coordinator: Coordenador
  • others: Outros
Example:seller
filter[item_default]boolean

Filtra por item padrão

Example:true
filter[modeIn][]string[]

Filtra por modos do item

filter[contractIn][]integer[]

Filtra por contratos

filter[ownerIn][]integer[]

Filtra por proprietários

filter[amountMin]number

Filtra por valor mínimo

Example:1000
filter[withReadjust]boolean

Filtra por valor mínimo

Example:true
include[item]string

Incluir dados do Item

Example:id,description,type
include[contract]string

Incluir dados do Contrato

Example:id,reference,type
include[parent]string

Incluir dados do Item Pai

Example:id,description
include[transfer_owner]string

Incluir dados do Proprietário

Example:id,name,tax_id
include[broker]string

Incluir dados do Corretor

Example:id,name,email

Changes

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