GetCustomersBySynchronisation

From
(Difference between revisions)
Jump to: navigation, search
(Parameters)
(Description)
Line 3: Line 3:
  
 
== Description ==
 
== Description ==
Retrieve customer record(s), specified by the customer's ID in the external record (e.g.  Accounting package), from the customer synchronisation table.
+
Retrieve the customer(s), specified by the ID of the customer(s) in the external application data to which they are synchronised to, from the customer synchronisation table. If the last parameter, i.e. afterPK, is not null, the customer record(s) retrieved must have a Primary Key greater than the afterPK.
If the last parameter, i.e. afterPK, is not null, the customer record(s) retrieved must have a Primary Key greater than the afterPK.
+
  
 
== Parameters ==
 
== Parameters ==

Revision as of 21:49, 3 January 2006

Contents

Method

GetCustomersBySynchronisationResult getCustomersBySynchronisation(UserIDBean userID, String synchronisationID, String synchronisationReference, String afterPK)

Description

Retrieve the customer(s), specified by the ID of the customer(s) in the external application data to which they are synchronised to, from the customer synchronisation table. If the last parameter, i.e. afterPK, is not null, the customer record(s) retrieved must have a Primary Key greater than the afterPK.

Parameters

Type Name Description
UserIDBean userID The admin username and password.
String synchronisationID The ID of the organisation to which the customer record(s) have been synchronised to. It is usually the name of the organisation.
String synchronisationReference The ID of the customer record (that has been synchronised) in the external record, i.e. accounting package's Account ID.
String afterPK The lower bound of the PK of the customer record(s) that can be retrieved.

Return Value

GetCustomersBySynchronisationResult

Personal tools
MediaWiki Appliance - Powered by TurnKey Linux