SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

Customers

Customer Module

Customers API

Requires Authentication
Required permission:Customer-Setup.GET
The following routes are available for this service:
GET/Customers/page/{Page}Get records by given a page numberEach page consists of 20 records
GET/Customers/EditDate/{EditDate}
GET/Customers/CustomerID/{AcCustomerID}
GET/Customers/MobileNo/{MobileNo}
GET/Customers
Customers Parameters:
NameParameterData TypeRequiredDescription
Pagepathint?No
EditDatepathDateTime?No
AcCustomerIDpathstringNo
MobileNopathstringNo
CustomersResponse Parameters:
NameParameterData TypeRequiredDescription
CustomersformList<AcCustomer>No
ResponseStatusformResponseStatusNo
AcCustomer 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
CreateByformstringYesCreate By
CreateDateformDateTimeYesCreate Date & Time
EditByformstringYesEdit By
EditDateformDateTimeYesEdit Date
StampformintYesRecord Stamp. Default 0
AcCustomerNickNameformstringNoCustomer Nickname
DateOfBirthformDateTimeNoDate of Birth
IsMemberformstringYesIs Member? (Y/N)
GenderformstringYesGender (M/F)
MemberNoformstringNoMember Number
MobileNoformstringNoMobile Number
IdentityNoformstringNoIdentity Number
MemberJoinDateformDateTimeYesMember Join Date
MemberExpireDateformDateTimeYesMember Expiry Date
MemberMarriageDateformDateTimeYesMember Marriage Date
AcMemberEthnicIDformstringYesMember Ethnic (Race) ID
AcMemberIncomeIDformstringYesMember Income ID
AcMemberOccupationIDformstringNoMember Occupation ID, IsRequired = true
MemberPointBalanceformdecimalYesMember Point Balance
MemberPointAccumulatedformdecimalYesMember Accumulated Point
PriceCodeformstringYesPrice Code. (Value valid from 1 - 5)
AcSalesmanIDformstringYesSalesman ID
IsGSTRegisterformstringYesIs GST Registered. (Y/N)
GSTRegisterNumberformstringNoGST Registration Number
BusinessRegisterNumberformstringNoBusiness Registration Number
AcCurrencyIDformstringYesCurrency ID
IsAllowPrintStatementformstringYesIs Allow Print Statement? (Y/N)
IsAllowExceedCreditTermformstringYesIs Allow Exceed Credit Term? (Y/N)
IsAllowExceedCreditLimitformstringYesIs Allow Exceed Credit Limit? (Y/N)
LocalCreditLimitformdecimalYesCredit Limit Amount (Local Currency)
LocalBalanceAmountformdecimalYesOutstanding Amount (Local Currency)
AcTaxIDformstringNoTax ID
IsAllowCreditSalesForPOSformstringYesIs Allow Credit Sales at Point of Sales? (Y/N)
MemberNotesformstringNoNotes
AcINCardPackageIDformstringNoINCard Package ID
AcCustomerIDParentIDformstringYesParent Customer ID. Default to Customer ID
TaxSLTRegistrationNoformstringNoSales Tax Registration Number
TaxSVTRegistrationNoformstringNoService Tax Registration Number
AcTaxIDSSTformstringNoTax ID for SST
SSTExemptionCertNumberformstringNoSST Exemption Certificate Number
EInvoiceRegNameformstringNoE-Invoice Registration Name
EInvoiceRegTINformstringNoE-Invoice Registration TIN
EInvoiceRegNumberformstringNoE-Invoice Registration Number
EInvoiceIsMalaysianformstringNoIs Malaysian
EInvoiceRegTypeformstringNoRegistration Type
EInvoiceRegNumber_NRICformstringNoRegistration Number NRIC
EInvoiceRegNumber_PASSPORTformstringNoRegistration Number Passport
EInvoiceRegNumber_BRNformstringNoRegistration Number BRN
EInvoiceRegNumber_ARMYformstringNoRegistration Number Army
EInvoiceRegSSTNumberformstringNoRegistration SST Number
EInvoiceRegTourismTaxRegNumberformstringNoTourism Tax Registration Number
EInvoiceRegEmailformstringNoRegistration Email
AcEInvoiceSupplierMSICIDformstringNoMSIC ID Supplier
EInvoiceRegBusinessActivityDescriptionformstringNoBusiness Activity Description Supplier
EInvoiceRegContactNumberformstringNoContact Number Supplier
EInvoiceAddressLine0formstringNoAddress Line 0 Supplier
EInvoiceAddressLine1formstringNoAddress Line 1 Supplier
EInvoiceAddressLine2formstringNoAddress Line 2 Supplier
EInvoiceAddressPostalZoneformstringNoPostal Zone Supplier
EInvoiceAddressCityNameformstringNoCity Name Supplier
AcEInvoiceAddressStateIDformstringNoState ID Supplier
AcEInvoiceAddressCountryIDformstringNoCountry ID Supplier
EInvoiceIsEnabledTINValidationformstringNoIs Enabled TIN Validation
EInvoiceIsEnabledAutoTINValidationformstringNoIs Enabled Auto TIN Validation
EInvoiceIsTINValidateSuccessformstringNoIs TIN Validate Success
EInvoiceTINValidateDateTimeformDateTime?NoTIN Validate DateTime
EInvoiceTINValidateByformstringNoTIN Validate By
EInvoiceTINValidateRequestBodyformstringNoTIN Validate Request Body
EInvoiceTINValidateResponseBodyformstringNoTIN Validate Response Body
EInvoiceTINValidateResponseStatusformstringNoTIN Validate Response Status
EInvoiceTINValidateProcessLogformstringNoTIN Validate Process Log
EInvoiceIsNotApplicableformstringNoIs Not Applicable

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/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,
			CreateBy: String,
			CreateDate: 0001-01-01,
			EditBy: String,
			EditDate: 0001-01-01,
			Stamp: 0,
			AcCustomerNickName: String,
			DateOfBirth: 0001-01-01,
			IsMember: String,
			Gender: String,
			MemberNo: String,
			MobileNo: String,
			IdentityNo: String,
			MemberJoinDate: 0001-01-01,
			MemberExpireDate: 0001-01-01,
			MemberMarriageDate: 0001-01-01,
			AcMemberEthnicID: String,
			AcMemberIncomeID: String,
			AcMemberOccupationID: String,
			MemberPointBalance: 0,
			MemberPointAccumulated: 0,
			PriceCode: String,
			AcSalesmanID: String,
			IsGSTRegister: String,
			GSTRegisterNumber: String,
			BusinessRegisterNumber: String,
			AcCurrencyID: String,
			IsAllowPrintStatement: String,
			IsAllowExceedCreditTerm: String,
			IsAllowExceedCreditLimit: String,
			LocalCreditLimit: 0,
			LocalBalanceAmount: 0,
			AcTaxID: String,
			IsAllowCreditSalesForPOS: String,
			MemberNotes: String,
			AcINCardPackageID: String,
			AcCustomerIDParentID: String,
			TaxSLTRegistrationNo: String,
			TaxSVTRegistrationNo: String,
			AcTaxIDSST: String,
			SSTExemptionCertNumber: String,
			EInvoiceRegName: String,
			EInvoiceRegTIN: String,
			EInvoiceRegNumber: String,
			EInvoiceIsMalaysian: String,
			EInvoiceRegType: String,
			EInvoiceRegNumber_NRIC: String,
			EInvoiceRegNumber_PASSPORT: String,
			EInvoiceRegNumber_BRN: String,
			EInvoiceRegNumber_ARMY: String,
			EInvoiceRegSSTNumber: String,
			EInvoiceRegTourismTaxRegNumber: String,
			EInvoiceRegEmail: String,
			AcEInvoiceSupplierMSICID: String,
			EInvoiceRegBusinessActivityDescription: String,
			EInvoiceRegContactNumber: String,
			EInvoiceAddressLine0: String,
			EInvoiceAddressLine1: String,
			EInvoiceAddressLine2: String,
			EInvoiceAddressPostalZone: String,
			EInvoiceAddressCityName: String,
			AcEInvoiceAddressStateID: String,
			AcEInvoiceAddressCountryID: String,
			EInvoiceIsEnabledTINValidation: String,
			EInvoiceIsEnabledAutoTINValidation: String,
			EInvoiceIsTINValidateSuccess: String,
			EInvoiceTINValidateDateTime: 0001-01-01,
			EInvoiceTINValidateBy: String,
			EInvoiceTINValidateRequestBody: String,
			EInvoiceTINValidateResponseBody: String,
			EInvoiceTINValidateResponseStatus: String,
			EInvoiceTINValidateProcessLog: String,
			EInvoiceIsNotApplicable: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}