| Required permission: | SupplierCreditNote-Transaction.ADD |
| POST | /SupplierCreditNotes//Currency/simple | Create a record for Supplier Credit Note | AcSupCreditNoteMID is a primary key |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SupplierCreditNote | body | SupplierCreditNoteSimple_Currency | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentHeader | form | DocumentHeader | Yes | Supplier Credit Note Header - Primary Key: AcSupCreditNoteMID |
| DocumentDetails | form | DocumentDetails | Yes | Supplier Credit Note Details - Primary Key: AcSupCreditNoteMID, ItemNo |
| DocumentKnockOffDetails | form | DocumentKnockOffDetails | Yes | Supplier Credit Note Knock-Off Details - Primary Key: AcSupCreditNoteMID, MatchType, MatchDocumentNo. Note: You may get the outstanding list from SupplierOutstandingDocumentListing service. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcSupCreditNoteMID | form | NVARCHAR(20) | Yes | Credit Note Number |
| SupplierCreditNoteNumber | form | NVARCHAR(20) | Yes | Supplier Credit Note Number |
| AcSupplierID | form | NVARCHAR(20) | Yes | Supplier ID |
| AcLocationID | form | NVARCHAR(20) | Yes | Location ID |
| DocumentDate | form | DATE | Yes | Credit 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 |
| DocumentItemCurrencyAppliedAmount | form | NUMERIC(18,2) | Yes | Total Applied Amount. Total knock-off amount that applied to outstanding invoices. |
| DocumentUnappliedCurrencyAmount | form | NUMERIC(18,2) | Yes | Total Unapplied Amount. It would be Advanced Amount. Balance amount after knock-off amount to outstanding invoice amount. |
| 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 | NVARCHAR(20) | Yes | Currency ID. Default to MYR |
| CurrencyRate | form | NUMERIC(18,6) | Yes | Currency Rate. Default to 1 |
| DocumentLocalItemTotalPrice | form | NUMERIC(18,2) | Yes | Total of detail.ItemTotalPrice |
| DocumentLocalDiscountAmount | form | NUMERIC(18,2) | Yes | Document Discount Amount. Always 0 |
| DocumentLocalNetAmount | form | NUMERIC(18,2) | Yes | Total of detail.ItemTotalPrice |
| DocumentLocalCentBalance | form | NUMERIC(18,2) | Yes | Round Cent Adjustment Amount. |
| DocumentLocalFinalAmount | form | NUMERIC(18,2) | Yes | Invoice Amount. Amount After Minus Round Cent |
| DocumentItemLocalGSTAmount | form | NUMERIC(18,2) | Yes | GST Amount. Always 0 |
| DocumentLocalItemGrossTotal | form | NUMERIC(18,2) | Yes | Total of detail.ItemGrossTotal |
| DocumentLocalItemGrossTotalWithGST | form | NUMERIC(18,2) | Yes | Total of detail.ItemGrossTotal |
| DocumentLocalItemGrossTotalWithoutGST | form | NUMERIC(18,2) | Yes | Total of detail.ItemGrossTotal |
| DocumentLocalItemDiscountTotalWithGST | form | NUMERIC(18,2) | Yes | Total of detail.ItemDiscountAmount |
| DocumentLocalItemDiscountTotalWithoutGST | form | NUMERIC(18,2) | 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 |
|---|---|---|---|---|
| AcSupCreditNoteMID | form | NVARCHAR(20) | Yes | Credit Note Number |
| ItemNo | form | INT | Yes | Item Number |
| AcStockID | form | NVARCHAR(20) | 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 |
| MatchIsActive | form | NVARCHAR(1) | Yes | Match Is Active. (Y/N). Default to N. If Y, please provide MatchType;MatchDocumentNo;MatchItemNo |
| MatchType | form | NVARCHAR(20) | No | Match Document Type. Valid Value: Supplier Invoice |
| MatchDocumentNo | form | NVARCHAR(20) | No | Match Document Number. |
| MatchItemNo | form | INT | Yes | Match Document Item Number. |
| 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) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcSupCreditNoteMID | form | NVARCHAR(20) | Yes | Credit Note Number |
| ItemNo | form | INT | Yes | Item Number |
| MatchType | form | NVARCHAR(20) | Yes | Match Document Type |
| MatchDocumentNo | form | NVARCHAR(20) | Yes | Match Document Number |
| MatchReferenceNumber | form | NVARCHAR(40) | Yes | Match Reference Number |
| ItemRemark1 | form | NVARCHAR(MAX) | Yes | Item Remark 1. Match Document Remark |
| ItemCurrencyAmount | form | NUMERIC(18,2) | Yes | Item Currency Amount. Current outstanding amount. |
| ItemCurrencyAppliedAmount | form | NUMERIC(18,2) | Yes | Item Currency Applied Amount. Amount used to knock-off the oustanding amount. Applied amount should not greater than outstanding amount. |
| ItemCurrencyBalanceAmount | form | NUMERIC(18,2) | Yes | Item Currency Balance Amount. Balance amount after knock-off the outstanding amount. (ItemCurrencyBalanceAmount = ItemCurrencyAmount - ItemCurrencyAppliedAmount). Should not have negative balance. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /SupplierCreditNotes//Currency/simple HTTP/1.1
Host: snr2u.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"SupplierCreditNote":{"DocumentHeader":{"AcSupCreditNoteMID":"String","SupplierCreditNoteNumber":"String","AcSupplierID":"String","AcLocationID":"String","DocumentDate":"\/Date(-62135596800000-0000)\/","DocumentNetAmount":0,"DocumentCentBalance":0,"DocumentFinalAmount":0,"DocumentItemCurrencyAppliedAmount":0,"DocumentUnappliedCurrencyAmount":0,"RefDocumentNo":"String","DocumentRemark":"String","ExtraRemark1":"String","ExtraRemark2":"String","ExtraRemark3":"String","ExtraRemark4":"String","EditDate":"\/Date(-62135596800000-0000)\/","AcCurrencyID":"String","CurrencyRate":0,"DocumentLocalItemTotalPrice":0,"DocumentLocalDiscountAmount":0,"DocumentLocalNetAmount":0,"DocumentLocalCentBalance":0,"DocumentLocalFinalAmount":0,"DocumentItemLocalGSTAmount":0,"DocumentLocalItemGrossTotal":0,"DocumentLocalItemGrossTotalWithGST":0,"DocumentLocalItemGrossTotalWithoutGST":0,"DocumentLocalItemDiscountTotalWithGST":0,"DocumentLocalItemDiscountTotalWithoutGST":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":"\/Date(-62135596800000-0000)\/","EInvoiceValidationLink":"String"},"DocumentDetails":[{"AcSupCreditNoteMID":"String","ItemNo":0,"AcStockID":"String","AcStockUOMID":"String","ItemUnitPrice":0,"ItemQuantity":0,"ItemGrossTotal":0,"ItemDiscountAmount":0,"ItemTotalPrice":0,"ItemRemark1":"String","MatchIsActive":"String","MatchType":"String","MatchDocumentNo":"String","MatchItemNo":0,"ItemLocalGrossTotal":0,"ItemLocalDiscountAmount":0,"ItemLocalTotalPrice":0,"ItemLocalGrossTotalWithGST":0,"ItemLocalGrossTotalWithoutGST":0,"ItemLocalDiscountAmountWithGST":0,"ItemLocalDiscountAmountWithoutGST":0,"ItemLocalTotalPriceWithGST":0,"ItemLocalTotalPriceWithoutGST":0,"AcEInvoiceItemClassificationID":"String","AcEInvoiceItemTaxTypeID":"String"}],"DocumentKnockOffDetails":[{"AcSupCreditNoteMID":"String","ItemNo":0,"MatchType":"String","MatchDocumentNo":"String","MatchReferenceNumber":"String","ItemRemark1":"String","ItemCurrencyAmount":0,"ItemCurrencyAppliedAmount":0,"ItemCurrencyBalanceAmount":0}]}}