API Documentation

    SettingsAccount Settings

    Method: /settings.[format]
    Syntax:
    https://[subdomain].salesbinder.com/api/2.0/settings.json
    HTTP Request Type: GET
    Sample Returned JSON Data
    1{
    2    "settings": {
    3        "default_currency": "USD",
    4        "default_language": "eng",
    5        "currency_decimal_places": 2,
    6        "default_estimate_expiry": 14,
    7        "default_tax_rate": 8,
    8        "tax_number": "RT-0001-49584",
    9        "tax_names": "GST",
    10        "default_tax_2_rate": 0,
    11        "tax_2_number": "",
    12        "tax_2_name": "PST",
    13        "default_payment_terms": "Payment due within 30 days. Thank you!",
    14        "default_packing_list_note": "Pack it up nicely!",
    15        "use_sku": true,
    16        "invoice_name": "",
    17        "estimate_name": "Order",
    18        "modified": "2016-11-08T20:52:56+00:00",
    19        "account": {
    20            "company_name": "Acme Test Company",
    21            "record_uptake": 414,
    22            "user_uptake": 4,
    23            "integration_count": 1,
    24            "id": "4d76bc2e-b198-4116-95f5-7439b86a92d9"
    25        }
    26    }
    27}
    Sample Returned XML Data
    1<?xml version="1.0" encoding="UTF-8" ?>
    2<response>
    3    <settings>
    4        <default_currency>USD</default_currency>
    5        <default_language>eng</default_language>
    6        <currency_decimal_places>2</currency_decimal_places>
    7        <default_estimate_expiry>14</default_estimate_expiry>
    8        <default_tax_rate>8</default_tax_rate>
    9        <tax_number>RT-0001-49584</tax_number>
    10        <tax_names>GST</tax_names>
    11        <default_tax_2_rate>0</default_tax_2_rate>
    12        <tax_2_number/>
    13        <tax_2_name>PST</tax_2_name>
    14        <default_payment_terms>Payment due within 30 days. Thank you!</default_payment_terms>
    15        <default_packing_list_note>Pack it up nicely!</default_packing_list_note>
    16        <use_sku>1</use_sku>
    17        <invoice_name/>
    18        <estimate_name>Order</estimate_name>
    19        <modified>11/8/16, 8:52 PM</modified>
    20        <account>
    21            <company_name>Acme Test Company</company_name>
    22            <record_uptake>414</record_uptake>
    23            <user_uptake>4</user_uptake>
    24            <integration_count>1</integration_count>
    25            <id>4d76bc2e-b118-4bd6-95f5-7439b86a92d9</id>
    26        </account>
    27    </settings>
    28</response>

    Updated on November 11th, 2016

    Network Status:
    100% Global Availability