SWAPI – Change Queries

CustomerChangeQuery

This command can be used to retrieve a list of customers that have changed since the date specified. Changes that will result in a customer showing up in this query consist of

· Changes to service location or billing account name, address, phone number, email, location type, lead source, or communication preferences (optin, optout).

· Activating or terminating agreements for the location.

This command requires the use of pagination.

Request

</CustomerChangeQuery>

</SessionRequest>

· Note that the parameter ChangedSince is required.

· ChangedSince uses date time format as YYYY-MM-DDThh:mm:ss.

· This time is Coordinated Universal Time (Zulu time) format without a time zone designator.

· This command supports pagination which should be used to prevent large datasets.

This command requires the use of pagination.

Response

<?xml version="1.0"?>

<LocationID>integer</LocationID>

<LocationFirstName>string(25)</LocationFirstName>

<LocationLastName>string(35)</LocationLastName>

<LocationCompanyName>string(35)</LocationCompanyName>

<LocationAddress1>string(35)</LocationAddress1>

<LocationAddress2>string(35)</LocationAddress2>

<LocationCity>string(20)</LocationCity>

<LocationState>string(2)</LocationState>

<LocationZip>string(10)</LocationZip>

<LocationPhone1>string(12)</LocationPhone1>

<LocationEmailAddress>string(150)</LocationEmailAddress>

<HasAgreement>boolean</HasAgreement>

<HasPerpetualAgreement>boolean</HasPerpetualAgreement>

<AgreementStartDate>dateTime</AgreementStartDate>

<AgreementEndDate>dateTime</AgreementEndDate>

<LocationLocationType>string(6)</LocationLocationType>

<LocationLeadSource>string(6)</LocationLeadSource>

<BillingAccountID>integer</BillingAccountID>

<BillingFirstName>string(25)</BillingFirstName>

<BillingLastName>string(35)</BillingLastName>

<BillingCompanyName>string(35)</BillingCompanyName>

<BillingAddress1>string(35)</BillingAddress1>

<BillingAddress2>string(35)</BillingAddress2>

<BillingCity>string(20)</BillingCity>

<BillingState>string(2)</BillingState>

<BillingZip>string(10)</BillingZip>

<BillingPhone1>string(12)</BillingPhone1>

<BillingEmailAddress>string(150)</BillingEmailAddress>

<DoNotSolicit>boolean</DoNotSolicit>

<NoHappyChecks>boolean</NoHappyChecks>

<CommClass>string(25)</CommClass>

<OptInRequired>boolean</OptInRequired>

<OptIn>boolean</OptIn>

<OptOut>boolean</OptOut>

</dsCustChangeBillingCommPref>

</dsCustChangeBillingCommPrefList>

<CommClass>string(25)</CommClass>

<OptInRequired>boolean</OptInRequired>

<OptIn>boolean</OptIn>

<OptOut>boolean</OptOut>

</dsCustChangeLocationCommPref>

</dsCustChangeLocationCommPrefList>

</CustomerChangeQueryRecord>

</CustomerChangeQueryData>

InvoiceChangeQuery

This command can be used to retrieve a list of new invoices since the date supplied. This list will also include any invoices that have been adjusted and reposted or voided since that date.

Request

</InvoiceChangeQuery>

</SessionRequest>

· Note that the parameter ChangedSince is required.

· ChangedSince uses date time format as YYYY-MM-DDThh:mm:ss.

· This time is Coordinated Universal Time (Zulu time) format without a time zone designator.

· This command supports pagination which should be used to prevent large datasets.

Response

<?xml version="1.0"?>

<InvoiceID>integer</InvoiceID>

<InvoiceDate>dateTime</InvoiceDate>

<BillingAccountID>integer</BillingAccountID>

<LocationID>integer</LocationID>

<InvoiceNo>string(10)</InvoiceNo>

<JobNo>string(10)</JobNo>

<JobClass>string(15)</JobClass>

<JobType>string(6)</JobType>

<JobLeadSource>string(6)</JobLeadSource>

<JobLeadSourceType>string(16)</JobLeadSourceType>

<JobDepartment>string(2)</JobDepartment>

<InvoiceDepartment>string(2)</InvoiceDepartment>

<InvoiceSubTotal>float</InvoiceSubTotal>

<InvoiceTotalAmount>float</InvoiceTotalAmount>

<InvoiceNetBalance>float</InvoiceNetBalance>

<InvoiceID>integer</InvoiceID>

<ItemNumber>string(15)</ItemNumber>

<Quantity>float</Quantity>

<UnitPrice>float</UnitPrice>

<TotalSale>float</TotalSale>

<DiscountAmount>float</DiscountAmount>

<TotalAfterDiscount>float</TotalAfterDiscount>

<ChargeTo>string(1)</ChargeTo>

</dsInvoiceChangeItem>

</dsInvoiceChangeItemList>

</InvoiceChangeQueryRecord>

</InvoiceChangeQueryData>

SWAPI Pagination

Some datasets returned by SWAPI can be quite large. To avoid pulling too much data at one time and risking time outs and disconnects, the commands support pagination.

Post

For commands that support pagination, pages can be requested using the attributes PageSize and PageNo.

</PricebookItemQuery>

</SessionRequest>

The resulting XML for paginated requests will include pagination attributes for PageSize, PageNo and PageCount. PageCount indicates the total number of pages of data available for that PageSize.

</PricebookItemQueryResponse>