frex v0.1.5 API Reference

Modules

The main module for Frex

The client module’s job is to facilitate the request to the Freshbooks API (through Frex.Request) and ensure that all required properties are passed properly

Client module for interacting with the Freshbooks categories endpoint

Client module for interacting with the Freshbooks clients endpoint

Contractor API calls are only available to an account’s administrator, not to staff members

Client module for interacting with the Freshbooks currency endpoint

Staff have access to the API calls listed below if the Invoices tab is enabled for staff

Client module for interacting with the Freshbooks email templates endpoint

Client module for interacting with the Freshbooks estimates endpoint

Client module for interacting with the Freshbooks API

Client module for interacting with the Freshbooks gateways endpoint

Staff have access to the API calls listed below if the Invoices tab is enabled for staff. Staff users can only access invoices that belong to clients they are assigned to

Client module for interacting with the Freshbooks items endpoint

Client module for interacting with the Freshbooks languages endpoint

Client module for interacting with the Freshbooks payments endpoint

Client module for interacting with the Freshbooks projects endpoint

Client module for interacting with the Freshbooks receipts endpoint

Client module for interacting with the Freshbooks recurring endpoint

Provides access to the most commonly used reports and information

Module for interfacing with the staff endpoint of the Freshbooks API

Client module for interacting with the Freshbooks system endpoint

Client module for interacting with the Freshbooks tasks endpoint

Client module for interacting with the Freshbooks taxes endpoint

Client module for interacting with the Freshbooks time entries endpoint

Client module for interacting with the Freshbooks webhooks endpoint

A struct for storing OAuth credentials

Aliases and imports to make writing endpoint clients less painful

A module for sending requests to the Freshbooks API

Module for parsing the response of endpoint calls

Contains parsers for each API endpoint

Handles the building of requests for sending to the Freshbooks API

Generates a new client for an endpoint based on a given endpoint name