| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomerCreditNotesSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
<CreditNotes xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
<d2p1:CustomerCreditNoteSimple>
<d2p1:DocumentDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.CustomerCreditNote">
<d4p1:AcCusCreditNoteDSimple>
<d4p1:AcCusCreditNoteMID>String</d4p1:AcCusCreditNoteMID>
<d4p1:AcEInvoiceItemClassificationID>String</d4p1:AcEInvoiceItemClassificationID>
<d4p1:AcEInvoiceItemTaxTypeID>String</d4p1:AcEInvoiceItemTaxTypeID>
<d4p1:AcStockID>String</d4p1:AcStockID>
<d4p1:AcStockUOMID>String</d4p1:AcStockUOMID>
<d4p1:ItemDiscountAmount>0</d4p1:ItemDiscountAmount>
<d4p1:ItemGrossTotal>0</d4p1:ItemGrossTotal>
<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:MatchDocumentNo>String</d4p1:MatchDocumentNo>
<d4p1:MatchIsActive>String</d4p1:MatchIsActive>
<d4p1:MatchItemNo>0</d4p1:MatchItemNo>
<d4p1:MatchType>String</d4p1:MatchType>
</d4p1:AcCusCreditNoteDSimple>
</d2p1:DocumentDetails>
<d2p1:DocumentHeader xmlns:d4p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.CustomerCreditNote">
<d4p1:AcCusCreditNoteMID>String</d4p1:AcCusCreditNoteMID>
<d4p1:AcCustomerID>String</d4p1:AcCustomerID>
<d4p1:AcEInvoiceAddressCountryID_Buyer>String</d4p1:AcEInvoiceAddressCountryID_Buyer>
<d4p1:AcEInvoiceAddressStateID_Buyer>String</d4p1:AcEInvoiceAddressStateID_Buyer>
<d4p1:AcEInvoiceDocumentFlowID>String</d4p1:AcEInvoiceDocumentFlowID>
<d4p1:AcEInvoiceDocumentStatusID>String</d4p1:AcEInvoiceDocumentStatusID>
<d4p1:AcLocationID>String</d4p1:AcLocationID>
<d4p1:AcSalesmanID>String</d4p1:AcSalesmanID>
<d4p1:DocumentCentBalance>0</d4p1:DocumentCentBalance>
<d4p1:DocumentDate>0001-01-01T00:00:00</d4p1:DocumentDate>
<d4p1:DocumentFinalAmount>0</d4p1:DocumentFinalAmount>
<d4p1:DocumentItemCurrencyAppliedAmount>0</d4p1:DocumentItemCurrencyAppliedAmount>
<d4p1:DocumentNetAmount>0</d4p1:DocumentNetAmount>
<d4p1:DocumentRemark>String</d4p1:DocumentRemark>
<d4p1:DocumentUnappliedCurrencyAmount>0</d4p1:DocumentUnappliedCurrencyAmount>
<d4p1:DocumentYourReference>String</d4p1:DocumentYourReference>
<d4p1:EInvoiceAddressCityName_Buyer>String</d4p1:EInvoiceAddressCityName_Buyer>
<d4p1:EInvoiceAddressLine0_Buyer>String</d4p1:EInvoiceAddressLine0_Buyer>
<d4p1:EInvoiceAddressLine1_Buyer>String</d4p1:EInvoiceAddressLine1_Buyer>
<d4p1:EInvoiceAddressLine2_Buyer>String</d4p1:EInvoiceAddressLine2_Buyer>
<d4p1:EInvoiceAddressPostalZone_Buyer>String</d4p1:EInvoiceAddressPostalZone_Buyer>
<d4p1:EInvoiceBuyerIsMalaysian>String</d4p1:EInvoiceBuyerIsMalaysian>
<d4p1:EInvoiceBuyerRegType>String</d4p1:EInvoiceBuyerRegType>
<d4p1:EInvoiceDocumentNumber_Consolidated>String</d4p1:EInvoiceDocumentNumber_Consolidated>
<d4p1:EInvoiceRegContactNumber_Buyer>String</d4p1:EInvoiceRegContactNumber_Buyer>
<d4p1:EInvoiceRegEmail_Buyer>String</d4p1:EInvoiceRegEmail_Buyer>
<d4p1:EInvoiceRegName_Buyer>String</d4p1:EInvoiceRegName_Buyer>
<d4p1:EInvoiceRegNumber_Buyer>String</d4p1:EInvoiceRegNumber_Buyer>
<d4p1:EInvoiceRegSSTNumber_Buyer>String</d4p1:EInvoiceRegSSTNumber_Buyer>
<d4p1:EInvoiceRegTIN_Buyer>String</d4p1:EInvoiceRegTIN_Buyer>
<d4p1:EInvoiceSubmissionUUID>String</d4p1:EInvoiceSubmissionUUID>
<d4p1:EInvoiceValidationDateTime>0001-01-01T00:00:00</d4p1:EInvoiceValidationDateTime>
<d4p1:EInvoiceValidationLink>String</d4p1:EInvoiceValidationLink>
<d4p1:EInvoiceValidationUUID>String</d4p1:EInvoiceValidationUUID>
<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:IsUseTransactionBuyerElement>false</d4p1:IsUseTransactionBuyerElement>
<d4p1:RefDocumentNo>String</d4p1:RefDocumentNo>
<d4p1:ShipToAddress1>String</d4p1:ShipToAddress1>
<d4p1:ShipToAddress2>String</d4p1:ShipToAddress2>
<d4p1:ShipToAddress3>String</d4p1:ShipToAddress3>
<d4p1:ShipToAddress4>String</d4p1:ShipToAddress4>
<d4p1:ShipToAttention>String</d4p1:ShipToAttention>
<d4p1:ShipToContact1>String</d4p1:ShipToContact1>
<d4p1:ShipToContact2>String</d4p1:ShipToContact2>
<d4p1:ShipToFax>String</d4p1:ShipToFax>
<d4p1:ShipToPhone1>String</d4p1:ShipToPhone1>
<d4p1:ShipToPhone2>String</d4p1:ShipToPhone2>
<d4p1:ShipToRemark>String</d4p1:ShipToRemark>
<d4p1:ShipToShipVia>String</d4p1:ShipToShipVia>
</d2p1:DocumentHeader>
<d2p1:DocumentKnockOffDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.CustomerCreditNote">
<d4p1:AcCusCreditNoteAsSimple>
<d4p1:AcCusCreditNoteMID>String</d4p1:AcCusCreditNoteMID>
<d4p1:ItemCurrencyAmount>0</d4p1:ItemCurrencyAmount>
<d4p1:ItemCurrencyAppliedAmount>0</d4p1:ItemCurrencyAppliedAmount>
<d4p1:ItemCurrencyBalanceAmount>0</d4p1:ItemCurrencyBalanceAmount>
<d4p1:ItemNo>0</d4p1:ItemNo>
<d4p1:ItemRemark1>String</d4p1:ItemRemark1>
<d4p1:MatchDocumentNo>String</d4p1:MatchDocumentNo>
<d4p1:MatchType>String</d4p1:MatchType>
</d4p1:AcCusCreditNoteAsSimple>
</d2p1:DocumentKnockOffDetails>
</d2p1:CustomerCreditNoteSimple>
</CreditNotes>
<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>
</CustomerCreditNotesSimpleResponse>