| Required permission: | SupplierRefundNote-Transaction.GET |
| GET | /SupplierRefundNotes/simple | ||
|---|---|---|---|
| GET | /SupplierRefundNotes/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
| GET | /SupplierRefundNotes/simple/RefundNote/{AcSupRefundNoteMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
| GET | /SupplierRefundNotes/simple/EditDate/{fromEditDate}/{toEditDate} | Get records by given Edit Date range | Date format yyyy-MM-dd |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | |
| AcSupRefundNoteMID | path | string | No | |
| fromEditDate | path | DateTime? | No | |
| toEditDate | path | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RefundNotes | form | List<SupplierRefundNoteSimple> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentHeader | form | DocumentHeader | Yes | Supplier Refund Note Header - Primary Key: AcSupRefundNoteMID |
| DocumentDetails | form | DocumentDetails | Yes | Supplier Refund Note Details - Primary Key: AcSupRefundNoteMID, ItemNo. |
| DocumentPaymentDetails | form | DocumentPaymentDetails | Yes | Supplier Refund Note Payment Details - Primary Key: AcSupRefundNoteMID, ItemNo.Check out BillPaymentMethods service for list of available AcBillPaymentMethodID. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcSupRefundNoteMID | form | NVARCHAR(20) | Yes | Refund Note Number |
| AcSupplierID | form | NVARCHAR(20) | Yes | Supplier ID |
| AcLocationID | form | NVARCHAR(20) | Yes | Location ID |
| DocumentDate | form | DATE | Yes | Refund Note Date |
| AcTermID | form | NVARCHAR(20) | Yes | Term ID |
| SupplierRefundNoteNumber | form | NVARCHAR(20) | Yes | Supplier Refund Note Number |
| DocumentNetAmount | form | NUMERIC(18,2) | Yes | Net Amount. Before Round Cent Adjustment |
| DocumentCentBalance | form | NUMERIC(18,2) | Yes | Round Cent Adjustment Amount |
| DocumentFinalAmount | form | NUMERIC(18,2) | Yes | Final Amount. After Round Cent Adjustment |
| AcSupInvoiceMID | form | NVARCHAR(20) | Yes | Supplier Original Invoice Number (System) |
| DocumentReason | form | NVARCHAR(100) | Yes | Reason |
| RefDocumentNo | form | NVARCHAR(100) | 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 |
| EditDate | form | DATETIME | Yes | Edit Date |
| 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 |
|---|---|---|---|---|
| AcSupRefundNoteDID | form | NVARCHAR(40) | Yes | Record ID. Recommend use GUID |
| AcSupRefundNoteMID | form | NVARCHAR(20) | Yes | Refund Note Number |
| ItemNo | form | INT | Yes | Item Number |
| AcStockID | form | NVARCHAR(40) | Yes | Stock ID |
| AcStockUOMID | form | NVARCHAR(20) | Yes | Stock UOM ID |
| ItemUnitPrice | form | NUMERIC(18,4) | Yes | Item Unit Price |
| ItemQuantity | form | NUMERIC(18,4) | Yes | Item Quantity |
| ItemGrossTotal | form | NUMERIC(18,2) | Yes | Item Gross Total. [Item Unit Price] x [Item Quantity] |
| ItemDiscountAmount | form | NUMERIC(18,2) | Yes | Item Discount Amount |
| ItemTotalPrice | form | NUMERIC(18,2) | Yes | Item Total Price. [(Unit Price x Quantity) - Discount Amount] |
| ItemRemark1 | form | NVARCHAR(MAX) | Yes | Item Remark 1 |
| 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 |
|---|---|---|---|---|
| AcSupRefundNoteMID | form | NVARCHAR(20) | Yes | Refund Note 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 /SupplierRefundNotes/simple HTTP/1.1 Host: snr2u.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
RefundNotes:
[
{
DocumentHeader:
{
AcSupRefundNoteMID: String,
AcSupplierID: String,
AcLocationID: String,
DocumentDate: 0001-01-01,
AcTermID: String,
SupplierRefundNoteNumber: String,
DocumentNetAmount: 0,
DocumentCentBalance: 0,
DocumentFinalAmount: 0,
AcSupInvoiceMID: String,
DocumentReason: String,
RefDocumentNo: String,
DocumentRemark: String,
ExtraRemark1: String,
ExtraRemark2: String,
ExtraRemark3: String,
ExtraRemark4: String,
EditDate: 0001-01-01,
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:
[
{
AcSupRefundNoteDID: String,
AcSupRefundNoteMID: String,
ItemNo: 0,
AcStockID: String,
AcStockUOMID: String,
ItemUnitPrice: 0,
ItemQuantity: 0,
ItemGrossTotal: 0,
ItemDiscountAmount: 0,
ItemTotalPrice: 0,
ItemRemark1: String,
AcEInvoiceItemClassificationID: String,
AcEInvoiceItemTaxTypeID: String
}
],
DocumentPaymentDetails:
[
{
AcSupRefundNoteMID: 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
}
}
}