Required permission: | SupplierDebitNote-Transaction.GET |
GET | /SupplierDebitNotes/Currency/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
---|---|---|---|
GET | /SupplierDebitNotes/Currency/simple/DebitNote/{AcSupDebitNoteMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
GET | /SupplierDebitNotes/Currency/simple | ||
GET | /SupplierDebitNotes/Currency/simple/DebitNote/{fromDate}/{toDate} | Get a record by given a Document Date | Date format yyyy-MM-dd |
GET | /SupplierDebitNotes/Currency/simple/EditDate/{fromEditDate}/{toEditDate} | Get a record by given a Edit Date | Date format yyyy-MM-dd |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Page | path | int? | No | |
AcSupDebitNoteMID | path | string | No | |
fromDate | path | string | No | |
toDate | path | string | No | |
fromEditDate | path | string | No | |
toEditDate | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DebitNotes | form | List<SupplierDebitNoteSimple_Currency> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentHeader | form | AcSupDebitNoteMSimple_Currency | No | |
DocumentDetails | form | List<AcSupDebitNoteDSimple_Currency> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AcSupDebitNoteMID | form | NVARCHAR(20) | Yes | Debit Note Number |
AcSupplierID | form | NVARCHAR(20) | Yes | Supplier ID |
AcTermID | form | NVARCHAR(40) | No | Term ID |
AcLocationID | form | NVARCHAR(20) | Yes | Location ID |
SupplierInvoiceNumber | form | NVARCHAR(20) | Yes | Supplier Debit Note Number |
DocumentDate | form | DATE | Yes | Debit Note Date |
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 Invoice Number |
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 |
AcCurrencyID | form | string | Yes | Currency ID. Default to home currency (eg: MYR/SGD) |
CurrencyRate | form | decimal | Yes | Currency Rate. Default to 1 |
DocumentLocalItemTotalPrice | form | decimal | Yes | Total of detail.ItemTotalPrice |
DocumentLocalDiscountAmount | form | decimal | Yes | Document Discount Amount. Always 0 |
DocumentLocalNetAmount | form | decimal | Yes | Total of detail.ItemTotalPrice |
DocumentLocalCentBalance | form | decimal | Yes | Round Cent Adjustment Amount. |
DocumentLocalFinalAmount | form | decimal | Yes | Invoice Amount. Amount After Minus Round Cent |
DocumentItemLocalGSTAmount | form | decimal | Yes | GST Amount. Always 0 |
DocumentLocalItemGrossTotal | form | decimal | Yes | Total of detail.ItemGrossTotal |
DocumentLocalItemGrossTotalWithGST | form | decimal | Yes | Total of detail.ItemGrossTotal |
DocumentLocalItemGrossTotalWithoutGST | form | decimal | Yes | Total of detail.ItemGrossTotal |
DocumentLocalItemDiscountTotalWithGST | form | decimal | Yes | Total of detail.ItemDiscountAmount |
DocumentLocalItemDiscountTotalWithoutGST | form | decimal | Yes | Total of detail.ItemDiscountAmount |
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 |
---|---|---|---|---|
AcSupDebitNoteDID | form | NVARCHAR(40) | Yes | Record ID. Recommend use GUID |
AcSupDebitNoteMID | form | NVARCHAR(20) | Yes | Debit 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 |
ItemLocalGrossTotal | form | NUMERIC(18,2) | Yes | Item Gross Total in Local Currency. |
ItemLocalDiscountAmount | form | NUMERIC(18,2) | Yes | Item Discount Amount in Local Currency. |
ItemLocalTotalPrice | form | NUMERIC(18,2) | Yes | Item Total Amount in Local Currency. |
ItemLocalGrossTotalWithGST | form | NUMERIC(18,2) | Yes | Item Gross Total with Tax Inclusive in Local Currency |
ItemLocalGrossTotalWithoutGST | form | NUMERIC(18,2) | Yes | Item Gross Total without Tax Inclusive in Local Currency |
ItemLocalDiscountAmountWithGST | form | NUMERIC(18,2) | Yes | Item Discount Amount with Tax Inclusive in Local Currency |
ItemLocalDiscountAmountWithoutGST | form | NUMERIC(18,2) | Yes | Item Discount Amount without Tax Inclusive in Local Currency |
ItemLocalTotalPriceWithGST | form | NUMERIC(18,2) | Yes | Item Total Amount with Tax Inclusive in Local Currency |
ItemLocalTotalPriceWithoutGST | form | NUMERIC(18,2) | Yes | Item Total Amount without Tax Inclusive in Local Currency |
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) |
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 /SupplierDebitNotes/Currency/simple/page/{Page} HTTP/1.1 Host: snr2u.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SupplierDebitNotesSimple_Currency_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel"> <DebitNotes xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types"> <d2p1:SupplierDebitNoteSimple_Currency> <d2p1:DocumentDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.SupplierDebitNote"> <d4p1:AcSupDebitNoteDSimple_Currency> <d4p1:AcEInvoiceItemClassificationID>String</d4p1:AcEInvoiceItemClassificationID> <d4p1:AcEInvoiceItemTaxTypeID>String</d4p1:AcEInvoiceItemTaxTypeID> <d4p1:AcStockID>String</d4p1:AcStockID> <d4p1:AcStockUOMID>String</d4p1:AcStockUOMID> <d4p1:AcSupDebitNoteDID>String</d4p1:AcSupDebitNoteDID> <d4p1:AcSupDebitNoteMID>String</d4p1:AcSupDebitNoteMID> <d4p1:ItemDiscountAmount>0</d4p1:ItemDiscountAmount> <d4p1:ItemGrossTotal>0</d4p1:ItemGrossTotal> <d4p1:ItemLocalDiscountAmount>0</d4p1:ItemLocalDiscountAmount> <d4p1:ItemLocalDiscountAmountWithGST>0</d4p1:ItemLocalDiscountAmountWithGST> <d4p1:ItemLocalDiscountAmountWithoutGST>0</d4p1:ItemLocalDiscountAmountWithoutGST> <d4p1:ItemLocalGrossTotal>0</d4p1:ItemLocalGrossTotal> <d4p1:ItemLocalGrossTotalWithGST>0</d4p1:ItemLocalGrossTotalWithGST> <d4p1:ItemLocalGrossTotalWithoutGST>0</d4p1:ItemLocalGrossTotalWithoutGST> <d4p1:ItemLocalTotalPrice>0</d4p1:ItemLocalTotalPrice> <d4p1:ItemLocalTotalPriceWithGST>0</d4p1:ItemLocalTotalPriceWithGST> <d4p1:ItemLocalTotalPriceWithoutGST>0</d4p1:ItemLocalTotalPriceWithoutGST> <d4p1:ItemNo>0</d4p1:ItemNo> <d4p1:ItemQuantity>0</d4p1:ItemQuantity> <d4p1:ItemRemark1>String</d4p1:ItemRemark1> <d4p1:ItemTotalPrice>0</d4p1:ItemTotalPrice> <d4p1:ItemUnitPrice>0</d4p1:ItemUnitPrice> </d4p1:AcSupDebitNoteDSimple_Currency> </d2p1:DocumentDetails> <d2p1:DocumentHeader xmlns:d4p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.SupplierDebitNote"> <d4p1:AcCurrencyID>String</d4p1:AcCurrencyID> <d4p1:AcEInvoiceAddressCountryID_Supplier>String</d4p1:AcEInvoiceAddressCountryID_Supplier> <d4p1:AcEInvoiceAddressStateID_Supplier>String</d4p1:AcEInvoiceAddressStateID_Supplier> <d4p1:AcEInvoiceDocumentFlowID>String</d4p1:AcEInvoiceDocumentFlowID> <d4p1:AcEInvoiceDocumentStatusID>String</d4p1:AcEInvoiceDocumentStatusID> <d4p1:AcEInvoiceSupplierMSICID_Supplier>String</d4p1:AcEInvoiceSupplierMSICID_Supplier> <d4p1:AcLocationID>String</d4p1:AcLocationID> <d4p1:AcSupDebitNoteMID>String</d4p1:AcSupDebitNoteMID> <d4p1:AcSupInvoiceMID>String</d4p1:AcSupInvoiceMID> <d4p1:AcSupplierID>String</d4p1:AcSupplierID> <d4p1:AcTermID>String</d4p1:AcTermID> <d4p1:CurrencyRate>0</d4p1:CurrencyRate> <d4p1:DocumentCentBalance>0</d4p1:DocumentCentBalance> <d4p1:DocumentDate>0001-01-01T00:00:00</d4p1:DocumentDate> <d4p1:DocumentFinalAmount>0</d4p1:DocumentFinalAmount> <d4p1:DocumentItemLocalGSTAmount>0</d4p1:DocumentItemLocalGSTAmount> <d4p1:DocumentLocalCentBalance>0</d4p1:DocumentLocalCentBalance> <d4p1:DocumentLocalDiscountAmount>0</d4p1:DocumentLocalDiscountAmount> <d4p1:DocumentLocalFinalAmount>0</d4p1:DocumentLocalFinalAmount> <d4p1:DocumentLocalItemDiscountTotalWithGST>0</d4p1:DocumentLocalItemDiscountTotalWithGST> <d4p1:DocumentLocalItemDiscountTotalWithoutGST>0</d4p1:DocumentLocalItemDiscountTotalWithoutGST> <d4p1:DocumentLocalItemGrossTotal>0</d4p1:DocumentLocalItemGrossTotal> <d4p1:DocumentLocalItemGrossTotalWithGST>0</d4p1:DocumentLocalItemGrossTotalWithGST> <d4p1:DocumentLocalItemGrossTotalWithoutGST>0</d4p1:DocumentLocalItemGrossTotalWithoutGST> <d4p1:DocumentLocalItemTotalPrice>0</d4p1:DocumentLocalItemTotalPrice> <d4p1:DocumentLocalNetAmount>0</d4p1:DocumentLocalNetAmount> <d4p1:DocumentNetAmount>0</d4p1:DocumentNetAmount> <d4p1:DocumentReason>String</d4p1:DocumentReason> <d4p1:DocumentRemark>String</d4p1:DocumentRemark> <d4p1:EInvoiceAddressCityName_Supplier>String</d4p1:EInvoiceAddressCityName_Supplier> <d4p1:EInvoiceAddressLine0_Supplier>String</d4p1:EInvoiceAddressLine0_Supplier> <d4p1:EInvoiceAddressLine1_Supplier>String</d4p1:EInvoiceAddressLine1_Supplier> <d4p1:EInvoiceAddressLine2_Supplier>String</d4p1:EInvoiceAddressLine2_Supplier> <d4p1:EInvoiceAddressPostalZone_Supplier>String</d4p1:EInvoiceAddressPostalZone_Supplier> <d4p1:EInvoiceDocumentNumber_Consolidated>String</d4p1:EInvoiceDocumentNumber_Consolidated> <d4p1:EInvoiceRegBusinessActivityDescription_Supplier>String</d4p1:EInvoiceRegBusinessActivityDescription_Supplier> <d4p1:EInvoiceRegContactNumber_Supplier>String</d4p1:EInvoiceRegContactNumber_Supplier> <d4p1:EInvoiceRegEmail_Supplier>String</d4p1:EInvoiceRegEmail_Supplier> <d4p1:EInvoiceRegName_Supplier>String</d4p1:EInvoiceRegName_Supplier> <d4p1:EInvoiceRegNumber_Supplier>String</d4p1:EInvoiceRegNumber_Supplier> <d4p1:EInvoiceRegSSTNumber_Supplier>String</d4p1:EInvoiceRegSSTNumber_Supplier> <d4p1:EInvoiceRegTIN_Supplier>String</d4p1:EInvoiceRegTIN_Supplier> <d4p1:EInvoiceRegTourismTaxRegNumber_Supplier>String</d4p1:EInvoiceRegTourismTaxRegNumber_Supplier> <d4p1:EInvoiceSubmissionUUID>String</d4p1:EInvoiceSubmissionUUID> <d4p1:EInvoiceSupplierIsMalaysian>String</d4p1:EInvoiceSupplierIsMalaysian> <d4p1:EInvoiceSupplierRegType>String</d4p1:EInvoiceSupplierRegType> <d4p1:EInvoiceValidationDateTime>0001-01-01T00:00:00</d4p1:EInvoiceValidationDateTime> <d4p1:EInvoiceValidationLink>String</d4p1:EInvoiceValidationLink> <d4p1:EInvoiceValidationUUID>String</d4p1:EInvoiceValidationUUID> <d4p1:EditDate>0001-01-01T00:00:00</d4p1:EditDate> <d4p1:ExtraRemark1>String</d4p1:ExtraRemark1> <d4p1:ExtraRemark2>String</d4p1:ExtraRemark2> <d4p1:ExtraRemark3>String</d4p1:ExtraRemark3> <d4p1:ExtraRemark4>String</d4p1:ExtraRemark4> <d4p1:IsConsolidatedEInvoice>String</d4p1:IsConsolidatedEInvoice> <d4p1:IsEnableEInvoiceMYS>String</d4p1:IsEnableEInvoiceMYS> <d4p1:IsUseTransactionSupplierElement>false</d4p1:IsUseTransactionSupplierElement> <d4p1:RefDocumentNo>String</d4p1:RefDocumentNo> <d4p1:SupplierInvoiceNumber>String</d4p1:SupplierInvoiceNumber> </d2p1:DocumentHeader> </d2p1:SupplierDebitNoteSimple_Currency> </DebitNotes> <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> </SupplierDebitNotesSimple_Currency_Response>