SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

CustomersSimple

Customer Module

Customers API

Requires Authentication
Required permission:Customer-Setup.GET
The following routes are available for this service:
GET/Customers/simple/page/{Page}Get records by given a page numberEach page consists of 20 records
GET/Customers/simple/EditDate/{EditDate}
GET/Customers/simple/CustomerID/{AcCustomerID}
GET/Customers/simple/MobileNo/{MobileNo}
GET/Customers/simple
CustomersSimple Parameters:
NameParameterData TypeRequiredDescription
Pagepathint?No
EditDatepathDateTime?No
AcCustomerIDpathstringNo
MobileNopathstringNo
CustomersSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
CustomersformList<AcCustomerSimple>No
ResponseStatusformResponseStatusNo
AcCustomerSimple Parameters:
NameParameterData TypeRequiredDescription
AcCustomerIDformstringYesCustomer ID
AcCustomerNameformstringYesCustomer Name
AcTermIDformstringYesTerm ID
AcAreaIDformstringYesArea ID
AcCusGroupIDformstringYesCustomer Group ID
AcCusUDGroupIDformstringYesCustomer User Define Group ID
BillingAddress1formstringNoBilling Address 1
BillingAddress2formstringNoBilling Address 2
BillingAddress3formstringNoBilling Address 3
BillingAddress4formstringNoBilling Address 4
BillingTel1formstringNoBilling Phone 1
BillingTel2formstringNoBilling Phone 2
BillingFax1formstringNoBilling Fax 1
BillingFax2formstringNoBilling Fax 2
BillingPostalCodeformstringNoBilling Postal Code
BillingContact1formstringNoBilling Contact 1
BillingContact2formstringNoBilling Contact 2
BillingEmailformstringNoBilling Email Address
BillingHomePageformstringNoBilling Home Page
IsActiveformstringYesIs Active? (Y/N)
NotesformstringNoNotes
AcCustomerNickNameformstringYesCustomer Nickname
DateOfBirthformDateTimeYesDate of Birth
IsMemberformstringYesIs Member? (Y/N)
GenderformstringYesGender (M/F)
MemberNoformstringYesMember Number
MobileNoformstringNoMobile Number
IdentityNoformstringYesIdentity Number
MemberJoinDateformDateTimeYesMember Join Date
MemberExpireDateformDateTimeYesMember Expiry Date
AcMemberEthnicIDformstringYesMember Ethnic (Race) ID
AcMemberIncomeIDformstringYesMember Income ID
AcMemberOccupationIDformstringYesMember Occupation ID
PriceCodeformstringYesPrice Code. (Value valid from 1 - 5)
AcSalesmanIDformstringYesSalesman ID
MemberNotesformstringNoNotes
EditDateformDateTimeNoEditDate

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Customers/simple/page/{Page} HTTP/1.1 
Host: snr2u.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Customers: 
	[
		{
			AcCustomerID: String,
			AcCustomerName: String,
			AcTermID: String,
			AcAreaID: String,
			AcCusGroupID: String,
			AcCusUDGroupID: String,
			BillingAddress1: String,
			BillingAddress2: String,
			BillingAddress3: String,
			BillingAddress4: String,
			BillingTel1: String,
			BillingTel2: String,
			BillingFax1: String,
			BillingFax2: String,
			BillingPostalCode: String,
			BillingContact1: String,
			BillingContact2: String,
			BillingEmail: String,
			BillingHomePage: String,
			IsActive: String,
			Notes: String,
			AcCustomerNickName: String,
			DateOfBirth: 0001-01-01,
			IsMember: String,
			Gender: String,
			MemberNo: String,
			MobileNo: String,
			IdentityNo: String,
			MemberJoinDate: 0001-01-01,
			MemberExpireDate: 0001-01-01,
			AcMemberEthnicID: String,
			AcMemberIncomeID: String,
			AcMemberOccupationID: String,
			PriceCode: String,
			AcSalesmanID: String,
			MemberNotes: String,
			EditDate: 0001-01-01
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}