Return the list of existing customers

<!-- No XML Request. -->

<customers>
    <customer uri="/customers/X/" id="X">
        <name>
            <first>[str]</first>
            <last>[str]</last>
        </name>
        <company>[str]</company>
        <email>[str]</email>
        <homepage>[str]</homepage>
        <phone_numbers>
            <phone_number id="[int]">
                <main>[bool]</main>
                <type>[enum: work|home|mobile|main|home fax|work fax|toll-free|other]</type>
                <list_order>[int]</list_order>
                <number>[str]</number>
            </phone_number>
            [...] <!-- 4 phone numbers with ids 1-4 -->
        </phone_numbers>
        <photo uri="/customers/X/customer_photo/"/>
        <is_company>[bool]</is_company>
    </customer>
    [...]
</customers>

Create a new customer

<customer>
    <name>
        <first>[str]</first> <!-- Optional -->
        <last>[str]</last> <!-- Optional -->
    </name>
    <company>[str]</company> <!-- Optional -->
    <email>[str]</email> <!-- Optional -->
    <homepage>[str]</homepage> <!-- Optional -->
    <phone_numbers> <!-- Optional -->
        <phone_number id="[int]"> <!-- id and/or list_order must be present. -->
            <main>[bool]</main> <!-- Optional -->
            <type>[enum: work|home|mobile|main|home fax|work fax|toll-free|other]</type> <!-- Optional -->
            <number>[str]</number> <!-- Optional -->
            <list_order>[int]</list_order> <!-- id and/or list_order must be present -->
        </phone_number>
        [...] <!-- 0-4 values possible -->
    </phone_numbers>
    <billing> <!-- Optional -->
        <address>
            <address1>[str]</address1> <!-- Optional -->
            <address2>[str]</address2> <!-- Optional -->
            <city>[str]</city> <!-- Optional -->
            <state>[str]</state> <!-- Optional -->
            <country>[str]</country> <!-- Optional -->
            <zip>[str]</zip> <!-- Optional -->
        </address>
    </billing>
    <shipping> <!-- Optional -->
        <address>
            <address1>[str]</address1> <!-- Optional -->
            <address2>[str]</address2> <!-- Optional -->
            <city>[str]</city> <!-- Optional -->
            <state>[str]</state> <!-- Optional -->
            <country>[str]</country> <!-- Optional -->
            <zip>[str]</zip> <!-- Optional -->
        </address>
    </shipping>
    <is_company>[bool]</is_company> <!-- Optional -->
    <birthday>[date]</birthday> <!-- Optional -->
    <credit_hold>[bool]</credit_hold> <!-- Optional -->
    <credit_limit>[decimal]</credit_limit> <!-- Optional -->
    <tax_status id="[int]"/> <!-- Optional -->
    <tax_code id="[int]"/> <!-- Optional -->
    <account_status id="[int]"/> <!-- Optional -->
    <user id="[int]"/> <!-- Optional -->
    <terms id="[int]"/> <!-- Optional -->
    <currency id="[int]"/> <!-- Optional -->
    <merged_to> <!-- Optional -->
        <customer id="[int]"/> <!-- Optional. Unmerge if not present. -->
    </merged_to>
</customer>

<customer uri="/customers/X/" id="X">
    <!-- See GET /customers/X/ for details -->
</customer>

Return detailed information of a specific customer

<!-- No XML Request. -->

<customer uri="/customers/A/" id="A">
    <created>[datetime]</created>
    <modified>[datetime]</modified>
    <name>
        <first>[str]</first>
        <last>[str]</last>
    </name>
    <company>[str]</company>
    <email>[str]</email>
    <homepage>[str]</homepage>
    <phone_numbers>
        <phone_number id="[int]">
            <main>[bool]</main>
            <type>[enum: work|home|mobile|main|home fax|work fax|toll-free|other]</type>
            <list_order>[int]</list_order>
            <number>[str]</number>
        </phone_number>
        [...] <!-- 4 phone numbers with ids 1-4 -->
    </phone_numbers>
    <photo uri="/customers/X/customer_photo/"/>
    <is_company>[bool]</is_company>
    <billing>
        <address>
            <address1>[str]</address1>
            <address2>[str]</address2>
            <city>[str]</city>
            <state>[str]</state>
            <country>[str]</country>
            <zip>[str]</zip>
        </address>
    </billing>
    <shipping>
        <address>
            <address1>[str]</address1>
            <address2>[str]</address2>
            <city>[str]</city>
            <state>[str]</state>
            <country>[str]</country>
            <zip>[str]</zip>
        </address>
    </shipping>
    <credit_hold>[bool]</credit_hold>
    <new_import>[bool]</new_import>
    <new_update>[bool]</new_update>
    <birthday>[date]</birthday>
    <credit_limit>[decimal]</credit_limit>
    <customer_id>[str]</customer_id>
    <credit_status uri="/customers/A/credit_status/"/>
    <ar_balance uri="/customers/A/ar_balance/"/>
    <import_id>[str]</import_id>
    <account_status uri="/setup/account_statuses/B/" id="B">
        <!-- See GET /setup/account_statuses/X/ for details -->
    </account_status>
    <user uri="/users/C/" id="C"/>
    <customer_category uri="/setup/customer_categories/J/" id="J">
        <!-- See GET /setup/customer_categories/X/ response for details. -->
    </customer_category>
    <customer_referredby uri="/setup/customer_referredbys/D/" id="D">
        <!-- See GET /setup/customer_referredbys/X/ for details -->
    </customer_referredby>
    <currency uri="/setup/currencies/E/" id="E"/>
    <tax_code uri="/tax_codes/F/" id="F"/>
    <tax_exemption uri="/setup/tax_exemptions/G/" id="G"/>
    <terms uri="/setup/terms/H/" id="H"/>
    <language>
        <id>[int]</id>
        <language_name>[str]</language_name>
    </language>
    <merged_to>
        <customer uri="/customers/J/" id="J"/> <!-- Empty if not merged -->
    </merged_to>
</customer>

Update the details of a specific customer

<customer>
    <!-- See POST /api/customers/ for details -->
</customer>

<customer uri="/customers/X/" id="X">
    <!-- See GET /api/customers/X/ for details -->
</customer>

Return the list of account receivable balances for a specific customer.

<!-- No XML Request -->

<ar_balance uri="/customers/X/ar_balance/">
    <total>[decimal]</total>

    <!-- 0 or more invoices -->
    <invoice uri="/invoices/Y/" id="Y">
        <credit_amount>[decimal]</credit_amount>
        <datetime_created>[datetime]</datetime_created>
        <invoice_id>[str]</invoice_id>
    </invoice>
</ar_balance>

Return the list of a customer's contacts

<!-- No XML Request. -->

<contacts>
    <contact uri="/customers/X/contacts/Y/ id="Y">
        <!-- See GET /customers/X/contacts/Y/ for details. -->
    </contact>
    [...]
</contacts>

Return a specific customer's contact

<!-- No XML Request. -->

<contact uri="/customers/X/contacts/Y/" id="Y">
    <name>
        <first>[str]</first>
        <last>[str]</last>
    </name>
    <department>[str]
    <position>[str]
    <email>[str]
    <notes>[str]</note>
    <phone_numbers>
        <phone_number>
            <type>[enum: work|home|mobile|main|home fax|work fax|toll-free|other]</type>
            <list_order>[int]</list_order>
            <number>[str]</number>
        </phone_number>
        <phone_number>
            <type>[enum: work|home|mobile|main|home fax|work fax|toll-free|other]</type>
            <list_order>[int]</list_order>
            <number>[str]</number>
        </phone_number>
        <!-- A contact can have 0 - 2 phone numbers, and no more -->
    </phone_numbers>
    <address>
        <address1>[str]</address1>
        <address2>[str]</address2>
        <city>[str]</city>
        <state>[str]</state>
        <country>[str]</country>
        <zip>[str]</zip>
    </address>
</contact>

Return the current credit outstanding for the customer.

<!-- No XML Request -->

<credit_status uri="/customers/X/credit_status/">
    <total>[decimal]</total>
</credit_status>

Return the photo of a specific customer

<!-- No XML Request -->

[Binary Image Data]

Add a photo for a specific customer

[Binary Image Data]

<response>
    <customer uri="/customers/X/" id="X">
        <!-- See GET /customers/X/ response for details -->
    </customer>
</response>

Update the photo of a specific customer

[Binary Image Data]

<!-- No XML Response -->

Return a list of notes for the customer

<!-- No XML Request -->

<notes>
    <note uri="/customers/X/notes/Y/" id="Y"/>
    [...]
</notes>

Create a new note for the customer

<note>
    <title>[str]</title>
    <note>[str]</note>
    <follow_up>[bool]</follow_up> <!-- Optional -->
    <follow_up_datetime>[datetime]</follow_up_datetime> <!-- Optional -->
</note>

<note uri="/customers/X/notes/Y/" id="Y">
    <!-- See GET /customers/X/notes/Y/ response for details. -->
</note>

Return a specific note for the customer

<!-- No XML Request -->

<note uri="/customers/X/notes/Y/" id="Y">
    <title>[str]</title>
    <note>[str]</note>
    <datetime_created>[datetime]</datetime_created>
    <follow_up>[bool]</follow_up>
    <user uri="/users/Z/" id="Z"/>
</note>

Update a note for the customer

<note>
    <title>[str]</title> <!-- Optional -->
    <note>[str]</note> <!-- Optional -->
    <follow_up>[bool]</follow_up> <!-- Optional -->
    <follow_up_datetime>[datetime]</follow_up_datetime> <!-- Optional -->
</note>

<note uri="/customers/X/notes/Y/" id="Y">
    <!-- See GET /customers/X/notes/Y/ response for details. -->
</note>

Delete a customer note

<!-- No XML Request -->

<note uri="/customers/X/notes/Y/" id="Y" deleted="true"/>

<!-- No XML Request. -->

<search_criteria>
    <columns>
        <column id="[str]">
            <name>
                <localizable_message/> <!-- mutually exclusive with <raw> -->
                <raw>[str]</raw><!-- mutually exclusive with <localizable_message> -->
            </name> <!-- The localizable name of this column -->
            <type>[enum: STRING | INTEGER | DECIMAL | MONEY | DATE | DATETIME | BOOLEAN]</type>
            <required>[bool]</required><!-- Indicates that this item must be part of the query -->
            <default>[bool]</default><!-- Indicates which columns should be selected by default -->
            <sort_default>[bool]</sort_default><!-- Indicates that this column should be selected as the sort column by default -->
            <sort_default_order_by>[enum: ASC | DESC]</sort_default_order_by><!-- Indicates what the default order by should be for this column -->
            <can_summarize>[bool]</can_summarize><!-- Indicates that this column can be used to generate a summarized total -->

        </column>
        [...]
    </columns>
    <filters>
        <filter id="[str]">
            <name>
                <localizable_message/> <!-- mutually exclusive with <raw> -->
                <raw>[str]</raw><!-- mutually exclusive with <localizable_message> -->
            </name> <!-- The localizable name of this filter -->
            <type>[enum: ENUM | STRING | INTEGER | DECIMAL | MONEY | DATE | DATETIME | BOOLEAN ]</type><!-- Defines the type of data this filter represents -->
            <enum_values><!-- Present if and only if type is ENUM -->
                <enum_value>
                    <name>
                        <localizable_message/> <!-- Mutually exclusive with <raw> -->
                        <raw>[str]</raw> <!-- Mutually exclusive with <localizable_message> -->
                    </name> <!-- The name to be displayed -->
                    <value>[str]</value> <!-- The value to be passed to the server in <filters> of a POST -->
                </enum_value>
                [...]
           </enum_values>

        </filter>
        [...]
    </filters>
</search_criteria>

Executes a search based on the content of the post. Responses are streamed to
the client.

Note: Read only clients may POST searches.

<search>
    <include_total>[bool]</include_total> <!-- True by default -->
    <page> <!-- optional if getting the whole dataset -->
        <offset>[int]</offset> <!-- optional -->
        <count>[int]</count> <!-- optional -->
    </page>
    <summarized_column><!-- Optional. When specified, a summarized total is added to the data -->
        <column id="[str]"/>
    </summarized_column>
    <search_query>
        <columns><!-- optional. If no columns are specified, the default columns are selected.-->
            <column id="[str]"/>
            [...]
        </columns>
        <sort_by_column><!-- optional. If not specified, the default columns is used for sorting.  -->
            <column id="[str]"/>
            <order_by>[enum: ASC | DESC]</order_by><!-- Optional. If not specified the default order by is used.-->
        </sort_by_column>
        <filters><!-- optional or content optional-->
            <!--
                Predicate search based on the filter list from the GET

                Predicate searches take the form of:

                lsserver.search.column.fictional_column > 10 AND (lsserver.search.column.fictional_column2 == 0 OR lsserver.search.column.fictional_column3 != 0)
            -->
        </filters>
    </search_query>
</search>

<data>
    <info>
        <total_count>[int]</total_count>
        <summarized_column>
            <column>
                <name>
                    <localizable_message/> <!-- mutually exclusive with <raw> -->
                    <raw>[str]</raw><!-- mutually exclusive with <localizable_message> -->
                </name>
                <type>[enum: INTEGER | DECIMAL | MONEY ]</type>
            </column>
        </summarized_column>
        <summarized_total>[int|decimal]</summarized_total>
    </info>
    <columns>
        <column>
            <name>
                <localizable_message/> <!-- mutually exclusive with <raw> -->
                <raw>[str]</raw><!-- mutually exclusive with <localizable_message> -->
            </name>
            <type>[enum: STRING | INTEGER | DECIMAL | MONEY | DATE | DATETIME | BOOLEAN]</type>
        </column>
        [...]
    </columns>
    <rows>
        <row>
            <links> <!-- Links to relevant documents -->
                <link>
                    <product uri="" id="" />
                </link>
                [...]
            </links>
            <cell>
                <type>[enum: STRING | INTEGER | DECIMAL | MONEY | DATE | DATETIME | BOOLEAN]</type>
                <value>[str | int | decimal | date | datetime | bool]</value>
            </cell>
            [...] <!-- The count will always match the column count -->
        </row>
    </rows>
</data>