| Required permission: | CustomerCreditNote-Transaction.GET |
| GET | /CustomerCreditNotes/simple | ||
|---|---|---|---|
| GET | /CustomerCreditNotes/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
| GET | /CustomerCreditNotes/simple/CreditNote/{AcCusCreditNoteMID} | 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 | |
| AcCusCreditNoteMID | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CreditNotes | form | List<CustomerCreditNoteSimple> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentHeader | form | DocumentHeader | Yes | Customer Credit Note Header - Primary Key: AcCusCreditNoteMID |
| DocumentDetails | form | DocumentDetails | Yes | Customer Credit Note Details - Primary Key: AcCusCreditNoteMID, ItemNo |
| DocumentKnockOffDetails | form | DocumentKnockOffDetails | Yes | Customer Credit Note Knock-Off Details - Primary Key: AcCusCreditNoteMID, MatchType, MatchDocumentNo. Note: You may get the outstanding list from CustomerOutstandingDocumentListing service. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcCusCreditNoteMID | form | NVARCHAR(20) | Yes | Credit Note Number |
| AcCustomerID | form | NVARCHAR(20) | Yes | Customer ID |
| AcSalesmanID | form | NVARCHAR(20) | No | Salesman ID. Default to customer's salesman if not specified |
| 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 |
| DocumentYourReference | form | NVARCHAR(50) | No | Your Reference |
| ShipToRemark | form | NVARCHAR(100) | No | Ship To: Remark |
| ShipToShipVia | form | NVARCHAR(20) | No | Ship To: Ship Via |
| ShipToAddress1 | form | NVARCHAR(MAX) | No | Ship To: Address 1 |
| ShipToAddress2 | form | NVARCHAR(100) | No | Ship To: Address 2 |
| ShipToAddress3 | form | NVARCHAR(100) | No | Ship To: Address 3 |
| ShipToAddress4 | form | NVARCHAR(100) | No | Ship To: Address 4 |
| ShipToPhone1 | form | NVARCHAR(100) | No | Ship To: Phone 1 |
| ShipToPhone2 | form | NVARCHAR(100) | No | Ship To: Phone 1 |
| ShipToFax | form | NVARCHAR(100) | No | Ship To: Fax |
| ShipToContact1 | form | NVARCHAR(100) | No | Ship To: Contact 1 |
| ShipToContact2 | form | NVARCHAR(100) | No | Ship To: Contact 2 |
| ShipToAttention | form | NVARCHAR(100) | No | Ship To: Attention |
| IsUseTransactionBuyerElement | form | NVARCHAR(100) | No | Use Transaction's Buyer Element?. True: Buyer Elements will stored based on provided value; False: Buyer Elements will stored based on Customer Profile's E-Invoice Elements |
| AcEInvoiceDocumentFlowID | form | NVARCHAR(100) | No | E-Invoice Document Flow ID. Open; Ready to Submit; Not Applicable |
| EInvoiceRegName_Buyer | form | NVARCHAR(300) | No | E-Invoice Registration Name Buyer |
| EInvoiceRegTIN_Buyer | form | NVARCHAR(40) | No | E-Invoice Registration TIN Buyer |
| EInvoiceRegNumber_Buyer | form | NVARCHAR(40) | No | E-Invoice Registration Number Buyer |
| EInvoiceBuyerIsMalaysian | form | NVARCHAR(1) | Yes | E-Invoice Buyer Is Malaysian. Y/N |
| EInvoiceBuyerRegType | form | NVARCHAR(20) | No | E-Invoice Buyer Registration Type. NRIC/BRN/PASSPORT/ARMY |
| EInvoiceRegSSTNumber_Buyer | form | NVARCHAR(40) | No | E-Invoice Registration SST Number Buyer |
| EInvoiceRegEmail_Buyer | form | NVARCHAR(320) | No | E-Invoice Registration Email Buyer |
| EInvoiceAddressLine0_Buyer | form | NVARCHAR(150) | No | E-Invoice Address Line 0 Buyer |
| EInvoiceAddressLine1_Buyer | form | NVARCHAR(150) | No | E-Invoice Address Line 1 Buyer |
| EInvoiceAddressLine2_Buyer | form | NVARCHAR(150) | No | E-Invoice Address Line 2 Buyer |
| EInvoiceAddressPostalZone_Buyer | form | NVARCHAR(50) | No | E-Invoice Address Postal Zone Buyer |
| EInvoiceAddressCityName_Buyer | form | NVARCHAR(50) | No | E-Invoice Address City Name Buyer |
| AcEInvoiceAddressStateID_Buyer | form | NVARCHAR(20) | No | E-Invoice Address State ID Buyer. 00 to 17 |
| AcEInvoiceAddressCountryID_Buyer | form | NVARCHAR(20) | No | E-Invoice Address Country ID Buyer. MYS |
| EInvoiceRegContactNumber_Buyer | form | NVARCHAR(20) | No | E-Invoice Registration Contact Number Buyer |
| 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 |
|---|---|---|---|---|
| AcCusCreditNoteMID | 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: Customer Invoice |
| MatchDocumentNo | form | NVARCHAR(20) | No | Match Document Number. |
| MatchItemNo | form | INT | Yes | Match Document Item Number. |
| 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 |
|---|---|---|---|---|
| AcCusCreditNoteMID | 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 |
| 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /CustomerCreditNotes/simple HTTP/1.1 Host: snr2u.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CreditNotes:
[
{
DocumentHeader:
{
AcCusCreditNoteMID: String,
AcCustomerID: String,
AcSalesmanID: String,
AcLocationID: String,
DocumentDate: 0001-01-01,
DocumentNetAmount: 0,
DocumentCentBalance: 0,
DocumentFinalAmount: 0,
DocumentItemCurrencyAppliedAmount: 0,
DocumentUnappliedCurrencyAmount: 0,
RefDocumentNo: String,
DocumentRemark: String,
ExtraRemark1: String,
ExtraRemark2: String,
ExtraRemark3: String,
ExtraRemark4: String,
DocumentYourReference: String,
ShipToRemark: String,
ShipToShipVia: String,
ShipToAddress1: String,
ShipToAddress2: String,
ShipToAddress3: String,
ShipToAddress4: String,
ShipToPhone1: String,
ShipToPhone2: String,
ShipToFax: String,
ShipToContact1: String,
ShipToContact2: String,
ShipToAttention: String,
IsUseTransactionBuyerElement: False,
AcEInvoiceDocumentFlowID: String,
EInvoiceRegName_Buyer: String,
EInvoiceRegTIN_Buyer: String,
EInvoiceRegNumber_Buyer: String,
EInvoiceBuyerIsMalaysian: String,
EInvoiceBuyerRegType: String,
EInvoiceRegSSTNumber_Buyer: String,
EInvoiceRegEmail_Buyer: String,
EInvoiceAddressLine0_Buyer: String,
EInvoiceAddressLine1_Buyer: String,
EInvoiceAddressLine2_Buyer: String,
EInvoiceAddressPostalZone_Buyer: String,
EInvoiceAddressCityName_Buyer: String,
AcEInvoiceAddressStateID_Buyer: String,
AcEInvoiceAddressCountryID_Buyer: String,
EInvoiceRegContactNumber_Buyer: String,
IsEnableEInvoiceMYS: String,
AcEInvoiceDocumentStatusID: String,
IsConsolidatedEInvoice: String,
EInvoiceDocumentNumber_Consolidated: String,
EInvoiceSubmissionUUID: String,
EInvoiceValidationUUID: String,
EInvoiceValidationDateTime: 0001-01-01,
EInvoiceValidationLink: String
},
DocumentDetails:
[
{
AcCusCreditNoteMID: 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,
AcEInvoiceItemClassificationID: String,
AcEInvoiceItemTaxTypeID: String
}
],
DocumentKnockOffDetails:
[
{
AcCusCreditNoteMID: String,
ItemNo: 0,
MatchType: String,
MatchDocumentNo: String,
ItemRemark1: String,
ItemCurrencyAmount: 0,
ItemCurrencyAppliedAmount: 0,
ItemCurrencyBalanceAmount: 0
}
]
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}