SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

SuppliersSimple

Supplier Module

Suppliers API

Requires Authentication
Required permission:Supplier-Setup.GET
The following routes are available for this service:
GET/Suppliers/simple
GET/Suppliers/simple/page/{Page}Get records by given a page numberEach page consists of 20 records
GET/Suppliers/simple/EditDate/{EditDate}
GET/Suppliers/simple/SupplierID/{AcSupplierID}
SuppliersSimple Parameters:
NameParameterData TypeRequiredDescription
EditDatepathDateTime?No
AcSupplierIDpathstringNo
Pagepathint?NoPage Number. Default 1.
RecordsPerPagequeryint?NoRecords Per Page. Default 20 Records.
SuppliersSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
SuppliersformList<AcSupplierSimple>No
ResponseStatusformResponseStatusNo
TotalRecordsformintNoTotal records in all pages.
TotalRecordsInPageformintNoTotal records in current page.
AcSupplierSimple Parameters:
NameParameterData TypeRequiredDescription
AcSupplierIDformstringYesSupplier ID
AcSupplierNameformstringYesSupplier Name
AcTermIDformstringYesTerm ID
AcSupGroupIDformstringYesSupplier Group ID
AcSupUDGroupIDformstringYesSupplier 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
IsGSTRegisterformstringYesIs GST Registered (Y/N)
GSTRegisterNumberformstringNoGST Registration Number
IsGSTSelfBilledformstringYesGST Is Self-billed (Y/N)
GSTSelfBilledApprovalNumberformstringNoGST Self-billed Approval Number
BusinessRegisterNumberformstringNoBusiness Registration Number
AcTaxIDformstringNoGST Tax ID
AcSupplierNickNameformstringNoSupplier Nickname
PurchasePriceIsGSTInclusiveformstringYesGST Purchase Price Is Inclusive (Y/N)
TaxSLTRegistrationNoformstringNoSST Sales Tax Registration Number
TaxSVTRegistrationNoformstringNoSST Service Tax Registration Number
AcTaxIDSSTformstringNoSST Tax ID
SSTExemptionCertNumberformstringNoSST Tax Exemption Certificate Number
WhatsAppIDformstringNoWhastapp 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
EInvoiceIsSelfBilledSupplierformstringNoIs Self Billed Supplier
EditDateformDateTimeNoEditDate

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 /Suppliers/simple HTTP/1.1 
Host: snr2u.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SuppliersSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <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>
  <Suppliers xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:AcSupplierSimple>
      <d2p1:AcEInvoiceAddressCountryID>String</d2p1:AcEInvoiceAddressCountryID>
      <d2p1:AcEInvoiceAddressStateID>String</d2p1:AcEInvoiceAddressStateID>
      <d2p1:AcEInvoiceSupplierMSICID>String</d2p1:AcEInvoiceSupplierMSICID>
      <d2p1:AcSupGroupID>String</d2p1:AcSupGroupID>
      <d2p1:AcSupUDGroupID>String</d2p1:AcSupUDGroupID>
      <d2p1:AcSupplierID>String</d2p1:AcSupplierID>
      <d2p1:AcSupplierName>String</d2p1:AcSupplierName>
      <d2p1:AcSupplierNickName>String</d2p1:AcSupplierNickName>
      <d2p1:AcTaxID>String</d2p1:AcTaxID>
      <d2p1:AcTaxIDSST>String</d2p1:AcTaxIDSST>
      <d2p1:AcTermID>String</d2p1:AcTermID>
      <d2p1:BillingAddress1>String</d2p1:BillingAddress1>
      <d2p1:BillingAddress2>String</d2p1:BillingAddress2>
      <d2p1:BillingAddress3>String</d2p1:BillingAddress3>
      <d2p1:BillingAddress4>String</d2p1:BillingAddress4>
      <d2p1:BillingContact1>String</d2p1:BillingContact1>
      <d2p1:BillingContact2>String</d2p1:BillingContact2>
      <d2p1:BillingEmail>String</d2p1:BillingEmail>
      <d2p1:BillingFax1>String</d2p1:BillingFax1>
      <d2p1:BillingFax2>String</d2p1:BillingFax2>
      <d2p1:BillingHomePage>String</d2p1:BillingHomePage>
      <d2p1:BillingPostalCode>String</d2p1:BillingPostalCode>
      <d2p1:BillingTel1>String</d2p1:BillingTel1>
      <d2p1:BillingTel2>String</d2p1:BillingTel2>
      <d2p1:BusinessRegisterNumber>String</d2p1:BusinessRegisterNumber>
      <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:EInvoiceIsEnabledAutoTINValidation>String</d2p1:EInvoiceIsEnabledAutoTINValidation>
      <d2p1:EInvoiceIsEnabledTINValidation>String</d2p1:EInvoiceIsEnabledTINValidation>
      <d2p1:EInvoiceIsMalaysian>String</d2p1:EInvoiceIsMalaysian>
      <d2p1:EInvoiceIsSelfBilledSupplier>String</d2p1:EInvoiceIsSelfBilledSupplier>
      <d2p1:EInvoiceIsTINValidateSuccess>String</d2p1:EInvoiceIsTINValidateSuccess>
      <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:EInvoiceTINValidateBy>String</d2p1:EInvoiceTINValidateBy>
      <d2p1:EInvoiceTINValidateDateTime>0001-01-01T00:00:00</d2p1:EInvoiceTINValidateDateTime>
      <d2p1:EInvoiceTINValidateProcessLog>String</d2p1:EInvoiceTINValidateProcessLog>
      <d2p1:EInvoiceTINValidateRequestBody>String</d2p1:EInvoiceTINValidateRequestBody>
      <d2p1:EInvoiceTINValidateResponseBody>String</d2p1:EInvoiceTINValidateResponseBody>
      <d2p1:EInvoiceTINValidateResponseStatus>String</d2p1:EInvoiceTINValidateResponseStatus>
      <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
      <d2p1:GSTRegisterNumber>String</d2p1:GSTRegisterNumber>
      <d2p1:GSTSelfBilledApprovalNumber>String</d2p1:GSTSelfBilledApprovalNumber>
      <d2p1:IsActive>String</d2p1:IsActive>
      <d2p1:IsGSTRegister>String</d2p1:IsGSTRegister>
      <d2p1:IsGSTSelfBilled>String</d2p1:IsGSTSelfBilled>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:PurchasePriceIsGSTInclusive>String</d2p1:PurchasePriceIsGSTInclusive>
      <d2p1:SSTExemptionCertNumber>String</d2p1:SSTExemptionCertNumber>
      <d2p1:TaxSLTRegistrationNo>String</d2p1:TaxSLTRegistrationNo>
      <d2p1:TaxSVTRegistrationNo>String</d2p1:TaxSVTRegistrationNo>
      <d2p1:WhatsAppID>String</d2p1:WhatsAppID>
    </d2p1:AcSupplierSimple>
  </Suppliers>
  <TotalRecords>0</TotalRecords>
  <TotalRecordsInPage>0</TotalRecordsInPage>
</SuppliersSimpleResponse>