api.data_export

/api/data_export/

GET /api/data_export/

Description:

Return the current data export job. The data export job is a job that runs in
the background to export selected data such as products and invoices.

While the data export job is running, the developer can still perform other operations
such as running Lightspeed or making other API requests.

If the job status is QUEUED OR RUNNING, then the job is in progress and files should
appear soon in the directory specified in export_path.

Since the job can take a long time to run, developers are encouraged to
do long polling GET requests using the long_polling_id header with an unique string.
When the server receives a long polling request, it will try to return
the latest information when there is a change / update to the job status or message.

Note: This resource is only available to advanced plus clients.
can_lock requires_lock has_etag requires_etag
False False False False
Header Name Description
long_polling_id [str]. Used to long poll the status and progress of the running job.

Response:

<data_export uri="/data_export/">
    <status>[ENUM: QUEUED | RUNNING | COMPLETED | CANCELED | FAILED]</status> <!-- If the status is COMPLETED, CANCELLED, FAILED, another job can be triggered through the /data_export/run/ resource. -->
    <progress>[decimal]</progress>
    <message>[str]</message>
    <error class="[str]" type="[str]"> <!-- Last error occurred during the export. Empty if no error.
        <!-- LS Error rendering. -->
    </error>
    <settings> <!-- These are the same settings as when defined in the run request. -->
        <export_path>[str]</export_path> <!-- Absolute path to the export directory. -->
        <stop_on_error>[bool]</stop_on_error> <!-- If false, will skip specific errors when exporting an item and continue exporting the next item. -->
        <lief_version>[str]</lief_version> <!-- The lief version of generated export files -->
        <items>
            <tax>
                <export>[bool]</export> <!-- If true, tax will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, tax whose Tax id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, tax whose Tax id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </tax>
            <tax_code>
                <export>[bool]</export> <!-- If true, tax_code will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, tax_code whose TaxCode id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, tax_code whose TaxCode id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </tax_code>
            <tax_exemption>
                <export>[bool]</export> <!-- If true, tax_exemption will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, tax_exemption whose TaxStatus id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, tax_exemption whose TaxStatus id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </tax_exemption>
            <category>
                <export>[bool]</export> <!-- If true, category will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, category whose Category id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, category whose Category id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </category>
            <user>
                <export>[bool]</export> <!-- If true, user will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, user whose User id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, user whose User id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </user>
            <customer>
                <export>[bool]</export> <!-- If true, customer will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, customer whose Customer id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, customer whose Customer id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </customer>
            <supplier>
                <export>[bool]</export> <!-- If true, supplier will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, supplier whose Supplier id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, supplier whose Supplier id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </supplier>
            <product>
                <export>[bool]</export> <!-- If true, product will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, product whose Product id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, product whose Product id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </product>
            <product_photo>
                <export>[bool]</export> <!-- If true, product_photo will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, product_photo whose ProductPhoto id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, product_photo whose ProductPhoto id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </product_photo>
            <gift_card>
                <export>[bool]</export> <!-- If true, gift_card will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, gift_card whose GiftCard id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, gift_card whose GiftCard id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </gift_card>
            <invoice>
                <export>[bool]</export> <!-- If true, invoice will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, invoice whose Invoice id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, invoice whose Invoice id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </invoice>
            <available_balance>
                <export>[bool]</export> <!-- If true, available_balance will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, available_balance whose Customer id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, available_balance whose Customer id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </available_balance>
        </items>
    </settings>
</data_export>

/api/data_export/cancel/

POST /api/data_export/cancel/

Description:

Cancel the current background export data job. If the job is still being queued,
it will be canceled right away. However, if the job has already started running,
it might take a bit for the job to finish what it is doing before it is canceled
completely.

Note: This resource is only available to advanced plus clients.
can_lock requires_lock has_etag requires_etag
False False False False

Response:

<data_export uri="/data_export/">
    <status>[ENUM: QUEUED | RUNNING | COMPLETED | CANCELED | FAILED]</status> <!-- If the status is COMPLETED, CANCELLED, FAILED, another job can be triggered through the /data_export/run/ resource. -->
    <progress>[decimal]</progress>
    <message>[str]</message>
    <error class="[str]" type="[str]"> <!-- Last error occurred during the export. Empty if no error.
        <!-- LS Error rendering. -->
    </error>
    <settings> <!-- These are the same settings as when defined in the run request. -->
        <export_path>[str]</export_path> <!-- Absolute path to the export directory. -->
        <stop_on_error>[bool]</stop_on_error> <!-- If false, will skip specific errors when exporting an item and continue exporting the next item. -->
        <lief_version>[str]</lief_version> <!-- The lief version of generated export files -->
        <items>
            <tax>
                <export>[bool]</export> <!-- If true, tax will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, tax whose Tax id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, tax whose Tax id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </tax>
            <tax_code>
                <export>[bool]</export> <!-- If true, tax_code will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, tax_code whose TaxCode id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, tax_code whose TaxCode id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </tax_code>
            <tax_exemption>
                <export>[bool]</export> <!-- If true, tax_exemption will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, tax_exemption whose TaxStatus id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, tax_exemption whose TaxStatus id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </tax_exemption>
            <category>
                <export>[bool]</export> <!-- If true, category will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, category whose Category id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, category whose Category id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </category>
            <user>
                <export>[bool]</export> <!-- If true, user will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, user whose User id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, user whose User id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </user>
            <customer>
                <export>[bool]</export> <!-- If true, customer will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, customer whose Customer id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, customer whose Customer id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </customer>
            <supplier>
                <export>[bool]</export> <!-- If true, supplier will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, supplier whose Supplier id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, supplier whose Supplier id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </supplier>
            <product>
                <export>[bool]</export> <!-- If true, product will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, product whose Product id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, product whose Product id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </product>
            <product_photo>
                <export>[bool]</export> <!-- If true, product_photo will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, product_photo whose ProductPhoto id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, product_photo whose ProductPhoto id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </product_photo>
            <gift_card>
                <export>[bool]</export> <!-- If true, gift_card will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, gift_card whose GiftCard id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, gift_card whose GiftCard id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </gift_card>
            <invoice>
                <export>[bool]</export> <!-- If true, invoice will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, invoice whose Invoice id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, invoice whose Invoice id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </invoice>
            <available_balance>
                <export>[bool]</export> <!-- If true, available_balance will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, available_balance whose Customer id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, available_balance whose Customer id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </available_balance>
        </items>
    </settings>
</data_export>

/api/data_export/run/

POST /api/data_export/run/

Description:

Trigger a background job to export various data. The background job will be queued
and run shortly after the request. Export files will eventually appear. At any time,
the developer can request for the latest state of the job through the
GET /api/data_export/ resource. Note that at any moment, there can be only
one export job queued or running. The server will return an error if the developer
tries to run more than one at a time.

Data that can be exported includes:
[tax, tax_code, tax_exemption, category, user, customer, supplier, product, product_photo, gift_card, invoice, available_balance].

The data can be exported based on various settings, such as the directory
the files will be exported to, the types of data to be exported such as products
and invoices only.

The data will be saved into zip-compressed json files under the folder
"Data Export [datetime_export]" in the given export_path directory for easy parsing.
The file names will be formatted using "[data_type]_[datetime_export]_[counter].lief-packet.zip"
in order to make it easy to recognize and organize for each type.

There will also be a running log file "Data Export Log" that will output what
the background job is doing, as well as an "Errors.lief-packet.zip" file that will be generated
when errors occur. If the setting stop_on_error is False, these log and error
files will keep track of the list of errors encountered during the export.

The background job will export the data in the listed order as they appear above.

Note: This resource is only available to advanced plus clients.
can_lock requires_lock has_etag requires_etag
False False False False

Request:

<data_export>
    <settings>
        <export_path>[str]</export_path> <!-- Optional. The absolute path to a directory where export files will be saved to. Defaults to /Users/Shared/LightSpeed. The directory must have write mission for the _lightspeedserver user. -->
        <stop_on_error>[bool]</stop_on_error> <!-- Optional. Defaults to false. If false, will skip specific errors when exporting an item and continue exporting the next item. -->
        <lief_version>[str]</lief_version> <!-- Optional. The export package lief version. Minimum version: 1.1.0. Defaults to 1.2.1. -->
        <items>
            <tax> <!-- Optional. Will not export tax if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export tax whose Tax id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export tax whose Tax id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of tax per file. -->
            </tax>
            <tax_code> <!-- Optional. Will not export tax_code if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export tax_code whose TaxCode id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export tax_code whose TaxCode id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of tax_code per file. -->
            </tax_code>
            <tax_exemption> <!-- Optional. Will not export tax_exemption if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export tax_exemption whose TaxStatus id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export tax_exemption whose TaxStatus id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of tax_exemption per file. -->
            </tax_exemption>
            <category> <!-- Optional. Will not export category if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export category whose Category id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export category whose Category id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of category per file. -->
            </category>
            <user> <!-- Optional. Will not export user if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export user whose User id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export user whose User id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of user per file. -->
            </user>
            <customer> <!-- Optional. Will not export customer if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export customer whose Customer id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export customer whose Customer id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of customer per file. -->
            </customer>
            <supplier> <!-- Optional. Will not export supplier if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export supplier whose Supplier id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export supplier whose Supplier id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of supplier per file. -->
            </supplier>
            <product> <!-- Optional. Will not export product if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export product whose Product id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export product whose Product id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of product per file. -->
            </product>
            <product_photo> <!-- Optional. Will not export product_photo if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export product_photo whose ProductPhoto id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export product_photo whose ProductPhoto id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 5. Will export up to given number of product_photo per file. -->
            </product_photo>
            <gift_card> <!-- Optional. Will not export gift_card if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export gift_card whose GiftCard id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export gift_card whose GiftCard id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of gift_card per file. -->
            </gift_card>
            <invoice> <!-- Optional. Will not export invoice if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export invoice whose Invoice id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export invoice whose Invoice id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 100. Will export up to given number of invoice per file. -->
            </invoice>
            <available_balance> <!-- Optional. Will not export available_balance if not present. -->
                <export>[bool]</export> <!-- Optional. Defaults to false. Will not export if false. -->
                <start> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export available_balance whose Customer id is greater than or equal to this value. Best used to continue from a previous run. -->
                </start>
                <end> <!-- Optional -->
                    <id>[int]</id> <!-- When specified, only export available_balance whose Customer id is smaller than or equal to this value. Best used to limit the number of items exported. -->
                </end>
                <records_per_file>[int]</records_per_file> <!-- Optional. Defaults to 1000. Will export up to given number of available_balance per file. -->
            </available_balance>
        </items>
    </settings>
</data_export>

Response:

<data_export uri="/data_export/">
    <status>[ENUM: QUEUED | RUNNING | COMPLETED | CANCELED | FAILED]</status> <!-- If the status is COMPLETED, CANCELLED, FAILED, another job can be triggered through the /data_export/run/ resource. -->
    <progress>[decimal]</progress>
    <message>[str]</message>
    <error class="[str]" type="[str]"> <!-- Last error occurred during the export. Empty if no error.
        <!-- LS Error rendering. -->
    </error>
    <settings> <!-- These are the same settings as when defined in the run request. -->
        <export_path>[str]</export_path> <!-- Absolute path to the export directory. -->
        <stop_on_error>[bool]</stop_on_error> <!-- If false, will skip specific errors when exporting an item and continue exporting the next item. -->
        <lief_version>[str]</lief_version> <!-- The lief version of generated export files -->
        <items>
            <tax>
                <export>[bool]</export> <!-- If true, tax will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, tax whose Tax id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, tax whose Tax id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </tax>
            <tax_code>
                <export>[bool]</export> <!-- If true, tax_code will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, tax_code whose TaxCode id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, tax_code whose TaxCode id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </tax_code>
            <tax_exemption>
                <export>[bool]</export> <!-- If true, tax_exemption will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, tax_exemption whose TaxStatus id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, tax_exemption whose TaxStatus id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </tax_exemption>
            <category>
                <export>[bool]</export> <!-- If true, category will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, category whose Category id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, category whose Category id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </category>
            <user>
                <export>[bool]</export> <!-- If true, user will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, user whose User id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, user whose User id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </user>
            <customer>
                <export>[bool]</export> <!-- If true, customer will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, customer whose Customer id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, customer whose Customer id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </customer>
            <supplier>
                <export>[bool]</export> <!-- If true, supplier will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, supplier whose Supplier id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, supplier whose Supplier id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </supplier>
            <product>
                <export>[bool]</export> <!-- If true, product will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, product whose Product id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, product whose Product id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </product>
            <product_photo>
                <export>[bool]</export> <!-- If true, product_photo will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, product_photo whose ProductPhoto id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, product_photo whose ProductPhoto id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </product_photo>
            <gift_card>
                <export>[bool]</export> <!-- If true, gift_card will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, gift_card whose GiftCard id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, gift_card whose GiftCard id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </gift_card>
            <invoice>
                <export>[bool]</export> <!-- If true, invoice will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, invoice whose Invoice id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, invoice whose Invoice id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </invoice>
            <available_balance>
                <export>[bool]</export> <!-- If true, available_balance will be exported. -->
                <start>
                    <id>[int]</id> <!-- If present, available_balance whose Customer id is greater than or equal to this value will be exported. -->
                </start>
                <end>
                    <id>[int]</id> <!-- If present, available_balance whose Customer id is smaller than or equal to this value will be exported. -->
                </end>
                <records_per_file>[int]</records_per_file>
            </available_balance>
        </items>
    </settings>
</data_export>