× Freshbooks App Logo
FreshBooks
Official App
Free - Google Play
Get it

Systems

General Info

An Accounting System represents an entity that can send invoices. It is the central point of association between all of a single Administrator of a single Business’ Invoices, Clients, Staff, Expenses, and Reports.

*Requires Authorization*

Includes

There are no includes for Systems.

Filters

There are no filters for systems.

Field Descriptions

<

Field Type Description
code string postal code
discountid string (internal use) for tracking discounts
ip string signup ip address
test_system boolean (internal) whether this system is marked by FreshBooks as a test system
payment_frequency int (internal) how many months per pay cycle
street string street address
systemid int unique id for system
duration int deprecated
timezone string deprecated
id int a repeat of the systemid field
auto_bill int count of how many autobills the system is allowed to have
timezoneid int deprecated
city string city business is based in
info_email string public email to display
dst boolean use daylight savings time version of system's timezone
gst_amount object subfields: amount and code
amount string two-place decimal formatted amount of gst being paid for system
code string three-letter currency code
mob_phone string mobile phone number for business
modern_system boolean true: system belongs to new FreshBooks, false: system is FreshBooks Classic
heard_about_us _via string channel system came to FreshBooks through
payment_amount object subfields: amount and code
amount string two-place decimal formatted amount being paid for system
code string three-letter currency code
salutation string preferred greeting
referring_url string tracks origin of user signup for analytics
email string admin email
referralid string id for analytics
province string province or state of business
fax string fax number for business
masterlock_billing boolean whether system is billed via a particular service
size_limit int deprecated
street2 string second line of street address of business
date date signup date in YYYY-MM-DD HH:MM:SS format
active boolean whether system is live or cancelled
num_clients int (deprecated) number of clients allowed on business
business_type string description of business (e.g. corporation)
bus_phone string main phone number for business
name string descriptive name of business
country string country of business
landing_url string used for analytics
split_token string used for tracking split tests
billing_status string description of whether the owner of the system has paid us when they were supposed to
num_staff null (deprecated) number of staff allowed on business
currency_code string default currency for business, three-letter format.
accountid string second unique id for system

Get System

The value of <id> here is only meaningful if a user has access to multiple systems. See the Identity Model for more information

Request: GET https://api.freshbooks.com/accounting/account/<accountid>/systems/systems/<id>

Response:

{
  "response": {
    "result": {
      "system": {
        "code": "A1B2C3",
        "discountid": null,
        "ip": "",
        "test_system": false,
        "payment_frequency": 1,
        "street": "123",
        "systemid": 1953394,
        "duration": 12,
        "timezone": "UTC",
        "id": 1953394,
        "auto_bill": 5,
        "timezoneid": 14,
        "city": "Toronto",
        "info_email": "wyatt@freshbooks.com",
        "dst": true,
        "gst_amount": {
          "amount": "0.00",
          "code": "USD"
        },
        "mob_phone": "",
        "modern_system": true,
        "heard_about_us_via": null,
        "payment_amount": {
          "amount": "0.00",
          "code": "USD"
        },
        "salutation": null,
        "referring_url": null,
        "email": "wyatt@freshbooks.com",
        "referralid": null,
        "province": "Ontario",
        "fax": "",
        "masterlock_billing": true,
        "size_limit": null,
        "street2": null,
        "date": "2016-01-26 11:00:42",
        "active": true,
        "num_clients": null,
        "business_type": "corporation",
        "bus_phone": "",
        "name": "BillSpring",
        "country": "Canada",
        "landing_url": null,
        "split_token": null,
        "billing_status": "uptodate",
        "num_staff": null,
        "currency_code": "USD",
        "accountid": "zDmNq"
      }
    }
  }
}

Create Single System

System creation is not available as part of our API.

Update Single System

Updating the details of a system is not available as part of our API.

Delete Single System

Deleting systems is not available as part of our API.

List Systems

There is no defined System List call in our API.

Get System

The value of &ltid&gt here is only meaningful if a suser has access to multiple systems. See the Identity Model for more information

Request: GET
https://api.freshbooks.com/accounting/account/&ltaccountid&gt/systems/systems/&ltid&gt


url = "https://api.freshbooks.com/accounting/account/&ltaccountid&gt/systems/systems/&ltid&gt"
headers = {'Authorization': 'Bearer &ltBearer Token&gt', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.get(url, data=None, headers=headers)

Response:


{
  "response": {
    "result": {
      "system": {
        "code": "A1B2C3",
        "discountid": null,
        "ip": "",
        "test_system": false,
        "payment_frequency": 1,
        "street": "123",
        "systemid": 1953394,
        "duration": 12,
        "timezone": "UTC",
        "id": 1953394,
        "auto_bill": 5,
        "timezoneid": 14,
        "city": "Toronto",
        "info_email": "wyatt@freshbooks.com",
        "dst": true,
        "gst_amount": {
          "amount": "0.00",
          "code": "USD"
        },
        "mob_phone": "",
        "modern_system": true,
        "heard_about_us_via": null,
        "payment_amount": {
          "amount": "0.00",
          "code": "USD"
        },
        "salutation": null,
        "referring_url": null,
        "email": "wyatt@freshbooks.com",
        "referralid": null,
        "province": "Ontario",
        "fax": "",
        "masterlock_billing": true,
        "size_limit": null,
        "street2": null,
        "date": "2016-01-26 11:00:42",
        "active": true,
        "num_clients": null,
        "business_type": "corporation",
        "bus_phone": "",
        "name": "BillSpring",
        "country": "Canada",
        "landing_url": null,
        "split_token": null,
        "billing_status": "uptodate",
        "num_staff": null,
        "currency_code": "USD",
        "accountid": "zDmNq"
      }
    }
  }
}

Create Single System

System creation is not available as part of our API.

Update Single System

Updating the details of a system is not available as part of our API.

Delete Single System

Deleting systems is not available as part of our API.