| Required permission: | CustomerCashSale-Transaction.ADD |
| POST | /CustomerCashSales/simple | Create a record for Customer Cash Sales | DocumentNo is a primary key |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerCashSale | body | CustomerCashSaleSimple | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentHeader | form | DocumentHeader | Yes | Cash Sales Header - Primary Key: DocumentNo |
| DocumentDetails | form | DocumentDetails | Yes | Cash Sales Details - Primary Key: DocumentNo, ItemNo |
| DocumentPaymentDetails | form | DocumentPaymentDetails | Yes | Cash Sales Payment Details - Primary Key: DocumentNo, ItemNo |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentNo | form | NVARCHAR(20) | Yes | Cash Sales Number |
| AcCompanyID | form | NVARCHAR(20) | Yes | Company ID |
| AcLocationID | form | NVARCHAR(20) | Yes | Location ID |
| AcTerminalID | form | NVARCHAR(20) | Yes | Terminal ID. Eg: 01, 02, 03. |
| AcCustomerID | form | NVARCHAR(20) | Yes | Customer ID |
| AcSalesmanID | form | NVARCHAR(20) | Yes | Salesman ID |
| DocumentDate | form | DATE | Yes | Document Date |
| DocumentTime | form | DATETIME | Yes | Document Time |
| AcPersonalID | form | NVARCHAR(20) | Yes | Cashier ID |
| DocumentRemark | form | NVARCHAR(100) | No | Document Remark |
| AmountChange | form | NUMERIC(18,2) | Yes | Change of Amount |
| AmountCentBalance | form | NUMERIC(18,2) | Yes | Round Cent Adjustment Amount |
| AmountNet | form | NUMERIC(18,2) | Yes | Net Amount. Before Round Cent Adjustment |
| AmountFinal | form | NUMERIC(18,2) | Yes | Final Amount. After Round Cent Adjustment |
| 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 |
| EditDate | form | DATETIME | Yes | Edit Date |
| 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 |
|---|---|---|---|---|
| DocumentNo | form | NVARCHAR(20) | Yes | Cash Sales Number |
| ItemNo | form | INTEGER | Yes | Item Number |
| AcStockID | form | NVARCHAR(20) | No | Stock ID |
| AcStockUOMID | form | NVARCHAR(20) | No | Stock UOM ID |
| ItemUnitPrice | form | NUMERIC(18,4) | Yes | Item Unit Price. (Tax Exclusive, Data stored to column ItemPrice) |
| ItemQuantity | form | NUMERIC(18,4) | Yes | Item Quantity |
| ItemGrossTotal | form | NUMERIC(18,2) | Yes | Item Gross Total. [Item Unit Price] x [Item Quantity]. (Data stored to column ItemAmount) |
| ItemDiscountAmount | form | NUMERIC(18,2) | Yes | Item Discount Amount |
| ItemTotalPrice | form | NUMERIC(18,2) | Yes | Item Total Price. (Exclusive Tax) [(Unit Price x Quantity) - Discount Amount]. (Data stored to column ItemTotal) |
| ItemRemark1 | form | NVARCHAR(MAX) | No | Item Remark 1 aka Item Notes. (Data stored to column ItemNotes) |
| IsUsePurchaseAccount | form | NVARCHAR(1) | Yes | Use Purchase Account? Y/N. Default N. If Y, then stock's purchase account would be used instead. Applicable to Quantity less than zero only. |
| AcTaxID | form | NVARCHAR(20) | No | Tax ID. Only Available in Malaysia. |
| ItemIsGSTExclusive | form | NVARCHAR(1) | Yes | REQUEST DO NOT USE. Indicate Is GST Exclusive (Y/N) |
| ItemGSTPercent | form | NUMERIC(18,2) | Yes | REQUEST DO NOT USE. Item GST Percent |
| ItemPriceInput | form | NUMERIC(18,4) | No | REQUEST DO NOT USE. Item Price Input |
| ItemPriceWithGST | form | NUMERIC(18,6) | No | REQUEST DO NOT USE. Item Price with GST |
| ItemPriceWithoutGST | form | NUMERIC(18,6) | No | REQUEST DO NOT USE. Item Price without GST |
| ItemDiscountAmountWithGST | form | NUMERIC(18,6) | No | REQUEST DO NOT USE. Item Discount Amount with GST |
| ItemDiscountAmountWithoutGST | form | NUMERIC(18,6) | No | REQUEST DO NOT USE. Item Discount Amount without GST |
| ItemTotalWithGST | form | NUMERIC(18,6) | Yes | REQUEST DO NOT USE. Item Total Amount with Tax [((Unit Price x Quantity) - Discount Amount) * Tax] (Data stored to column ItemTotalWithGST) |
| ItemGSTAmount | form | NUMERIC(18,6) | No | Item total Tax/GST Amount |
| ItemTotalWithoutGST | form | NUMERIC(18,6) | No | REQUEST DO NOT USE. Item Total Amount without GST |
| AccountNoGST | form | NVARCHAR(20) | No | Account No - GST. *Required if has AcTaxID |
| AcCSDSerialSimples | form | List | No | Item Serial Number List. |
| AcCSDMifareSimples | form | List | No | Item Mifare Transaction List. |
| 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 |
|---|---|---|---|---|
| AcCSDSerialID | form | NVARCHAR(40) | Yes | Primary Key |
| DocumentNo | form | NVARCHAR(20) | Yes | Cash Sales Number |
| ItemNo | form | INTEGER | Yes | Item Number (Referred to AcCSD.ItemNo) |
| AcStockID | form | NVARCHAR(20) | Yes | Stock ID |
| AcStockUOMID | form | NVARCHAR(20) | Yes | Stock UOM ID |
| StockSerialNumber | form | NVARCHAR(40) | Yes | Stock Serial Number |
| ItemQuantity | form | INT | Yes | Item Quantity. Always 1. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcCSDMifareID | form | BIGINT | Yes | Primary Key |
| DocumentNo | form | NVARCHAR(20) | Yes | Cash Sales Number |
| ItemNo | form | INTEGER | Yes | Item Number (Referred to AcCSD.ItemNo) |
| RecordID | form | BIGINT | Yes | Record ID |
| TrxType | form | NVARCHAR(10) | Yes | Transaction Type. Activate; Redeem; Refund; TopUp |
| AcMifareCardID | form | NVARCHAR(20) | Yes | MIFARE Card ID |
| MifareActivateDate | form | DATETIME | Yes | Activate Date |
| MifareActivateNoOfDay | form | INT | Yes | Activate Number of Days |
| MifareNoOfEntrance | form | INT | Yes | Number of Entrance |
| MifareOpenCredit | form | NUMERIC(18,2) | Yes | Open Credit Amount |
| MifareCredit | form | NUMERIC(18,2) | Yes | Credit Amount |
| MifareCreditBalance | form | NUMERIC(18,2) | Yes | Credit Balance Amount |
| CreateBy | form | NVARCHAR(20) | Yes | Create By |
| CreateDate | form | DATETIME | Yes | Create Date |
| EditBy | form | NVARCHAR(20) | Yes | Edit By |
| EditDate | form | DATETIME | Yes | Create Date |
| Stamp | form | INT | Yes | Record Stamp. Always 0 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentNo | form | NVARCHAR(20) | Yes | Cash Sales Number |
| ItemNo | form | INTEGER | Yes | Item Number |
| AcPaymentCode | form | NVARCHAR(20) | Yes | Payment Code |
| Amount | form | NUMERIC(18,2) | Yes | Payment Amount |
| CardNo | form | NVARCHAR(50) | No | Card Number. Credit Card Number |
| ApprovalCode | form | NVARCHAR(20) | No | Approval Code. Bank or E-Wallet Approval Code |
| BankName | form | NVARCHAR(100) | No | Bank Name |
| CardName | form | NVARCHAR(100) | No | Card Holder Name |
| EwalletPaymentType | form | NVARCHAR(50) | No | EWallet Payment Type |
| PaymentType | form | NVARCHAR(10) | No | Internal Verification Used. Leave it blank. CASH;CARD;OTHER (OTHER; VOUCHER; 88UNIFIED; BOOST; FASSPAY; INCARD; SARAWAKPAY; SHOPPE2GO; WECHATPAY) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerCashSale | form | CustomerCashSaleSimple | No | |
| ResponseStatus | form | ResponseStatus | No |
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.
POST /CustomerCashSales/simple HTTP/1.1
Host: snr2u.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CustomerCashSale:
{
DocumentHeader:
{
DocumentNo: String,
AcCompanyID: String,
AcLocationID: String,
AcTerminalID: String,
AcCustomerID: String,
AcSalesmanID: String,
DocumentDate: 0001-01-01,
DocumentTime: 0001-01-01,
AcPersonalID: String,
DocumentRemark: String,
AmountChange: 0,
AmountCentBalance: 0,
AmountNet: 0,
AmountFinal: 0,
ShipToRemark: String,
ShipToShipVia: String,
ShipToAddress1: String,
ShipToAddress2: String,
ShipToAddress3: String,
ShipToAddress4: String,
ShipToPhone1: String,
ShipToPhone2: String,
ShipToFax: String,
ShipToContact1: String,
ShipToContact2: String,
ShipToAttention: String,
EditDate: 0001-01-01,
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:
[
{
DocumentNo: String,
ItemNo: 0,
AcStockID: String,
AcStockUOMID: String,
ItemUnitPrice: 0,
ItemQuantity: 0,
ItemGrossTotal: 0,
ItemDiscountAmount: 0,
ItemTotalPrice: 0,
ItemRemark1: String,
IsUsePurchaseAccount: String,
AcTaxID: String,
ItemIsGSTExclusive: String,
ItemGSTPercent: 0,
ItemPriceInput: 0,
ItemPriceWithGST: 0,
ItemPriceWithoutGST: 0,
ItemDiscountAmountWithGST: 0,
ItemDiscountAmountWithoutGST: 0,
ItemTotalWithGST: 0,
ItemGSTAmount: 0,
ItemTotalWithoutGST: 0,
AccountNoGST: String,
AcCSDSerialSimples:
[
{
AcCSDSerialID: String,
DocumentNo: String,
ItemNo: 0,
AcStockID: String,
AcStockUOMID: String,
StockSerialNumber: String,
ItemQuantity: 0
}
],
AcCSDMifareSimples:
[
{
AcCSDMifareID: 0,
DocumentNo: String,
ItemNo: 0,
RecordID: 0,
TrxType: String,
AcMifareCardID: String,
MifareActivateDate: 0001-01-01,
MifareActivateNoOfDay: 0,
MifareNoOfEntrance: 0,
MifareOpenCredit: 0,
MifareCredit: 0,
MifareCreditBalance: 0,
CreateBy: String,
CreateDate: 0001-01-01,
EditBy: String,
EditDate: 0001-01-01,
Stamp: 0
}
],
AcEInvoiceItemClassificationID: String,
AcEInvoiceItemTaxTypeID: String
}
],
DocumentPaymentDetails:
[
{
DocumentNo: String,
ItemNo: String,
AcPaymentCode: String,
Amount: 0,
CardNo: String,
ApprovalCode: String,
BankName: String,
CardName: String,
EwalletPaymentType: String,
PaymentType: String
}
]
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CustomerCashSale:
{
DocumentHeader:
{
DocumentNo: String,
AcCompanyID: String,
AcLocationID: String,
AcTerminalID: String,
AcCustomerID: String,
AcSalesmanID: String,
DocumentDate: 0001-01-01,
DocumentTime: 0001-01-01,
AcPersonalID: String,
DocumentRemark: String,
AmountChange: 0,
AmountCentBalance: 0,
AmountNet: 0,
AmountFinal: 0,
ShipToRemark: String,
ShipToShipVia: String,
ShipToAddress1: String,
ShipToAddress2: String,
ShipToAddress3: String,
ShipToAddress4: String,
ShipToPhone1: String,
ShipToPhone2: String,
ShipToFax: String,
ShipToContact1: String,
ShipToContact2: String,
ShipToAttention: String,
EditDate: 0001-01-01,
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:
[
{
DocumentNo: String,
ItemNo: 0,
AcStockID: String,
AcStockUOMID: String,
ItemUnitPrice: 0,
ItemQuantity: 0,
ItemGrossTotal: 0,
ItemDiscountAmount: 0,
ItemTotalPrice: 0,
ItemRemark1: String,
IsUsePurchaseAccount: String,
AcTaxID: String,
ItemIsGSTExclusive: String,
ItemGSTPercent: 0,
ItemPriceInput: 0,
ItemPriceWithGST: 0,
ItemPriceWithoutGST: 0,
ItemDiscountAmountWithGST: 0,
ItemDiscountAmountWithoutGST: 0,
ItemTotalWithGST: 0,
ItemGSTAmount: 0,
ItemTotalWithoutGST: 0,
AccountNoGST: String,
AcCSDSerialSimples:
[
{
AcCSDSerialID: String,
DocumentNo: String,
ItemNo: 0,
AcStockID: String,
AcStockUOMID: String,
StockSerialNumber: String,
ItemQuantity: 0
}
],
AcCSDMifareSimples:
[
{
AcCSDMifareID: 0,
DocumentNo: String,
ItemNo: 0,
RecordID: 0,
TrxType: String,
AcMifareCardID: String,
MifareActivateDate: 0001-01-01,
MifareActivateNoOfDay: 0,
MifareNoOfEntrance: 0,
MifareOpenCredit: 0,
MifareCredit: 0,
MifareCreditBalance: 0,
CreateBy: String,
CreateDate: 0001-01-01,
EditBy: String,
EditDate: 0001-01-01,
Stamp: 0
}
],
AcEInvoiceItemClassificationID: String,
AcEInvoiceItemTaxTypeID: String
}
],
DocumentPaymentDetails:
[
{
DocumentNo: String,
ItemNo: String,
AcPaymentCode: String,
Amount: 0,
CardNo: String,
ApprovalCode: String,
BankName: String,
CardName: String,
EwalletPaymentType: String,
PaymentType: String
}
]
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}