TItiflux
Relatórios

Histórico de faturamentos

Changed on

Este método lista os faturamentos realizados, retornando as informações do relatório histórico de faturamentos.

O atributo contracts traz os contratos cobrados em cada fatura. Uma fatura pode cobrir mais de um contrato; fatura de grupo de contrato lista o grupo.

get/reports/billings/history

Request

  • Base URL
    https://api.tiflux.com/api/v2
  • Auth
    HTTP bearer

Query parameters

offsetinteger

Número da página a ser retornada

limitinteger

Número de itens retornados na página

billing_start_datestring date

Este parâmetro permite filtrar o relatório para incluir apenas itens faturados a partir da data especificada. Deve ser usado em conjunto com billing_end_date para definir o intervalo de datas. O valor deve estar no formato YYYY-MM-DD

billing_end_datestring date

Este parâmetro permite filtrar o relatório para incluir apenas itens faturados até a data especificada. Deve ser utilizado em conjunto com billing_start_date para definir o intervalo de datas. O valor deve estar no formato YYYY-MM-DD

due_start_datestring date

Este parâmetro permite filtrar os faturamentos para incluir apenas itens com data de vencimento a partir da data especificada. Deve ser utilizado em conjunto com due_end_date para definir o intervalo de vencimento. O valor deve estar no formato YYYY-MM-DD

due_end_datestring date

Este parâmetro permite filtrar os faturamentos para incluir apenas itens com data de vencimento até a data especificada. Deve ser utilizado em conjunto com due_start_date para definir o intervalo de vencimento. O valor deve estar no formato YYYY-MM-DD

client_idinteger

Filtra os faturamentos de um determinado cliente

nfe_numberinteger

Filtra os faturamentos por um Número de NFe

ticket_numberinteger

Filtra os faturamentos relacionados ao ticket de número informado

_type'billed' | 'reversed' | 'paid'

Filtra os faturamentos pelo tipo de faturamento

contract_idinteger

Filtra os faturamentos que cobraram o contrato informado (kind: contract)

contract_group_idinteger

Filtra os faturamentos que cobraram o grupo de contrato informado (kind: contract_group)

Changes

  • b081c842364fRevision changes
    • info

      added the new optional query request parameter contract_group_id

    • info

      added the new optional query request parameter contract_id