SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

Companies

Common Module

Companies API

Requires Authentication
Required permission:Company-Setup.GET
The following routes are available for this service:
GET/CompaniesCompanies recordsList of company available
CompaniesResponse Parameters:
NameParameterData TypeRequiredDescription
CompaniesformList<AcCompany>No
ResponseStatusformResponseStatusNo
AcCompany Parameters:
NameParameterData TypeRequiredDescription
AcCompanyIDformstringYesCompany ID
AcCompanyNameformstringYesCompany Name
AcCurrencyIDformstringYesCompany's Currency ID
Address1formstringYesAddress 1
Address2formstringYesAddress 2
Address3formstringYesAddress 3
Address4formstringYesAddress 4
RegistrationNoformstringYesBusiness Registration Number (BRN)
EInvoiceRegNameformstringNoE-Invoice Registration Name
EInvoiceRegTINformstringNoE-Invoice Registration TIN
EInvoiceRegNumberformstringNoE-Invoice Registration Number
EInvoiceIsMalaysianformstringYesE-Invoice Buyer Is Malaysian
EInvoiceRegTypeformstringYesE-Invoice Buyer Registration Type
EInvoiceRegNumber_NRICformstringNoE-Invoice Buyer Registration Number (NRIC)
EInvoiceRegNumber_PASSPORTformstringNoE-Invoice Buyer Registration Number (PASSPORT)
EInvoiceRegNumber_BRNformstringNoE-Invoice Buyer Registration Number (BRN)
EInvoiceRegNumber_ARMYformstringNoE-Invoice Buyer Registration Number (ARMY)
EInvoiceRegSSTNumberformstringNoE-Invoice Registration SST Number
EInvoiceRegTourismTaxRegNumberformstringNoE-Invoice Registration Tourism Tax Registration Number
EInvoiceRegEmailformstringNoE-Invoice Registration Email
AcEInvoiceSupplierMSICIDformstringNoE-Invoice Supplier MSIC ID
EInvoiceRegBusinessActivityDescriptionformstringNoE-Invoice Registration Business Activity Description
EInvoiceRegContactNumberformstringNoE-Invoice Registration Contact Number
EInvoiceAddressLine0formstringNoE-Invoice Address Line 0
EInvoiceAddressLine1formstringNoE-Invoice Address Line 1
EInvoiceAddressLine2formstringNoE-Invoice Address Line 2
EInvoiceAddressPostalZoneformstringNoE-Invoice Address Postal Zone
EInvoiceAddressCityNameformstringNoE-Invoice Address City Name
AcEInvoiceAddressStateIDformstringNoE-Invoice Address State ID
AcEInvoiceAddressCountryIDformstringNoE-Invoice Address Country ID

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 /Companies HTTP/1.1 
Host: snr2u.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Companies: 
	[
		{
			AcCompanyID: String,
			AcCompanyName: String,
			AcCurrencyID: String,
			Address1: String,
			Address2: String,
			Address3: String,
			Address4: String,
			RegistrationNo: 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
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}