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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompaniesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <Companies xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:AcCompany>
      <d2p1:AcCompanyID>String</d2p1:AcCompanyID>
      <d2p1:AcCompanyName>String</d2p1:AcCompanyName>
      <d2p1:AcCurrencyID>String</d2p1:AcCurrencyID>
      <d2p1:AcEInvoiceAddressCountryID>String</d2p1:AcEInvoiceAddressCountryID>
      <d2p1:AcEInvoiceAddressStateID>String</d2p1:AcEInvoiceAddressStateID>
      <d2p1:AcEInvoiceSupplierMSICID>String</d2p1:AcEInvoiceSupplierMSICID>
      <d2p1:Address1>String</d2p1:Address1>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:Address3>String</d2p1:Address3>
      <d2p1:Address4>String</d2p1:Address4>
      <d2p1:EInvoiceAddressCityName>String</d2p1:EInvoiceAddressCityName>
      <d2p1:EInvoiceAddressLine0>String</d2p1:EInvoiceAddressLine0>
      <d2p1:EInvoiceAddressLine1>String</d2p1:EInvoiceAddressLine1>
      <d2p1:EInvoiceAddressLine2>String</d2p1:EInvoiceAddressLine2>
      <d2p1:EInvoiceAddressPostalZone>String</d2p1:EInvoiceAddressPostalZone>
      <d2p1:EInvoiceIsMalaysian>String</d2p1:EInvoiceIsMalaysian>
      <d2p1:EInvoiceRegBusinessActivityDescription>String</d2p1:EInvoiceRegBusinessActivityDescription>
      <d2p1:EInvoiceRegContactNumber>String</d2p1:EInvoiceRegContactNumber>
      <d2p1:EInvoiceRegEmail>String</d2p1:EInvoiceRegEmail>
      <d2p1:EInvoiceRegName>String</d2p1:EInvoiceRegName>
      <d2p1:EInvoiceRegNumber>String</d2p1:EInvoiceRegNumber>
      <d2p1:EInvoiceRegNumber_ARMY>String</d2p1:EInvoiceRegNumber_ARMY>
      <d2p1:EInvoiceRegNumber_BRN>String</d2p1:EInvoiceRegNumber_BRN>
      <d2p1:EInvoiceRegNumber_NRIC>String</d2p1:EInvoiceRegNumber_NRIC>
      <d2p1:EInvoiceRegNumber_PASSPORT>String</d2p1:EInvoiceRegNumber_PASSPORT>
      <d2p1:EInvoiceRegSSTNumber>String</d2p1:EInvoiceRegSSTNumber>
      <d2p1:EInvoiceRegTIN>String</d2p1:EInvoiceRegTIN>
      <d2p1:EInvoiceRegTourismTaxRegNumber>String</d2p1:EInvoiceRegTourismTaxRegNumber>
      <d2p1:EInvoiceRegType>String</d2p1:EInvoiceRegType>
      <d2p1:RegistrationNo>String</d2p1:RegistrationNo>
    </d2p1:AcCompany>
  </Companies>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CompaniesResponse>