| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Payments:
[
{
DocumentHeader:
{
AcSupPaymentMID: String,
AcSupplierID: String,
AcLocationID: String,
DocumentDate: 0001-01-01,
RefDocumentNo: String,
DocumentRemark: String,
ExtraRemark1: String,
ExtraRemark2: String,
ExtraRemark3: String,
ExtraRemark4: String,
AcSupPaymentTypeID: String,
Payee: String,
DocumentItemCurrencyAmount: 0,
IsUseTransactionSupplierElement: False,
AcEInvoiceDocumentFlowID: String,
EInvoiceRegName_Supplier: String,
EInvoiceRegTIN_Supplier: String,
EInvoiceRegNumber_Supplier: String,
EInvoiceSupplierIsMalaysian: String,
EInvoiceSupplierRegType: String,
EInvoiceRegSSTNumber_Supplier: String,
EInvoiceRegTourismTaxRegNumber_Supplier: String,
EInvoiceRegEmail_Supplier: String,
AcEInvoiceSupplierMSICID_Supplier: String,
EInvoiceRegBusinessActivityDescription_Supplier: String,
EInvoiceAddressLine0_Supplier: String,
EInvoiceAddressLine1_Supplier: String,
EInvoiceAddressLine2_Supplier: String,
EInvoiceAddressPostalZone_Supplier: String,
EInvoiceAddressCityName_Supplier: String,
AcEInvoiceAddressStateID_Supplier: String,
AcEInvoiceAddressCountryID_Supplier: String,
EInvoiceRegContactNumber_Supplier: String,
IsEnableEInvoiceMYS: String,
AcEInvoiceDocumentStatusID: String,
IsConsolidatedEInvoice: String,
EInvoiceDocumentNumber_Consolidated: String,
EInvoiceSubmissionUUID: String,
EInvoiceValidationUUID: String,
EInvoiceValidationDateTime: 0001-01-01,
EInvoiceValidationLink: String
},
DocumentDetails:
[
{
AcSupPaymentDID: String,
AcSupPaymentMID: String,
ItemNo: 0,
AccountNoItem: String,
ItemRemark1: String,
ItemAmount: 0,
AcEInvoiceItemClassificationID: String,
AcEInvoiceItemTaxTypeID: String
}
],
DocumentPaymentDetails:
[
{
AcSupPaymentMID: String,
ItemNo: 0,
AcBillPaymentMethodID: String,
ItemReferenceNumber: String,
ItemRemark1: String,
ItemCurrencyPaymentAmount: 0
}
]
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}