GetCustomersBySynchronisation

From
(Difference between revisions)
Jump to: navigation, search
(Description)
(Parameters)
Line 16: Line 16:
 
|The admin username and password.
 
|The admin username and password.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
|[[CustomerSynchronisationBean]] Array
+
|String
|customers
+
|synchronisationID
|An array of synchronisation beans, indicating which records are to be marked as synchronized, and attaching any external custom data that is needed.
+
|The ID of the organisation to which the customer records have been synchronised to.  Usually it is the name of the organisation.
 +
|---- bgcolor=#EDEDFF
 +
|String
 +
|synchronisationReference
 +
|The ID of the customer that has been synchronised in the external record, i.e. accounting package's Account ID.
 +
|---- bgcolor=#EDEDFF|String
 +
|afterPK
 +
|The lower bound of the PK of the customer that can be retrieved.  
 
|}
 
|}
  
 
== Return Value ==
 
== Return Value ==
 
[[AckCustomerSynchronisationResult]]
 
[[AckCustomerSynchronisationResult]]

Revision as of 20:43, 3 January 2006

Contents

Method

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

Description

Get a customer, specified by the customer's Account ID, retrieved from the customer synchronisation table. If the last parameter, i.e. afterPK, is not null, the customer 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 records have been synchronised to. Usually it is the name of the organisation.
String synchronisationReference The ID of the customer that has been synchronised in the external record, i.e. accounting package's Account ID.
afterPK The lower bound of the PK of the customer that can be retrieved.

Return Value

AckCustomerSynchronisationResult

MediaWiki Appliance - Powered by TurnKey Linux