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

{
    "settings": {
        "default_currency": "USD",
        "default_language": "eng",
        "currency_decimal_places": 2,
        "default_estimate_expiry": 14,
        "default_tax_rate": 8,
        "tax_number": "RT-0001-49584",
        "tax_names": "GST",
        "default_tax_2_rate": 0,
        "tax_2_number": "",
        "tax_2_name": "PST",
        "default_payment_terms": "Payment due within 30 days. Thank you!",
        "default_packing_list_note": "Pack it up nicely!",
        "use_sku": true,
        "invoice_name": "",
        "estimate_name": "Order",
        "modified": "2016-11-08T20:52:56+00:00",
        "account": {
            "company_name": "Acme Test Company",
            "record_uptake": 414,
            "user_uptake": 4,
            "integration_count": 1,
            "id": "4d76bc2e-b198-4116-95f5-7439b86a92d9"
        }
    }
}

Sample Returned XML Data

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <settings>
        <default_currency>USD</default_currency>
        <default_language>eng</default_language>
        <currency_decimal_places>2</currency_decimal_places>
        <default_estimate_expiry>14</default_estimate_expiry>
        <default_tax_rate>8</default_tax_rate>
        <tax_number>RT-0001-49584</tax_number>
        <tax_names>GST</tax_names>
        <default_tax_2_rate>0</default_tax_2_rate>
        <tax_2_number/>
        <tax_2_name>PST</tax_2_name>
        <default_payment_terms>Payment due within 30 days. Thank you!</default_payment_terms>
        <default_packing_list_note>Pack it up nicely!</default_packing_list_note>
        <use_sku>1</use_sku>
        <invoice_name/>
        <estimate_name>Order</estimate_name>
        <modified>11/8/16, 8:52 PM</modified>
        <account>
            <company_name>Acme Test Company</company_name>
            <record_uptake>414</record_uptake>
            <user_uptake>4</user_uptake>
            <integration_count>1</integration_count>
            <id>4d76bc2e-b118-4bd6-95f5-7439b86a92d9</id>
        </account>
    </settings>
</response>

Updated on November 11th, 2016