Accounting Code
Use this request to retrieve a list of accounting codes.
Notes
NOTE: Accounting codes is an optional extension in Informz. If the extension is not enabled, this request will not be available.
This would be used as part of the mail-publishing process. The user interface (UI) must present this for selection if it is to be included.
Data Element | Type | Length | Conditional | Description |
---|---|---|---|---|
code | String | 50 | True | The internal bill-back code used to allocate mailing costs. |
Count | Int | False | The number of matches found based on the specified criteria. | |
Description | String | 200 | True | The description of the accounting code. |
is_accounting_default | Bit | True | A flag that indicates whether this is the default accounting code. |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Test Brand</Brand> <User></User> <Grids> <Grid type="accounting_code"> <ReturnFields> <DataElement>accounting_code_id</DataElement> <DataElement>code</DataElement> <DataElement>description</DataElement> <DataElement>is_accounting_default</DataElement> <DataElement>is_deleted</DataElement> </ReturnFields> </Grid> </Grids> </GridRequest>
Response
<?xml version="1.0" encoding="utf-16"?> <GridResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Test Brand</Brand> <User></User> <Grids> <Grid type="accounting_code"> <Record row="1"> <Fields> <Field element="accounting_code_id">1039</Field> <Field element="code">111</Field> <Field element="description">Marketing Dept</Field> <Field element="is_accounting_default">1</Field> <Field element="is_deleted">0</Field> </Fields> </Record> <Record row="2"> <Fields> <Field element="accounting_code_id">1040</Field> <Field element="code">222</Field> <Field element="description">Sales Dept</Field> <Field element="is_accounting_default">0</Field> <Field element="is_deleted">0</Field> </Fields> </Record> <Record row="3"> <Fields> <Field element="accounting_code_id">1041</Field> <Field element="code">333</Field> <Field element="description">Human Resources</Field> <Field element="is_accounting_default">0</Field> <Field element="is_deleted">0</Field> </Fields> </Record> </Grid> </Grids> </GridResponse>
Notes
- Each accounting code is returned within its own row block.
- Maximum of 1,000 rows can be returned in one request.
Upload History
Use this request to retrieve upload details.
Enter the UploadID to retrieve details about a specific upload. If the upload was initiated via a BulkUpload request, the UploadID is received as part of the response.
Data Element | Type | Length | Conditional | Description |
---|---|---|---|---|
upload_id | Int | True | Unique Upload ID | |
brand_id | Int | True | Brand ID | |
uploader_subscriber_id | Int | True | Subscriber ID of the uploader | |
uploader_user_id | String | 50 | True | Subscriber ID for the remote system |
uploader_user_id_source | String | 50 | True | Subscriber source for the remote system |
uploader_email | String | 100 | True | Subscriber Email Address of the uploader |
uploader_name | String | 50 | True | Name of the uploader |
date | Datetime | True | Upload date | |
status | String | 15 | True | Upload status |
total_email_count | Int | True | Total number of uploaded email addresses | |
invalid_email_count | Int | True | Number of invalid email addresses | |
changed_email_count | Int | True | Number of changed email addresses | |
previous_count | Int | True | Number of previous subscribers | |
new_count | Int | True | Number of new subscribers | |
duplicate_email_count | Int | True | Number of duplicate records in the upload file | |
mobile_email_count | Int | True | Number of mobile email addresses | |
previous_unsubscriber_count | Int | True | Number of previous unsubscribers | |
invalid_mobile_phone_count | Int | True | Number of invalid mobile phone numbers | |
invalid_mobile_phones_num | Int | True | Count |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Brand Name</Brand> <User>admin</User> <Password></Password> <Grids> <Grid type="upload_history"> <ReturnFields> <DataElement>changed_email_count</DataElement> <DataElement>date</DataElement> <DataElement>duplicate_email_count</DataElement> <DataElement>invalid_email_count</DataElement> <DataElement>invalid_mobile_phone_count</DataElement> <DataElement>mobile_email_count</DataElement> <DataElement>new_count</DataElement> <DataElement>previous_count</DataElement> <DataElement>previous_unsubscriber_count</DataElement> <DataElement>status</DataElement> <DataElement>total_email_count</DataElement> <DataElement>upload_id</DataElement> <DataElement>uploader_email</DataElement> <DataElement>uploader_name</DataElement> <DataElement>uploader_user_id</DataElement> <DataElement>uploader_subscriber_id</DataElement> <DataElement>interest_list</DataElement> <DataElement>unsubscribe</DataElement> </ReturnFields> </Grid> </Grids> </GridRequest>
Response
<?xml version="1.0" encoding="utf-8"?> <GridResponse xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Brand Name</Brand> <User>admin</User> <Grids> <Grid type="upload_history"> <Record row="1"> <Fields> <Field element="changed_email_count">0</Field> <Field element="date">2016-06-05T06:30:51.4930000Z</Field> <Field element="duplicate_email_count">0</Field> <Field element="invalid_email_count">2</Field> <Field element="invalid_mobile_phone_count">0</Field> <Field element="mobile_email_count">0</Field> <Field element="new_count">358</Field> <Field element="previous_count">0</Field> <Field element="previous_unsubscriber_count">0</Field> <Field element="status">Successful</Field> <Field element="total_email_count">358</Field> <Field element="upload_id">3964</Field> <Field element="uploader_email" /> <Field element="uploader_name" /> <Field element="uploader_user_id" /> <Field element="uploader_subscriber_id">-1</Field> <Field element="interest_list" /> <Field element="unsubscribe">1</Field> </Fields> </Record> ... </Grid> </Grids> </GridResponse>