Element

SQL Data Type

Mandatory

Description

VendorTokenGUID

GUID

Yes

Specific GUID that Synergetic will give the third party app to validate them upon every web service request.

VersionNumber

Decimal(4,2)

Yes

To cater for extending the web service and return the version specific format. Default 2.5.

ConfigFileName

Varchar(max)

No

Optional - if missing or blank then the authentication details into DB are found in WebServiceSynergetic.XML in the website folder.

ID

Integer

No

Optional for returning a single Creditor record by ID.

SupplierCategory

Varchar(max)

No

Optional for listing Creditors for a particular supplier category. In some cases this will be hard coded

Element

SQL Data Type

Description

ID

Integer

Creditor community ID.

CreditorName

Varchar(max)

Creditor Name.

ABN

Varchar(max)

Australian Business Number

Address1

Varchar(max)

First Address Line

Address2

Varchar(max)

Second Address Line

Address3

Varchar (max)

Third Address Line

Suburb

Varchar (max)

Creditor Address Suburb

State

Varchar (max)

Creditor Address State

Postcode

Varchar (max)

Creditor Address PostCode

CountryDescription

Varchar (max)

Creditor Address Country

Email

Varchar (max)

Email address.

Phone

Varchar (max)

Business phone number.

Fax

Varchar (max)

Business fax.

MobilePhone

Varchar (max)

Business mobile number.

ActiveFlag

Bit

If the Creditor is active (1) or not (0).

CurrentBalance

Money

How much money the creditor owes

HoldPaymentFlag

Bit

Whether payment should be held for the creditor for any reason.

CreditorModifiedDate

Date

Date the Creditors Record was last modified in dd/mm/yyyy format.

AddressModifiedDate

Date

Date the Creditor's Address Record was last modified in dd/mm/yyyy format.