FreshBooks API

https://www.freshbooks.com/api/
Admin
The FreshBooks API provides a JSON interface for developers to access and integrate FreshBooks data...
Tokens:34,011
Snippets:128
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### FreshBooks API Getting Started Guide

Source: https://www.freshbooks.com/api/online-payments

This section provides an introduction to the FreshBooks API, including initial setup, Postman collection for testing, available tools and libraries, and details on social login integration.

```APIDOC
Getting Started:
  Introduction: https://www.freshbooks.com/api/start
  Postman Collection: https://www.freshbooks.com/api/postman-collection
  Tools and Libraries: https://www.freshbooks.com/api/libraries
  Social Login: https://www.freshbooks.com/api/social-login-one-click
```

--------------------------------

### FreshBooks API: Getting Started Resources

Source: https://www.freshbooks.com/api/scopes

Provides essential resources and guides for developers to begin integrating with the FreshBooks API, covering initial setup, Postman collections for quick testing, and available tools and libraries to streamline development.

```APIDOC
FreshBooks API Getting Started:
  - Introduction: https://www.freshbooks.com/api/start
    - Overview of the FreshBooks API and how to begin.
  - Postman Collection: https://www.freshbooks.com/api/postman-collection
    - Downloadable Postman collection for API testing and exploration.
  - Tools and Libraries: https://www.freshbooks.com/api/libraries
    - Information on official and community-contributed tools and libraries.
  - Social Login: https://www.freshbooks.com/api/social-login-one-click
    - Details on implementing social login for FreshBooks applications.
```

--------------------------------

### Retrieve Clients from Freshbooks API

Source: https://www.freshbooks.com/api/start

This entry details how to fetch a list of clients from the Freshbooks accounting system via its API. It includes the cURL command for the GET request and a comprehensive example of the JSON response, outlining the structure of client objects and pagination metadata.

```Shell
curl -L -X GET 'https://api.freshbooks.com/accounting/account/<accountId>/users/clients' \
-H 'Authorization: Bearer <insert-bearer-token>'
```

```JSON
{
    "response": {
        "result": {
            "clients": [
                {
                    "accounting_systemid": "LJArJ4",
                    "allow_email_include_pdf": false,
                    "allow_late_fees": true,
                    "allow_late_notifications": true,
                    "bus_phone": "+31683138539",
                    "company_industry": null,
                    "company_size": null,
                    "currency_code": "EUR",
                    "direct_link_token": null,
                    "email": "lygel.dmello+Client@freshbooks.com",
                    "exceeds_client_limit": 0,
                    "fax": "",
                    "fname": "Melville",
                    "has_retainer": null,
                    "home_phone": "",
                    "id": 220399,
                    "language": "en",
                    "last_activity": null,
                    "last_login": null,
                    "level": 0,
                    "lname": "DMello",
                    "mob_phone": "+31683138539",
                    "note": null,
                    "notified": false,
                    "num_logins": 0,
                    "organization": "Your Client B.V",
                    "p_city": "",
                    "p_code": "",
                    "p_country": "Netherlands",
                    "p_province": "",
                    "p_street": "",
                    "p_street2": "",
                    "pref_email": true,
                    "pref_gmail": false,
                    "retainer_id": null,
                    "role": "client",
                    "s_city": "",
                    "s_code": "",
                    "s_country": "",
                    "s_province": "",
                    "s_street": "",
                    "s_street2": "",
                    "signup_date": "2021-10-18 09:19:05",
                    "statement_token": null,
                    "subdomain": null,
                    "updated": "2021-11-05 13:56:17",
                    "userid": 220399,
                    "username": "melvilledmello",
                    "uuid": "54cc2cb7-deed-4b05-8ef6-fe672efd2cb7",
                    "vat_name": "VAT Number",
                    "vat_number": "",
                    "vis_state": 0
                },
                {
                    "accounting_systemid": "LJArJ4",
                    "allow_email_include_pdf": false,
                    "allow_late_fees": true,
                    "allow_late_notifications": true,
                    "bus_phone": "",
                    "company_industry": null,
                    "company_size": null,
                    "currency_code": "USD",
                    "direct_link_token": null,
                    "email": "",
                    "exceeds_client_limit": 0,
                    "fax": "",
                    "fname": "Clay",
                    "has_retainer": null,
                    "home_phone": "1-311-784-0855 x4809",
                    "id": 215927,
                    "language": "en",
                    "last_activity": null,
                    "last_login": null,
                    "level": 0,
                    "lname": "Schmidt",
                    "mob_phone": "",
                    "note": "analyzing",
                    "notified": false,
                    "num_logins": 0,
                    "organization": "Lehner - Lubowitz",
                    "p_city": "",
                    "p_code": "",
                    "p_country": "",
                    "p_province": "",
                    "p_street": "Koch Isle",
                    "p_street2": "",
                    "pref_email": true,
                    "pref_gmail": false,
                    "retainer_id": null,
                    "role": "client",
                    "s_city": "",
                    "s_code": "",
                    "s_country": "",
                    "s_province": "",
                    "s_street": "",
                    "s_street2": "",
                    "signup_date": "2021-09-28 15:16:00",
                    "statement_token": null,
                    "subdomain": null,
                    "updated": "2021-09-28 11:16:33",
                    "userid": 215927,
                    "username": "clayschmidt",
                    "uuid": "f0495e6b-6a8b-4ce2-b136-c896d1566839",
                    "vat_name": null,
                    "vat_number": null,
                    "vis_state": 0
                }
            ],
            "page": 1,
            "pages": 1,
            "per_page": 15,
            "total": 2
        }
    }
}
```

--------------------------------

### FreshBooks API Getting Started Guide

Source: https://www.freshbooks.com/api/bearer-tokens-replaced-with-jwt-tokens

This section provides essential resources for developers to begin integrating with the FreshBooks API, covering initial setup, API collection imports, and available development tools.

```APIDOC
Getting Started:
  - Introduction to FreshBooks API
  - Postman Collection for API testing
  - Tools and Libraries for development
  - Social Login (One-Click) integration
```

--------------------------------

### FreshBooks API Authenticated GET Test Call with cURL

Source: https://www.freshbooks.com/api/start

This cURL command demonstrates how to perform a basic authenticated GET request to the FreshBooks API. It includes setting the Authorization and Api-Version headers, and shows an example JSON response for a successful call.

```curl
curl -X GET
  -H 'Authorization: Bearer <insert-bearer-token>' \
  -H "Api-Version: test-version" \
  "https://api.freshbooks.com/test"

{
  "version": "test-version",
  "user": {
    "first_name": "Bruce",
    "last_name": "Wayne",
    "email": "b@example.com"
  }
}
```

--------------------------------

### List Expenses API Call and Response

Source: https://www.freshbooks.com/api/start

This snippet illustrates how to make a GET request to the Freshbooks API to fetch a list of expenses. It includes the `curl` command for the API call and a comprehensive example of the JSON response, detailing the structure of individual expense objects returned by the API.

```bash
curl -L -X GET 'https://api.freshbooks.com/accounting/account/<accountId>/expenses/expenses' \
-H 'Authorization: Bearer <insert-bearer-token>'
```

```json
{
    "response": {
        "result": {
            "expenses": [
                {
                    "account_name": "",
                    "accountid": null,
                    "accounting_systemid": "LJArJ4",
                    "amount": {
                        "amount": "762.68",
                        "code": "USD"
                    },
                    "background_jobid": null,
                    "bank_name": "",
                    "bill_matches": [],
                    "billable": false,
                    "categoryid": 72311,
                    "clientid": 0,
                    "compounded_tax": false,
                    "converse_projectid": null,
                    "date": "2022-01-04",
                    "expenseid": 7934236,
                    "ext_accountid": null,
                    "ext_invoiceid": 0,
                    "ext_systemid": 0,
                    "from_bulk_import": false,
                    "has_receipt": false,
                    "id": 7934236,
                    "include_receipt": false,
                    "invoiceid": null,
                    "is_cogs": true,
                    "isduplicate": false,
                    "markup_percent": "0",
                    "modern_projectid": null,
                    "notes": "",
                    "potential_bill_payment": false,
                    "profileid": 1155,
                    "projectid": 0,
                    "staffid": 1,
                    "status": 0,
                    "taxAmount1": null,
                    "taxAmount2": null,
                    "taxName1": null,
                    "taxName2": null,
                    "taxPercent1": null,
                    "taxPercent2": null,
                    "transactionid": null,
                    "updated": "2022-01-04 06:16:24",
                    "vendor": null,
                    "vis_state": 0
                },
                {
                    "account_name": "",
                    "accountid": null,
                    "accounting_systemid": "LJArJ4",
                    "amount": {
                        "amount": "60.56",
                        "code": "USD"
                    },
                    "background_jobid": null,
                    "bank_name": "",
                    "bill_matches": [],
                    "billable": false,
                    "categoryid": 72293,
                    "clientid": 0,
                    "compounded_tax": false,
                    "converse_projectid": null,
                    "date": "2022-01-04",
                    "expenseid": 7934237,
                    "ext_accountid": null,
                    "ext_invoiceid": 0,
                    "ext_systemid": 0,
                    "from_bulk_import": false,
                    "has_receipt": false,
                    "id": 7934237,
                    "include_receipt": false,
                    "invoiceid": null,
                    "is_cogs": true,
                    "isduplicate": false,
                    "markup_percent": "0",
                    "modern_projectid": null,
                    "notes": "",
                    "potential_bill_payment": false,
                    "profileid": 1150,
                    "projectid": 0,
                    "staffid": 1,
                    "status": 0,
                    "taxAmount1": null,
                    "taxAmount2": null,
                    "taxName1": null,
                    "taxName2": null,
                    "taxPercent1": null,
                    "taxPercent2": null,
                    "transactionid": null,
                    "updated": "2022-01-04 06:16:25",
                    "vendor": null,
                    "vis_state": 0
                }
            ],
            "page": 1,
            "pages": 182,
            "per_page": 2,
            "total": 364
        }
    }
}
```

--------------------------------

### FreshBooks API Getting Started Guide

Source: https://www.freshbooks.com/api/clients

Provides essential information and resources for developers to begin integrating with the FreshBooks API, including introductory concepts, Postman collection for testing, available tools and libraries, and details on social login integration.

```APIDOC
Getting Started:
  - Introduction: https://www.freshbooks.com/api/start
  - Postman Collection: https://www.freshbooks.com/api/postman-collection
  - Tools and Libraries: https://www.freshbooks.com/api/libraries
  - Social Login: https://www.freshbooks.com/api/social-login-one-click
```

--------------------------------

### FreshBooks API Getting Started Guide

Source: https://www.freshbooks.com/api/identity_model

This section provides essential resources for developers to begin integrating with the FreshBooks API, including an introduction, Postman collection for quick testing, available tools and libraries, and details on social login integration.

```APIDOC
Introduction: https://www.freshbooks.com/api/start
Postman Collection: https://www.freshbooks.com/api/postman-collection
Tools and Libraries: https://www.freshbooks.com/api/libraries
Social Login: https://www.freshbooks.com/api/social-login-one-click
```

--------------------------------

### FreshBooks API Integration Tutorials

Source: https://www.freshbooks.com/api/online-payments

Step-by-step guides for common integration tasks, including API authentication, finding appropriate scopes, getting started with the NodeJS SDK, and implementing online payments via the Checkout API and invoice payment enablement.

```APIDOC
Tutorials:
  Get Authenticated On The FreshBooks API: https://www.freshbooks.com/api/get-authenticated-on-the-freshbooks-api
  How To Find The Right Scopes For Your App: https://www.freshbooks.com/api/how-to-find-the-right-scopes-for-your-app
  Getting Started with FreshBooks NodeJS SDK: https://www.freshbooks.com/api/freshbooks-nodejs-sdk
  Receive Online Payments with Checkout API: https://www.freshbooks.com/api/receive-online-payments-with-freshbooks
  Enabling Online Payments On An Invoice: https://www.freshbooks.com/api/enabling-online-payments
```

--------------------------------

### Create a Single Client via Freshbooks API with cURL

Source: https://www.freshbooks.com/api/start

This snippet demonstrates how to make a POST request to the Freshbooks API to create a new client. It specifies the endpoint, required headers (Authorization and Content-Type), and the JSON request body containing the client's information, including primary and contact details. The subsequent JSON block shows the structure of a successful API response.

```shell
curl -L -X POST 'https://api.freshbooks.com/accounting/account/<accountId>/users/clients' \
-H 'Authorization: Bearer <insert-bearer-token>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "client": {
        "fname": "first1",
        "lname": "last1",
        "email": "email1@freshbooks.com",
        "organization": "company1",
        "vat_name": null,
        "vat_number": "",
        "status": null,
        "note": null,
        "home_phone": null,
        "userid": null,
        "source": null,
        "highlight_string": null,
        "p_street": "1655 Dupont St. W.",
        "p_street2": null,
        "p_city": "Toronto",
        "p_country": "Canada",
        "p_province": "Ontario",
        "p_code": "M6P 3T1",
        "currency_code": "USD",
        "language": "en",
        "last_activity": null,
        "face": null,
        "late_fee": null,
        "late_reminders": [],
        "contacts": [
            {
                "email": "email+2@freshbooks.com",
                "fname": "first2",
                "lname": "last2",
                "phone1": null,
                "userid": null,
                "face": null
            },
            {
                "email": "email+3@freshbooks.com",
                "fname": "first3",
                "lname": "last3",
                "phone1": null,
                "userid": null,
                "face": null
            }
        ]
    }
}'
```

```json
{
    "response": {
        "result": {
            "client": {
                "accounting_systemid": "LJArJ4",
                "allow_email_include_pdf": false,
                "allow_late_fees": true,
                "allow_late_notifications": true,
                "bus_phone": "",
                "company_industry": null,
                "company_size": null,
                "currency_code": "USD",
                "direct_link_token": null,
                "email": "email1@freshbooks.com",
                "exceeds_client_limit": 0,
                "fax": "",
                "fname": "first1",
                "has_retainer": null,
                "home_phone": null,
                "id": 238950,
                "language": "en",
                "last_activity": null,
                "last_login": null,
                "level": 0,
                "lname": "last1",
                "mob_phone": "",
                "note": null,
                "notified": false,
                "num_logins": 0,
                "organization": "company1",
                "p_city": "Toronto",
                "p_code": "M6P 3T1",
                "p_country": "Canada",
                "p_province": "Ontario",
                "p_street": "1655 Dupont St. W.",
                "p_street2": "",
                "pref_email": true,
                "pref_gmail": false,
                "retainer_id": null,
                "role": "client",
                "s_city": "",
                "s_code": "",
                "s_country": "",
                "s_province": "",
                "s_street": "",
                "s_street2": "",
                "signup_date": "2022-01-05 12:15:25",
                "statement_token": null,
                "subdomain": null,
                "updated": "2022-01-05 07:15:25",
                "userid": 238950,
                "username": "first1last12",
                "uuid": "ff7b6d5a-218e-4ac8-9114-845d4d67afe1",
                "vat_name": null,
                "vat_number": "",
                "vis_state": 0
            }
        }
    }
}
```

--------------------------------

### FreshBooks API Required Request Headers

Source: https://www.freshbooks.com/api/start

All authenticated FreshBooks API calls require specific HTTP headers to ensure proper communication and authorization. These headers define the content type of the request body and provide the bearer token for authentication.

```APIDOC
Required Headers for FreshBooks API Calls:

1. Content-Type: application/json
   - Description: Specifies that the request body is in JSON format. This header is crucial for the API to correctly parse the incoming data.

2. Authorization: Bearer <TOKEN>
   - Description: Provides the authentication token required to authorize the API call. The <TOKEN> placeholder should be replaced with a valid OAuth 2.0 bearer token obtained through the FreshBooks authentication process. This token authenticates the user or application making the request.
```

--------------------------------

### FreshBooks API: Integration Tutorials

Source: https://www.freshbooks.com/api/scopes

A collection of tutorials guiding developers through common integration tasks, including authentication, scope management, using the NodeJS SDK, and implementing online payment features.

```APIDOC
FreshBooks API Tutorials:
  - Get Authenticated On The FreshBooks API: https://www.freshbooks.com/api/get-authenticated-on-the-freshbooks-api
    - Step-by-step guide to authenticating your application.
  - How To Find The Right Scopes For Your App: https://www.freshbooks.com/api/how-to-find-the-right-scopes-for-your-app
    - Tutorial on determining and requesting appropriate API scopes.
  - Getting Started with FreshBooks NodeJS SDK: https://www.freshbooks.com/api/freshbooks-nodejs-sdk
    - Introduction to using the FreshBooks NodeJS SDK for development.
  - Receive Online Payments with Checkout API: https://www.freshbooks.com/api/receive-online-payments-with-freshbooks
    - Guide to integrating online payment reception via the Checkout API.
  - Enabling Online Payments On An Invoice: https://www.freshbooks.com/api/enabling-online-payments
    - Instructions for enabling online payment options on invoices.
```

--------------------------------

### FreshBooks API Tutorials and Guides

Source: https://www.freshbooks.com/api/identity_model

A collection of tutorials guiding developers through common tasks, including API authentication, identifying correct scopes, using the NodeJS SDK, and implementing online payment functionalities via the Checkout API and invoice settings.

```APIDOC
Get Authenticated On The FreshBooks API: https://www.freshbooks.com/api/get-authenticated-on-the-freshbooks-api
How To Find The Right Scopes For Your App: https://www.freshbooks.com/api/how-to-find-the-right-scopes-for-your-app
Getting Started with FreshBooks NodeJS SDK: https://www.freshbooks.com/api/freshbooks-nodejs-sdk
Receive Online Payments with Checkout API: https://www.freshbooks.com/api/receive-online-payments-with-freshbooks
Enabling Online Payments On An Invoice: https://www.freshbooks.com/api/enabling-online-payments
```

--------------------------------

### FreshBooks API Integration Tutorials

Source: https://www.freshbooks.com/api/bearer-tokens-replaced-with-jwt-tokens

Step-by-step guides for common integration tasks, including authentication, scope management, SDK usage (Node.js), and processing online payments.

```APIDOC
Tutorials:
  - Get Authenticated On The FreshBooks API
  - How To Find The Right Scopes For Your App
  - Getting Started with FreshBooks NodeJS SDK
  - Receive Online Payments with Checkout API
  - Enabling Online Payments On An Invoice
```

--------------------------------

### FreshBooks API Integration Tutorials

Source: https://www.freshbooks.com/api/clients

A collection of tutorials guiding developers through common integration tasks, including API authentication, identifying correct scopes, using the NodeJS SDK, and implementing online payment functionalities for invoices.

```APIDOC
Tutorials:
  - Get Authenticated On The FreshBooks API: https://www.freshbooks.com/api/get-authenticated-on-the-freshbooks-api
  - How To Find The Right Scopes For Your App: https://www.freshbooks.com/api/how-to-find-the-right-scopes-for-your-app
  - Getting Started with FreshBooks NodeJS SDK: https://www.freshbooks.com/api/freshbooks-nodejs-sdk
  - Receive Online Payments with Checkout API: https://www.freshbooks.com/api/receive-online-payments-with-freshbooks
  - Enabling Online Payments On An Invoice: https://www.freshbooks.com/api/enabling-online-payments
```

--------------------------------

### Freshbooks API: List Payments Endpoint with Python Example

Source: https://www.freshbooks.com/api/payments

This entry details the Freshbooks API endpoint for retrieving a list of payments. It includes the HTTP GET request method, URL structure, required headers, a Python example demonstrating the API call, and the expected JSON response format. Authentication requires a Bearer Token.

```APIDOC
Request: GET
https://api.freshbooks.com/accounting/account/<accountid>/payments/payments

Response:

{
  "response": {
    "result": {
      "per_page": 15,
      "pages": 1,
      "total": 3,
      "payments": [
        {
          // same format as single payment
        },
        {
          // same format as single payment
        },
        {
          // same format as single payment
        }
      ],
      "page": 1
    }
  }
}
```

```Python
url = "https://api.freshbooks.com/accounting/account/<accountid>/payments/payments"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.get(url, data=None, headers=headers)
```

--------------------------------

### FreshBooks Official SDKs and Libraries

Source: https://www.freshbooks.com/api/libraries

Overview of the official Software Development Kits (SDKs) provided by FreshBooks to simplify integration with their API. This includes details on available languages, repository links, and where to find usage examples.

```APIDOC
Official Libraries:

Python SDK:
  - Repositories:
    - GitHub: https://github.com/freshbooks/freshbooks-python-sdk
    - PyPI: https://pypi.org/project/freshbooks-sdk/
  - Examples: https://freshbooks.github.io/freshbooks-python-sdk/html/examples.html

Node.js SDK and starter app:
  - Repositories:
    - GitHub: https://github.com/freshbooks/freshbooks-nodejs-sdk
    - npm (sdk): https://www.npmjs.com/package/%40freshbooks/api
    - npm (starter app): https://www.npmjs.com/package/%40freshbooks/app
  - Examples: https://github.com/freshbooks/freshbooks-nodejs-sdk/tree/main/packages/sdk-examples
```

--------------------------------

### Manage Freshbooks Client Resources via API

Source: https://www.freshbooks.com/api/clients

This section details the API endpoints and operations for retrieving and creating client records in the Freshbooks accounting system. It includes HTTP methods, request URLs, required headers, request payloads, and example response structures for both GET and POST operations on the /clients endpoint.

```APIDOC
GET /accounting/account/<accountId>/users/clients/<customerId>
  - Description: Retrieves a single client record by its ID.
  - Parameters:
    - accountId: (Path) The ID of the Freshbooks account.
    - customerId: (Path) The ID of the client to retrieve.
  - Headers:
    - Authorization: Bearer <Bearer Token> (Required)
    - Api-Version: alpha (Required)
    - Content-Type: application/json (Required)
  - Response (200 OK):
    {
      "response": {
        "result": {
          "client": {
            "allow_late_notifications": true,
            "s_code": "2011",
            "fax": "",
            "last_activity": null,
            "num_logins": 0,
            "vat_number": null,
            "pref_email": true,
            "id": 1831231,
            "direct_link_token": null,
            "s_province": "NSW",
            "vat_name": null,
            "lname": "Gates",
            "s_city": "North Sydney",
            "s_street2": "",
            "statement_token": null,
            "note": null,
            "mob_phone": "",
            "last_login": null,
            "home_phone": null,
            "company_industry": null,
            "subdomain": null,
            "email": "will@microsoft.com",
            "username": "aclient",
            "updated": "2016-08-12 14:54:15",
            "p_province": "NSW",
            "p_city": "North Sydney",
            "bus_phone": "0401225226",
            "allow_late_fees": true,
            "p_street": "12 Pacific Highway",
            "company_size": null,
            "accounting_systemid": "zDmNq",
            "p_code": "2011",
            "signup_date": "2016-03-09 17:42:11",
            "language": "en",
            "level": 0,
            "notified": false,
            "userid": 1831231,
            "p_street2": "",
            "pref_gmail": false,
            "vis_state": 0,
            "s_country": "Australia",
            "s_street": "12 Pacific Highway",
            "fname": "Wyatt",
            "organization": "Microsoft",
            "p_country": "Australia",
            "currency_code": "AUD"
          }
        }
      }
    }

POST /accounting/account/<accountId>/users/clients
  - Description: Creates a new client record.
  - Parameters:
    - accountId: (Path) The ID of the Freshbooks account.
  - Headers:
    - Authorization: Bearer <Bearer Token> (Required)
    - Api-Version: alpha (Required)
    - Content-Type: application/json (Required)
  - Request Body (application/json):
    {
      "client": {
        "email": "john.doe@abcorp.com"
        // ... other optional client fields ...
      }
    }
  - Response (200 OK):
    {
      "response": {
        "result": {
          "client": {
            "allow_late_notifications": true,
            "s_code": "",
            "fax": "",
            "last_activity": null,
            "num_logins": 0,
            "vat_number": null,
            "pref_email": true,
            "id": 1831231,
            "direct_link_token": null,
            "s_province": "",
            "vat_name": null,
            "lname": "",
            "s_city": "",
            "s_street2": "",
            "statement_token": null,
            "note": null,
            "mob_phone": "",
            "last_login": null,
            "home_phone": null,
            "company_industry": null,
            "subdomain": null,
            "email": "john.doe@abcorp.com",
            "username": "aclient",
            "updated": "2016-08-12 14:54:15",
            "p_province": "",
            "p_city": "",
            "bus_phone": "",
            "allow_late_fees": true,
            "p_street": "",
            "company_size": null,
            "accounting_systemid": "zDmNq",
            "p_code": "2011",
            "signup_date": "2016-03-09 17:42:11",
            "language": "en",
            "level": 0,
            "notified": false,
            "userid": 1831231,
            "p_street2": "",
            "pref_gmail": false,
            "vis_state": 0,
            "s_country": "",
            "s_street": "",
            "fname": "",
            "organization": "",
            "p_country": "",
            "currency_code": "USD"
          }
        }
      }
    }
```

```Python
import requests
import json

# Get Single Client
url = "https://api.freshbooks.com/accounting/account/<accountId>/users/clients/<id>"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.get(url, data=None, headers=headers)
```

```Python
import requests
import json

# Create Single Client
url = "https://api.freshbooks.com/accounting/account/<accountId>/users/clients"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
payload = {'client': {
              'email': "john.doe@abcorp.com"
            }
          }
res = requests.post(url, data=json.dumps(payload), headers=headers)
```

--------------------------------

### Retrieve Single Invoice from FreshBooks API

Source: https://www.freshbooks.com/api/start

This API call allows you to fetch the details of a specific invoice from your FreshBooks account. It requires authentication via a Bearer token and uses path parameters for the account and invoice IDs. The response provides comprehensive invoice data including amounts, dates, customer details, and payment status.

```APIDOC
GET /accounting/account/<accountId>/invoices/invoices/<invoiceId>

Description: Retrieves a single invoice by its ID for a given account.

Authentication:
  - Type: Bearer Token
  - Header: Authorization: Bearer <insert-bearer-token>

Path Parameters:
  - <accountId>: string (Required)
    Description: The ID of the FreshBooks account.
  - <invoiceId>: integer (Required)
    Description: The ID of the specific invoice to retrieve.

Example Request (curl):
curl -L -X GET 'https://api.freshbooks.com/accounting/account/<accountId>/invoices/invoices/<invoiceId>' \
-H 'Authorization: Bearer <insert-bearer-token>'

Example Response (JSON):
{
    "response": {
        "result": {
            "invoices": [
                {
                    "accountid": "string",
                    "accounting_systemid": "string",
                    "address": "string",
                    "amount": {
                        "amount": "string (e.g., \"110.00\")",
                        "code": "string (currency code, e.g., \"CAD\")"
                    },
                    "auto_bill": "boolean",
                    "autobill_status": "string | null",
                    "basecampid": "integer",
                    "city": "string",
                    "code": "string",
                    "country": "string",
                    "create_date": "string (YYYY-MM-DD)",
                    "created_at": "string (YYYY-MM-DD HH:MM:SS)",
                    "currency_code": "string (e.g., \"CAD\")",
                    "current_organization": "string",
                    "customerid": "integer",
                    "date_paid": "string | null",
                    "deposit_amount": "object | null",
                    "deposit_percentage": "object | null",
                    "deposit_status": "string",
                    "description": "string",
                    "discount_description": "string | null",
                    "discount_total": {
                        "amount": "string",
                        "code": "string"
                    },
                    "discount_value": "string",
                    "display_status": "string",
                    "dispute_status": "string | null",
                    "due_date": "string (YYYY-MM-DD)",
                    "due_offset_days": "integer",
                    "estimateid": "integer",
                    "ext_archive": "integer",
                    "fname": "string",
                    "fulfillment_date": "string (YYYY-MM-DD)",
                    "generation_date": "string (YYYY-MM-DD)",
                    "gmail": "boolean",
                    "id": "integer",
                    "invoice_number": "string",
                    "invoiceid": "integer",
                    "language": "string",
                    "last_order_status": "string | null",
                    "lname": "string",
                    "net_paid_amount": {
                        "amount": "string",
                        "code": "string"
                    },
                    "notes": "string",
                    "organization": "string",
                    "outstanding": {
                        "amount": "string",
                        "code": "string"
                    },
                    "ownerid": "integer",
                    "paid": {
                        "amount": "string",
                        "code": "string"
                    },
                    "parent": "integer",
                    "payment_details": "string",
                    "payment_status": "string",
                    "po_number": "string | null",
                    "province": "string",
                    "return_uri": "string | null",
                    "sentid": "integer",
                    "show_attachments": "boolean",
                    "status": "integer",
                    "street": "string",
                    "street2": "string",
                    "template": "string",
                    "terms": "string",
                    "updated": "string (YYYY-MM-DD HH:MM:SS.microseconds)",
                    "uuid": "string (UUID format)",
                    "v3_status": "string",
                    "vat_name": "string | null",
                    "vat_number": "string",
                    "version": "string",
                    "vis_state": "integer"
                }
            ]
        }
    }
}
```

--------------------------------

### Freshbooks API: List Clients Request and Response

Source: https://www.freshbooks.com/api/clients

This snippet outlines the Freshbooks API endpoint for retrieving a list of clients. It specifies the HTTP GET method, the full URL path including account ID, necessary request headers for authentication and content type, a Python code example demonstrating how to make the API call using the 'requests' library, and the detailed JSON structure of the successful response, including pagination information and the array of client objects.

```APIDOC
Request: GET
https://api.freshbooks.com/accounting/account/<accountId>/users/clients

url = "https://api.freshbooks.com/accounting/account/<accountId>/users/clients"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.get(url, data=None, headers=headers)

Response:

{
  "response": {
    "result": {
      "per_page": 15,
      "total": 3,
      "page": 1,
      "clients": [
        {
          // same format as single client
        },
        {
          // same format as single client
        },
        {
          // same format as single client
        }
      ],
      "pages": 1
    }
  }
}
```

--------------------------------

### Create a New Time Entry (Freshbooks API)

Source: https://www.freshbooks.com/api/time_entries

Illustrates how to create a new time entry in the Freshbooks Time Tracking API using a POST request. The example includes the required JSON payload structure for the time entry details and the expected response.

```APIDOC
Request: POST
URL: https://api.freshbooks.com/timetracking/business/<business_id>/time_entries
Path Parameters:
  business_id: The ID of the Freshbooks business.

Request Body (JSON):
{
  "time_entry": {
    "is_logged": true,
    "duration": 7200,
    "note": "stuff",
    "started_at": "2016-08-16T20:00:00.000Z",
    "client_id": "2149780",
    "project_id": "153125"
  }
}

Response Body (JSON):
{
   "time_entry": {
      "note": "Stuff",
      "duration": 7200,
      "project_id": 153125,
      "client_id": 2149780,
      "is_logged": true,
      "started_at": "2016-08-16T20:00:00Z",
      "active": true,
      "id": 5100,
      "timer": null
  }
}
```

```Python
url = "https://api.freshbooks.com/timetracking/business/<business_id>/time_entries"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
payload = {
  "time_entry": {
    "is_logged": true,
    "duration": 7200,
    "note": "stuff",
    "started_at": "2016-08-16T20:00:00.000Z",
    "client_id": "2149780",
    "project_id": "153125"
  }
}

# Assuming 'requests' library is imported
# res = requests.post(url, json=payload, headers=headers)
```

--------------------------------

### Register a Freshbooks Webhook Callback

Source: https://www.freshbooks.com/api/webhooks

This snippet details the process of registering a new webhook callback for a specific event (e.g., 'invoice.create') and a target URI. It includes the API POST request, required payload, expected response, and a Python example for execution.

```APIDOC
Request: POST
https://api.freshbooks.com/events/account/<account_id>/events/callbacks

Payload:
{
    "callback": {
        "event": "invoice.create",
        "uri": "http://your_server.com/webhooks/ready"
    }
}

Response:

{
  "response": {
    "result": {
      "callback": {
          "callbackid": 2001,
          "id": 2001,
          "verified": false,
          "uri": "http://your_server.com/webhooks/ready",
          "event": "invoice.create"
      }
  }
}
```

```Python
url = "https://api.freshbooks.com/events/account/<account_id>/events/callbacks"
payload = {'callback': {
    'event': "invoice.create",
    'uri': "http://your_server.com/webhooks/ready"
}
}

headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.post(url, data=json.dumps(payload), headers=headers)
```

--------------------------------

### Create Client using FreshBooks Accounting API with cURL

Source: https://www.freshbooks.com/api/clients

This snippet demonstrates how to send a POST request to the FreshBooks Accounting API to create a new client. It includes the necessary authentication header, content type, and a comprehensive JSON body with client details and contacts. The example also shows the expected JSON response structure upon successful client creation.

```curl
curl -L -X POST 'https://api.freshbooks.com/accounting/account/<accountId>/users/clients' \
-H 'Authorization: Bearer <insert-bearer-token>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "client": {
        "fname": "first1",
        "lname": "last1",
        "email": "email1@freshbooks.com",
        "organization": "company1",
        "vat_name": null,
        "vat_number": "",
        "status": null,
        "note": null,
        "home_phone": null,
        "userid": null,
        "source": null,
        "highlight_string": null,
        "p_street": "1655 Dupont St. W.",
        "p_street2": null,
        "p_city": "Toronto",
        "p_country": "Canada",
        "p_province": "Ontario",
        "p_code": "M6P 3T1",
        "currency_code": "USD",
        "language": "en",
        "last_activity": null,
        "face": null,
        "late_fee": null,
        "late_reminders": [],
        "contacts": [
            {
                "email": "email+2@freshbooks.com",
                "fname": "first2",
                "lname": "last2",
                "phone1": null,
                "userid": null,
                "face": null
            },
            {
                "email": "email+3@freshbooks.com",
                "fname": "first3",
                "lname": "last3",
                "phone1": null,
                "userid": null,
                "face": null
            }
        ]
    }
}'
```

```json
{
    "response": {
        "result": {
            "client": {
                "accounting_systemid": "LJArJ4",
                "allow_email_include_pdf": false,
                "allow_late_fees": true,
                "allow_late_notifications": true,
                "bus_phone": "",
                "company_industry": null,
                "company_size": null,
                "currency_code": "USD",
                "direct_link_token": null,
                "email": "email1@freshbooks.com",
                "exceeds_client_limit": 0,
                "fax": "",
                "fname": "first1",
                "has_retainer": null,
                "home_phone": null,
                "id": 238950,
                "language": "en",
                "last_activity": null,
                "last_login": null,
                "level": 0,
                "lname": "last1",
                "mob_phone": "",
                "note": null,
                "notified": false,
                "num_logins": 0,
                "organization": "company1",
                "p_city": "Toronto",
                "p_code": "M6P 3T1",
                "p_country": "Canada",
                "p_province": "Ontario",
                "p_street": "1655 Dupont St. W.",
                "p_street2": "",
                "pref_email": true,
                "pref_gmail": false,
                "retainer_id": null,
                "role": "client",
                "s_city": "",
                "s_code": "",
                "s_country": "",
                "s_province": "",
                "s_street": "",
                "s_street2": "",
                "signup_date": "2022-01-05 12:15:25",
                "statement_token": null,
                "subdomain": null,
                "updated": "2022-01-05 07:15:25",
                "userid": 238950,
                "username": "first1last12",
                "uuid": "ff7b6d5a-218e-4ac8-9114-845d4d67afe1",
                "vat_name": null,
                "vat_number": "",
                "vis_state": 0
            }
        }
    }
}
```

--------------------------------

### Verify a Freshbooks Webhook Callback

Source: https://www.freshbooks.com/api/webhooks

This snippet explains how to verify a webhook callback using a provided verifier code, typically received out-of-band. It outlines the API PUT request, the necessary payload containing the verifier, the successful response, and a Python code example.

```APIDOC
Request: PUT
https://api.freshbooks.com/events/account/<account_id>/events/callbacks/<callback_id>

Payload:
{
    "callback": {
        "verifier": "scADVVi5QuKuj5qTjVkbJNYQe7V7USpGd"
    }
}

Response:

{
  "response": {
    "result": {
      "callback": {
          "callbackid": 2001,
          "id": 2001,
          "verified": true,
          "uri": "http://your_server.com/webhooks/ready",
          "event": "invoice.create"
      }
  }
}
```

```Python
url = "https://api.freshbooks.com/events/account/<account_id>/events/callbacks/<callback_id>"
payload = {'callback': {
    'verifier': "scADVVi5QuKuj5qTjVkbJNYQe7V7USpGd"
}
}

headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.put(url, data=json.dumps(payload), headers=headers)
```

--------------------------------

### Retrieve FreshBooks Account Aging Report with cURL

Source: https://www.freshbooks.com/api/account-aging-report

Example cURL command to perform a GET request for the Account Aging Report from the FreshBooks API. Includes necessary authorization headers and a sample JSON response structure illustrating the report's output.

```curl
#REQUEST
curl -X GET "https://api.freshbooks.com/accounting/account/<account_id>/reports/accounting/accounts_aging?start_date=2017-01-01&end_date=2017-12-31" \
-H "Authorization: Bearer <a token>" \
-H "Api-Version: alpha"

#RESPONSE
{
  "response": {
    "result": {
      "accounts_aging": {
        "end_date": "2017-12-31",
        "totals": {
          "0-30": {
            "amount": "0.00",
            "code": "CAD"
          },
          "61-90": {
            "amount": "0.00",
            "code": "CAD"
          },
          "total": {
            "amount": "0.00",
            "code": "CAD"
          },
          "91+": {
            "amount": "0.00",
            "code": "CAD"
          }, "31-60": {
            "amount": "0.00",
            "code": "CAD"
          }
        },
        "download_token": "Lots of Characters",
        "accounts": [],
        "company_name": "FB",
        "currency_code": "CAD"
        }
      }
    }
  }

```

--------------------------------

### FreshBooks API Scenarios and Core Concepts

Source: https://www.freshbooks.com/api/clients

Explains fundamental API concepts such as search, paging, and includes for data retrieval, handling active, archived, and deleted records, understanding error responses, and managing request limits. Also includes guidance on app listing.

```APIDOC
Scenarios and Concepts:
  - Search, Paging and Includes: https://www.freshbooks.com/api/parameters
  - Active, Archived, and Deleted: https://www.freshbooks.com/api/active_deleted
  - Errors: https://www.freshbooks.com/api/errors
  - Request Limits: https://www.freshbooks.com/api/limits
  - How to create your FreshBooks app listing: https://www.freshbooks.com/api/how-to-create-your-freshbooks-listing
```

--------------------------------

### Retrieve User Profile Information from FreshBooks Me Endpoint

Source: https://www.freshbooks.com/api/social-login-one-click

This snippet shows how to use the obtained access token to make an authenticated GET request to the FreshBooks 'Me' endpoint. This endpoint returns detailed identity information about the authenticated user, such as their name and email, which can be used for personalization or user management.

```curl
curl GET -H "Authorization: Bearer <insert-bearer-token>" "https://api.freshbooks.com/auth/api/v1/users/me"

#Response

{"response":{"id":44599,"profile":{"setup_complete":true,"first_name":"API","last_name":"Team","phone_number":null,"address":null,"professions":[{"id":29505,"business_id":21230,"title":"Accounting","company":"API Help","designation":null},..
```

--------------------------------

### Fetch Time Entries Updated Since a Specific Time (Freshbooks API)

Source: https://www.freshbooks.com/api/time_entries

Demonstrates how to retrieve time entries from the Freshbooks Time Tracking API that have been updated since a specific timestamp. This uses a GET request with 'updated_since' and 'include_deleted' query parameters. The Python example shows how to make this request using the 'requests' library.

```APIDOC
Request: GET
URL: https://api.freshbooks.com/timetracking/business/<business_id>/time_entries?updated_since=2015-08-01T03%3A00%3A00Z&include_deleted=1
Query Parameters:
  business_id: The ID of the Freshbooks business.
  updated_since: (string, ISO 8601) Filters entries updated after this timestamp.
  include_deleted: (integer, 0 or 1) Set to 1 to include deleted time entries.

Response Body (JSON):
{
   "time_entries": [
      {
          "note": null,
          "duration": null,
          "project_id": 153125,
          "client_id": 2149780,
          "is_logged": false,
          "started_at": "2016-08-16T18:03:28Z",
          "active": true,
          "id": 5097,
          "timer": {
              "id": 2938,
              "is_running": true
          }
      },
      {
          "note": null,
          "duration": null,
          "project_id": null,
          "client_id": 2149780,
          "is_logged": false,
          "started_at": "2016-08-16T18:03:28Z",
          "active": true,
          "id": 5098,
          "timer": {
              "id": 2939,
              "is_running": true
          }
      },
      {
          "note": null,
          "duration": null,
          "project_id": null,
          "client_id": 2149780,
          "is_logged": false,
          "started_at": "2016-08-16T18:03:28Z",
          "active": true,
          "id": 5096,
          "timer": {
              "id": 2937,
              "is_running": true
          }
      },
      {
          "note": "Things",
          "duration": 30,
          "project_id": 153125,
          "client_id": 2227125,
          "is_logged": true,
          "started_at": "2016-08-16T18:03:28Z",
          "active": true,
          "id": 5095,
          "timer": {
              "id": 2936,
              "is_running": false
          }
      }
  ],
  "meta": {
      "pages": 1,
      "total_logged": 30,
      "total_unbilled": 30,
      "per_page": 4,
      "total": 4,
      "page": 1
  }
}
```

```Python
url = "https://api.freshbooks.com/timetracking/business/<business_id>/time_entries?updated_since=2015-08-01T03%3A00%3A00Z&include_deleted=1"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.get(url, data=None, headers=headers)
```

--------------------------------

### FreshBooks Clients API Overview

Source: https://www.freshbooks.com/api/clients

This section provides an overview of the Clients API resource in FreshBooks, detailing its purpose, access requirements including necessary scopes, and available `include` parameters for fetching additional client-related data.

```APIDOC
Clients API Overview:
  Description: A client in the new FreshBooks is a resource representing an entity you send invoices to. The primary identifier of a client is an automatically assigned positive integer id (not the email address).
  Access Requirements:
    - Authorization: Required
    - Scopes:
      - user:clients:read
      - user:clients:write
  Includes:
    - outstanding_balance: include client’s outstanding balance
    - credit_balance: include client’s current balance of credit
    - draft_balance: include balance of draft invoices for client
    - overdue_balance: include overdue balance for the Client
    - grand_total_balance: include grand total for client
    - last_activity: include last activity
    - late_reminders: include information about late reminders
    - late_fee: include information about late fees
```

--------------------------------

### FreshBooks API - Retrieve Default Invoice Payment Options

Source: https://www.freshbooks.com/api/online-payments

Illustrates how to retrieve the default online payment options available for an account's invoices using the FreshBooks API. This includes the HTTP GET request endpoint and an example JSON response payload detailing the payment gateway, credit card acceptance, and other settings.

```APIDOC
Request: GET https://api.freshbooks.com/payments/account/<accountid>/payment_options?entity_type=invoice

Response:
{
   "payment_options": {
      "gateway_name": "stripe",
      "has_credit_card": true,
      "has_ach_transfer": false,
      "has_bacs_debit": false,
      "has_sepa_debit": false,
      "has_paypal_smart_checkout": false,
      "allow_partial_payments": false,
      "entity_type": "invoice",
      "entity_id": "5370347",
      "gateway_info": {
      ...
      }
   }
}
```

--------------------------------

### FreshBooks API: Core Resource Endpoints Overview

Source: https://www.freshbooks.com/api/identity_model

This entry provides a categorized list of key API resource endpoints available in the FreshBooks API, covering areas such as staff management, various financial reports, accounting functions, webhook configurations, and system settings.

```APIDOC
FreshBooks API Resource Endpoints:

Staff:
  - /api/staff

Reports:
  - General Ledger Report: /api/general-ledger-report
  - Expense Details Report: /api/expense-details-report
  - Chart of Accounts Report: /api/chart-of-accounts-report
  - Cash Flow Report: /api/cash-flow-report
  - Balance Sheet Report: /api/balance-sheet-report
  - Account Aging Report: /api/account-aging-report
  - Other Reports: /api/reports

Accounting:
  - Chart of Accounts: /api/chart-of-accounts
  - Journal Entries: /api/journal-entries

Webhooks:
  - Webhook Callbacks: /api/webhooks

Settings:
  - Gateways: /api/gateways
  - Items: /api/items
  - Systems: /api/systems
  - Tasks: /api/tasks
```

--------------------------------

### FreshBooks API: Core Scenarios and Concepts

Source: https://www.freshbooks.com/api/scopes

Explains fundamental API concepts and common scenarios, such as searching, paging, handling active, archived, and deleted records, understanding error responses, and managing request limits.

```APIDOC
FreshBooks API Scenarios and Concepts:
  - Search, Paging and Includes: https://www.freshbooks.com/api/parameters
    - Guide to querying data, pagination, and including related resources.
  - Active, Archived, and Deleted: https://www.freshbooks.com/api/active_deleted
    - Understanding the lifecycle and status of FreshBooks entities.
  - Errors: https://www.freshbooks.com/api/errors
    - Documentation on API error codes and how to handle them.
  - Request Limits: https://www.freshbooks.com/api/limits
    - Information on API rate limits and best practices for usage.
  - How to create your FreshBooks app listing: https://www.freshbooks.com/api/how-to-create-your-freshbooks-listing
    - Steps for listing an application in the FreshBooks App Store.
```

--------------------------------

### FreshBooks API: Project and Service Management

Source: https://www.freshbooks.com/api/scopes

Documentation for managing projects and associated services, enabling the organization and tracking of work for clients.

```APIDOC
FreshBooks API Project and Service Management:
  - Services: https://www.freshbooks.com/api/services
    - API for managing services offered.
  - Projects: https://www.freshbooks.com/api/project
    - API for creating and managing projects.
```

--------------------------------

### Fetch Freshbooks Time Entries

Source: https://www.freshbooks.com/api/time_entries

API endpoints for retrieving collections of time entries from Freshbooks, with options for filtering by date range. Includes Python examples for making the requests.

```APIDOC
GET "https://api.freshbooks.com/timetracking/business/<business_id>/time_entries"
  Description: Fetches a list of all time entries for a business.
  Headers:
    Authorization: Bearer <Bearer Token>
    Api-Version: alpha
    Content-Type: application/json
  Python Example:
    url = "https://api.freshbooks.com/timetracking/business/<business_id>/time_entries"
    headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
    res = requests.get(url, data=None, headers=headers)
  Response Body:
    {
        "time_entries": [
          {
             "note": "Things",
             "duration": 30,
              "project_id": 153125,
             "client_id": 2227125,
             "is_logged": true,
              "started_at": "2016-08-16T18:03:28Z",
              "active": true,
              "id": 5095,
              "timer": {
                  "id": 2936,
                 "is_running": false
              }
          }
        ],
        "meta": {
            "pages": 1,
            "total_logged": 30,
            "total_unbilled": 30,
            "per_page": 15,
            "total": 1,
            "page": 1
        }
    }

GET "https://api.freshbooks.com/timetracking/business/<business_id>/time_entries?page=<page>&started_from=<date>&started_to=<date>"
  Description: Fetches time entries filtered by a specific date range.
  Query Parameters:
    page: int - The page number for pagination.
    started_from: string (ISO 8601) - Start date/time for filtering (e.g., 2016-08-17T04%3A00%3A00Z).
    started_to: string (ISO 8601) - End date/time for filtering (e.g., 2016-08-18T03%3A59%3A59Z).
  Headers:
    Authorization: Bearer <Bearer Token>
    Api-Version: alpha
    Content-Type: application/json
  Python Example:
    url = "https://api.freshbooks.com/timetracking/business/<business_id>/time_entries?page=0&started_from=2016-08-17T04%3A00%3A00Z&started_to=2016-08-18T03%3A59%3A59Z"
    headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
    res = requests.get(url, data=None, headers=headers)
  Response Body:
    {
      "time_entries": [
          {
              "note": "Things",
              "duration": 30,
              "project_id": 153125,
              "client_id": 2227125,
              "is_logged": true,
              "started_at": "2016-08-16T18:03:28Z",
              "active": true,
              "id": 5095,
              "timer": {
                  "id": 2936,
                  "is_running": false
              }
          }
      ],
      "meta": {
          "pages": 1,
          "total_logged": 30,
          "total_unbilled": 30,
          "per_page": 4,
          "total": 1,
          "page": 1
      }
    }
```

--------------------------------

### FreshBooks API: Authentication and Identity

Source: https://www.freshbooks.com/api/scopes

Documentation covering the authentication mechanisms required to access the FreshBooks API, including details on the identity model and managing API scopes for granular access control.

```APIDOC
FreshBooks API Authentication:
  - Authentication: https://www.freshbooks.com/api/authentication
    - Comprehensive guide to authenticating with the FreshBooks API.
  - Scopes: https://www.freshbooks.com/api/scopes
    - Explanation of API scopes and how to request necessary permissions.
  - Identity Model: https://www.freshbooks.com/api/identity_model
    - Details on the FreshBooks user and application identity model.
```
Tokens:
Raw