Required permission: | SupplierPayment-Transaction.GET |
GET | /SupplierOtherPayments/simple | ||
---|---|---|---|
GET | /SupplierOtherPayments/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
GET | /SupplierOtherPayments/simple/Payment/{AcSupPaymentMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Page | path | int? | No | |
AcSupPaymentMID | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Payments | form | List<SupplierOtherPaymentSimple> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentHeader | form | DocumentHeader | Yes | Customer Payment Header - Primary Key: AcCusPaymentMID |
DocumentDetails | form | DocumentDetails | Yes | Customer Payment Knock-Off Details - Primary Key: AcCusPaymentMID, ItemNo, MatchType, MatchDocumentNo. Note: You may get the outstanding list from CustomerOutstandingDocumentListing service. |
DocumentPaymentDetails | form | DocumentKnockOffDetails | Yes | Customer Payment Payment Details - Primary Key: AcCusPaymentMID, ItemNo, AcBillPaymentMethodID. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AcSupPaymentMID | form | NVARCHAR(20) | Yes | Payment Number |
AcSupplierID | form | NVARCHAR(20) | Yes | Supplier ID |
AcLocationID | form | NVARCHAR(20) | Yes | Location ID |
DocumentDate | form | DATE | Yes | Payment Date |
RefDocumentNo | form | NVARCHAR(50) | No | Reference Number |
DocumentRemark | form | NVARCHAR(100) | No | Document Remark |
ExtraRemark1 | form | NVARCHAR(100) | No | Extra Remark 1 |
ExtraRemark2 | form | NVARCHAR(100) | No | Extra Remark 2 |
ExtraRemark3 | form | NVARCHAR(100) | No | Extra Remark 3 |
ExtraRemark4 | form | NVARCHAR(100) | No | Extra Remark 4 |
AcSupPaymentTypeID | form | NVARCHAR(20) | Yes | Payment Type ID (OTHER PAYMENT) (Read-Only) |
Payee | form | NVARCHAR(100) | Yes | Payee Name. Default to Supplier Name |
DocumentItemCurrencyAmount | form | NUMERIC(18,2) | Yes | Total Item Amount. (Read-Only) |
IsUseTransactionSupplierElement | form | Boolean | No | Use Transaction's Supplier Element?. True: Supplier Elements will stored based on provided value; False: Supplier Elements will stored based on Supplier Profile's E-Invoice Elements |
AcEInvoiceDocumentFlowID | form | NVARCHAR(100) | No | E-Invoice Document Flow ID. Open; Ready to Submit; Not Applicable |
EInvoiceRegName_Supplier | form | NVARCHAR(300) | No | E-Invoice Registration Name Supplier |
EInvoiceRegTIN_Supplier | form | NVARCHAR(40) | No | E-Invoice Registration TIN Supplier |
EInvoiceRegNumber_Supplier | form | NVARCHAR(40) | No | E-Invoice Registration Number Supplier |
EInvoiceSupplierIsMalaysian | form | NVARCHAR(1) | Yes | E-Invoice Supplier Is Malaysian. Y/N |
EInvoiceSupplierRegType | form | NVARCHAR(20) | No | E-Invoice Supplier Registration Type. NRIC/BRN/PASSPORT/ARMY |
EInvoiceRegSSTNumber_Supplier | form | NVARCHAR(40) | No | E-Invoice Registration SST Number Supplier |
EInvoiceRegTourismTaxRegNumber_Supplier | form | NVARCHAR(40) | No | E-Invoice Tourism Tax Registration Number Supplier |
EInvoiceRegEmail_Supplier | form | NVARCHAR(320) | No | E-Invoice Registration Email Supplier |
AcEInvoiceSupplierMSICID_Supplier | form | NVARCHAR(5) | No | E-Invoice MSIC Code Supplier |
EInvoiceRegBusinessActivityDescription_Supplier | form | NVARCHAR(300) | No | E-Invoice Business Activity Description (MSIC) Supplier |
EInvoiceAddressLine0_Supplier | form | NVARCHAR(150) | No | E-Invoice Address Line 0 Supplier |
EInvoiceAddressLine1_Supplier | form | NVARCHAR(150) | No | E-Invoice Address Line 1 Supplier |
EInvoiceAddressLine2_Supplier | form | NVARCHAR(150) | No | E-Invoice Address Line 2 Supplier |
EInvoiceAddressPostalZone_Supplier | form | NVARCHAR(50) | No | E-Invoice Address Postal Zone Buyer |
EInvoiceAddressCityName_Supplier | form | NVARCHAR(50) | No | E-Invoice Address City Name Supplier |
AcEInvoiceAddressStateID_Supplier | form | NVARCHAR(20) | No | E-Invoice Address State ID Supplier. 00 to 17 |
AcEInvoiceAddressCountryID_Supplier | form | NVARCHAR(20) | No | E-Invoice Address Country ID Supplier. MYS |
EInvoiceRegContactNumber_Supplier | form | NVARCHAR(20) | No | E-Invoice Registration Contact Number Supplier |
IsEnableEInvoiceMYS | form | NVARCHAR(1) | No | E-Invoice Is Enabled. (Read-Only) |
AcEInvoiceDocumentStatusID | form | NVARCHAR(40) | No | E-Invoice Document Status ID. (Read-Only). Valid;Invalid;Submitted;Cancelled |
IsConsolidatedEInvoice | form | NVARCHAR(1) | No | E-Invoice Is Marked for Consolidated E-Invoice. Y/N. (Read-Only) |
EInvoiceDocumentNumber_Consolidated | form | NVARCHAR(50) | No | E-Invoice Consolidated E-Invoice Document Number. (Read-Only) |
EInvoiceSubmissionUUID | form | NVARCHAR(40) | No | E-Invoice Submission UUID. (Read-Only) |
EInvoiceValidationUUID | form | NVARCHAR(40) | No | E-Invoice Validation UUID. (Read-Only) |
EInvoiceValidationDateTime | form | DATETIME | No | E-Invoice Validated Datetime. (Read-Only) |
EInvoiceValidationLink | form | NVARCHAR(MAX) | No | E-Invoice Validation Link. (Read-Only) |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AcSupPaymentDID | form | NVARCHAR(40) | Yes | Record ID. Recommend use GUID |
AcSupPaymentMID | form | NVARCHAR(20) | Yes | Payment Number |
ItemNo | form | INT | Yes | Item Number |
AccountNoItem | form | NVARCHAR(MAX) | Yes | Item Account Number |
ItemRemark1 | form | NVARCHAR(MAX) | Yes | Item Remark 1 |
ItemAmount | form | NUMERIC(18,2) | Yes | Item Amount. |
AcEInvoiceItemClassificationID | form | NVARCHAR(20) | No | E-Invoice Item Classification Code (Read-Only) |
AcEInvoiceItemTaxTypeID | form | NVARCHAR(20) | No | E-Invoice Item Tax Type Code (Read-Only) |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AcSupPaymentMID | form | NVARCHAR(20) | Yes | Payment Number |
ItemNo | form | INT | Yes | Item Number |
AcBillPaymentMethodID | form | NVARCHAR(20) | Yes | Bill Payment Method ID |
ItemReferenceNumber | form | NVARCHAR(100) | No | Reference Number |
ItemRemark1 | form | NVARCHAR(MAX) | Yes | Item Remark 1 |
ItemCurrencyPaymentAmount | form | NUMERIC(18,2) | Yes | Item Currency Payment Amount |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /SupplierOtherPayments/simple HTTP/1.1 Host: snr2u.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SupplierOtherPaymentsSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel"> <Payments xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types"> <d2p1:SupplierOtherPaymentSimple> <d2p1:DocumentDetails> <d2p1:AcSupOtherPaymentDSimple> <d2p1:AcEInvoiceItemClassificationID>String</d2p1:AcEInvoiceItemClassificationID> <d2p1:AcEInvoiceItemTaxTypeID>String</d2p1:AcEInvoiceItemTaxTypeID> <d2p1:AcSupPaymentDID>String</d2p1:AcSupPaymentDID> <d2p1:AcSupPaymentMID>String</d2p1:AcSupPaymentMID> <d2p1:AccountNoItem>String</d2p1:AccountNoItem> <d2p1:ItemAmount>0</d2p1:ItemAmount> <d2p1:ItemNo>0</d2p1:ItemNo> <d2p1:ItemRemark1>String</d2p1:ItemRemark1> </d2p1:AcSupOtherPaymentDSimple> </d2p1:DocumentDetails> <d2p1:DocumentHeader> <d2p1:AcEInvoiceAddressCountryID_Supplier>String</d2p1:AcEInvoiceAddressCountryID_Supplier> <d2p1:AcEInvoiceAddressStateID_Supplier>String</d2p1:AcEInvoiceAddressStateID_Supplier> <d2p1:AcEInvoiceDocumentFlowID>String</d2p1:AcEInvoiceDocumentFlowID> <d2p1:AcEInvoiceDocumentStatusID>String</d2p1:AcEInvoiceDocumentStatusID> <d2p1:AcEInvoiceSupplierMSICID_Supplier>String</d2p1:AcEInvoiceSupplierMSICID_Supplier> <d2p1:AcLocationID>String</d2p1:AcLocationID> <d2p1:AcSupPaymentMID>String</d2p1:AcSupPaymentMID> <d2p1:AcSupPaymentTypeID>String</d2p1:AcSupPaymentTypeID> <d2p1:AcSupplierID>String</d2p1:AcSupplierID> <d2p1:DocumentDate>0001-01-01T00:00:00</d2p1:DocumentDate> <d2p1:DocumentItemCurrencyAmount>0</d2p1:DocumentItemCurrencyAmount> <d2p1:DocumentRemark>String</d2p1:DocumentRemark> <d2p1:EInvoiceAddressCityName_Supplier>String</d2p1:EInvoiceAddressCityName_Supplier> <d2p1:EInvoiceAddressLine0_Supplier>String</d2p1:EInvoiceAddressLine0_Supplier> <d2p1:EInvoiceAddressLine1_Supplier>String</d2p1:EInvoiceAddressLine1_Supplier> <d2p1:EInvoiceAddressLine2_Supplier>String</d2p1:EInvoiceAddressLine2_Supplier> <d2p1:EInvoiceAddressPostalZone_Supplier>String</d2p1:EInvoiceAddressPostalZone_Supplier> <d2p1:EInvoiceDocumentNumber_Consolidated>String</d2p1:EInvoiceDocumentNumber_Consolidated> <d2p1:EInvoiceRegBusinessActivityDescription_Supplier>String</d2p1:EInvoiceRegBusinessActivityDescription_Supplier> <d2p1:EInvoiceRegContactNumber_Supplier>String</d2p1:EInvoiceRegContactNumber_Supplier> <d2p1:EInvoiceRegEmail_Supplier>String</d2p1:EInvoiceRegEmail_Supplier> <d2p1:EInvoiceRegName_Supplier>String</d2p1:EInvoiceRegName_Supplier> <d2p1:EInvoiceRegNumber_Supplier>String</d2p1:EInvoiceRegNumber_Supplier> <d2p1:EInvoiceRegSSTNumber_Supplier>String</d2p1:EInvoiceRegSSTNumber_Supplier> <d2p1:EInvoiceRegTIN_Supplier>String</d2p1:EInvoiceRegTIN_Supplier> <d2p1:EInvoiceRegTourismTaxRegNumber_Supplier>String</d2p1:EInvoiceRegTourismTaxRegNumber_Supplier> <d2p1:EInvoiceSubmissionUUID>String</d2p1:EInvoiceSubmissionUUID> <d2p1:EInvoiceSupplierIsMalaysian>String</d2p1:EInvoiceSupplierIsMalaysian> <d2p1:EInvoiceSupplierRegType>String</d2p1:EInvoiceSupplierRegType> <d2p1:EInvoiceValidationDateTime>0001-01-01T00:00:00</d2p1:EInvoiceValidationDateTime> <d2p1:EInvoiceValidationLink>String</d2p1:EInvoiceValidationLink> <d2p1:EInvoiceValidationUUID>String</d2p1:EInvoiceValidationUUID> <d2p1:ExtraRemark1>String</d2p1:ExtraRemark1> <d2p1:ExtraRemark2>String</d2p1:ExtraRemark2> <d2p1:ExtraRemark3>String</d2p1:ExtraRemark3> <d2p1:ExtraRemark4>String</d2p1:ExtraRemark4> <d2p1:IsConsolidatedEInvoice>String</d2p1:IsConsolidatedEInvoice> <d2p1:IsEnableEInvoiceMYS>String</d2p1:IsEnableEInvoiceMYS> <d2p1:IsUseTransactionSupplierElement>false</d2p1:IsUseTransactionSupplierElement> <d2p1:Payee>String</d2p1:Payee> <d2p1:RefDocumentNo>String</d2p1:RefDocumentNo> </d2p1:DocumentHeader> <d2p1:DocumentPaymentDetails> <d2p1:AcSupOtherPaymentPaySimple> <d2p1:AcBillPaymentMethodID>String</d2p1:AcBillPaymentMethodID> <d2p1:AcSupPaymentMID>String</d2p1:AcSupPaymentMID> <d2p1:ItemCurrencyPaymentAmount>0</d2p1:ItemCurrencyPaymentAmount> <d2p1:ItemNo>0</d2p1:ItemNo> <d2p1:ItemReferenceNumber>String</d2p1:ItemReferenceNumber> <d2p1:ItemRemark1>String</d2p1:ItemRemark1> </d2p1:AcSupOtherPaymentPaySimple> </d2p1:DocumentPaymentDetails> </d2p1:SupplierOtherPaymentSimple> </Payments> <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> </SupplierOtherPaymentsSimpleResponse>