POST QuickTicket/PostQuickTicket
Request Information
URI Parameters
Body Parameters
ClsQuickTicketAdd| Name | Description | Type | Additional Information |
|---|---|---|---|
| PosDate |
The Pos Date for the Quick Ticket |
string |
Data type: DateTime Format must be MM/dd/yyyy |
| POSDueDate |
The due date for the Quick Ticket POS |
string |
Data type: DateTime Format must be MM/dd/yyyy |
| Location |
The location the Quick Ticket is created from |
string |
Required Max length: 6 |
| POSType |
The type of POS used for the Quick Ticket |
string |
Max length: 20 |
| CustId |
The customer ID for the Quick Ticket |
string |
Required Max length: 6 |
| Comments |
Comments for the Quick Ticket |
string |
Max length: 80 |
| SubTotal |
The sub total for the Quick Ticket |
decimal number |
Max of 2 decimal places Must be numeric |
| AmountDue |
The amount due for the Quick Ticket |
decimal number |
Max of 2 decimal places |
| AmountTendered |
The amount tendered for the QuickTicket |
decimal number |
Max of 2 decimal places |
| ChargeAmount |
The charge amount for the Quick Ticket |
decimal number |
Max of 2 decimal places |
| Change |
The change for the Quick Ticket |
decimal number |
Max of 2 decimal places Must be numeric |
| IsCompCredit |
True/False whether the ticket is marked as company credit. |
boolean |
Must be 0, 1, True, or False |
| FiscalMonth |
The fiscal month of the transaction for the Quick Ticket |
integer |
Required Must be numeric |
| DiscountableTax |
The discountable tax for the Quick Ticket |
decimal number |
Max of 2 decimal places Must be numeric |
| SalesmenId |
The salesperson getting credit for this sale |
string |
Max length: 15 |
| PayAmt1 |
The payment amount for the first payment method of the Quick Ticket |
decimal number |
Max of 2 decimal places |
| PayMethod1 |
The paymethod for the Quick Ticket, if a Paymethod is given a PaymentAmount a PaymentType (Paymethod) must also be provided |
string |
Required Max length: 20 Must be one of these values: Cash,Check,Credit Card,Charge |
| PayRef1 |
PayRef1 is saved as check credit number in the DB |
string |
Max length: 20 |
| PayMethod2 |
The second pay method for the Quick Ticket |
string |
Max length: 20 Must be one of these values: Cash,Check,Credit Card,Charge, |
| PayAmt2 |
The amount to be paid by the second payment method for the Quick Ticket |
decimal number |
Max of 2 decimal places Must be numeric |
| PayRef2 |
The reference for the second payment method |
string |
Max length: 20 |
| PayMethod3 |
The third pay method for the Quick Ticket |
string |
Max length: 20 Must be one of these values: Cash,Check,Credit Card,Charge, |
| PayAmt3 |
The amount to be paid by the third payment method for the Quick Ticket |
decimal number |
Max of 2 decimal places Must be numeric |
| PayRef3 |
The reference for the third payment type |
string |
Max length: 20 |
| CustPO |
The customer provided Purchase Order Number for this QuickTicket |
string |
Max length: 20 |
| AuthAgent |
The authorized agent for the customer's account |
string |
Max length: 50 |
| AARelatedHow |
The authorized agent's relationship |
string |
Max length: 20 |
| AAAddr1 |
The authorized agent's address |
string |
Max length: 50 |
| AAAddr2 |
The authorized agent's address 2 |
string |
Max length: 50 |
| AACity |
The authorized agent's city |
string |
Max length: 50 |
| AAState |
The authorized agent's state |
string |
Max length: 2 |
| AAZip |
The zipcode of the authorized agent |
string |
Max length: 10 |
| CashierId |
The ID of the cashier |
string |
Max length: 15 |
| LineItems |
The products associated with the Quick Ticket |
Collection of LineItem |
Request Formats
application/json, text/json
{
"PosDate": "sample string 6",
"POSDueDate": "sample string 7",
"Location": "sample string 9",
"POSType": "sample string 10",
"CustId": "sample string 11",
"Comments": "sample string 12",
"SubTotal": 13.1,
"AmountDue": 17.1,
"AmountTendered": 18.1,
"ChargeAmount": 19.1,
"Change": 20.1,
"IsCompCredit": true,
"FiscalMonth": 27,
"DiscountableTax": 28.1,
"SalesmenId": "sample string 31",
"PayAmt1": 32.1,
"PayMethod1": "sample string 33",
"PayRef1": "sample string 34",
"PayMethod2": "sample string 35",
"PayAmt2": 36.1,
"PayRef2": "sample string 37",
"PayMethod3": "sample string 38",
"PayAmt3": 39.1,
"PayRef3": "sample string 40",
"CustPO": "sample string 41",
"AuthAgent": "sample string 42",
"AARelatedHow": "sample string 43",
"AAAddr1": "sample string 44",
"AAAddr2": "sample string 45",
"AACity": "sample string 46",
"AAState": "sample string 47",
"AAZip": "sample string 48",
"CashierId": "sample string 49",
"LineItems": [
{
"DeptID": "sample string 2",
"ProdID": "sample string 3",
"LotNumber": "sample string 6",
"Quantity": 7.1,
"TaxExemptCode": "sample string 10",
"UnitPrice": 11.1,
"TaxYN": true,
"Total": 14.1,
"DiscountDollars": 16.1,
"StateTaxCode": "sample string 17",
"AdjTaxCode": "sample string 18",
"TaxRate": 19.1,
"Taxamount": 20.1,
"ShipFromLocation": "sample string 22",
"IsSurchargeProduct": true
},
{
"DeptID": "sample string 2",
"ProdID": "sample string 3",
"LotNumber": "sample string 6",
"Quantity": 7.1,
"TaxExemptCode": "sample string 10",
"UnitPrice": 11.1,
"TaxYN": true,
"Total": 14.1,
"DiscountDollars": 16.1,
"StateTaxCode": "sample string 17",
"AdjTaxCode": "sample string 18",
"TaxRate": 19.1,
"Taxamount": 20.1,
"ShipFromLocation": "sample string 22",
"IsSurchargeProduct": true
}
]
}
application/xml, text/xml
<ClsPostRN.ClsQuickTicketAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.AR">
<AAAddr1>sample string 44</AAAddr1>
<AAAddr2>sample string 45</AAAddr2>
<AACity>sample string 46</AACity>
<AARelatedHow>sample string 43</AARelatedHow>
<AAState>sample string 47</AAState>
<AAZip>sample string 48</AAZip>
<AmountDue>17.1</AmountDue>
<AmountTendered>18.1</AmountTendered>
<AuthAgent>sample string 42</AuthAgent>
<CashierId>sample string 49</CashierId>
<Change>20.1</Change>
<ChargeAmount>19.1</ChargeAmount>
<Comments>sample string 12</Comments>
<CustId>sample string 11</CustId>
<CustPO>sample string 41</CustPO>
<DiscountableTax>28.1</DiscountableTax>
<FiscalMonth>27</FiscalMonth>
<IsCompCredit>true</IsCompCredit>
<LineItems>
<ClsPostRN.ClsQuickTicketAdd.LineItem>
<AdjTaxCode>sample string 18</AdjTaxCode>
<DeptID>sample string 2</DeptID>
<DiscountDollars>16.1</DiscountDollars>
<IsSurchargeProduct>true</IsSurchargeProduct>
<LotNumber>sample string 6</LotNumber>
<ProdID>sample string 3</ProdID>
<Quantity>7.1</Quantity>
<ShipFromLocation>sample string 22</ShipFromLocation>
<StateTaxCode>sample string 17</StateTaxCode>
<TaxExemptCode>sample string 10</TaxExemptCode>
<TaxRate>19.1</TaxRate>
<TaxYN>true</TaxYN>
<Taxamount>20.1</Taxamount>
<Total>14.1</Total>
<UnitPrice>11.1</UnitPrice>
</ClsPostRN.ClsQuickTicketAdd.LineItem>
<ClsPostRN.ClsQuickTicketAdd.LineItem>
<AdjTaxCode>sample string 18</AdjTaxCode>
<DeptID>sample string 2</DeptID>
<DiscountDollars>16.1</DiscountDollars>
<IsSurchargeProduct>true</IsSurchargeProduct>
<LotNumber>sample string 6</LotNumber>
<ProdID>sample string 3</ProdID>
<Quantity>7.1</Quantity>
<ShipFromLocation>sample string 22</ShipFromLocation>
<StateTaxCode>sample string 17</StateTaxCode>
<TaxExemptCode>sample string 10</TaxExemptCode>
<TaxRate>19.1</TaxRate>
<TaxYN>true</TaxYN>
<Taxamount>20.1</Taxamount>
<Total>14.1</Total>
<UnitPrice>11.1</UnitPrice>
</ClsPostRN.ClsQuickTicketAdd.LineItem>
</LineItems>
<Location>sample string 9</Location>
<POSDueDate>sample string 7</POSDueDate>
<POSType>sample string 10</POSType>
<PayAmt1>32.1</PayAmt1>
<PayAmt2>36.1</PayAmt2>
<PayAmt3>39.1</PayAmt3>
<PayMethod1>sample string 33</PayMethod1>
<PayMethod2>sample string 35</PayMethod2>
<PayMethod3>sample string 38</PayMethod3>
<PayRef1>sample string 34</PayRef1>
<PayRef2>sample string 37</PayRef2>
<PayRef3>sample string 40</PayRef3>
<PosDate>sample string 6</PosDate>
<SalesmenId>sample string 31</SalesmenId>
<SubTotal>13.1</SubTotal>
</ClsPostRN.ClsQuickTicketAdd>
application/x-www-form-urlencoded
Response Information
Resource Description
AgvQuickTicket| Name | Description | Type | Additional Information |
|---|---|---|---|
| Status |
0 = Success; 1 = An error occurred; 2 = An error occurred; 3 = Descriptive message; process was successful |
string | |
| Message |
Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know |
string | |
| ErrorList |
List of error messages of the API call. |
Collection of string | |
| WarningList |
List of warning messages of the API call. |
Collection of string | |
| QuickTicket |
Creates a new Quick Ticket. |
ClsApiResponse |
Response Formats
application/json, text/json
{
"Status": "sample string 1",
"Message": "sample string 2",
"ErrorList": [
"sample string 1",
"sample string 2"
],
"WarningList": [
"sample string 1",
"sample string 2"
],
"QuickTicket": {
"SavedTransactionKeys": {
"TransactionGuid": "86567d7d-21d3-4490-9e38-5e5a018a1677",
"UniqueId": 1,
"KeyNumber": 1,
"KeyLocation": "sample string 1",
"KeyDate": "2026-02-27T04:46:59.0448469+00:00",
"KeyDateAsString": "sample string 2",
"Key1": "sample string 3",
"Key2": "sample string 4",
"Key3": "sample string 5",
"Key4": "sample string 6"
},
"ErrorList": [
"sample string 1",
"sample string 2"
],
"WarningList": [
"sample string 1",
"sample string 2"
],
"Success": false,
"Message": "See ErrorList property.",
"RawMessage": "sample string 1"
}
}
application/xml, text/xml
<AgvQuickTicket xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.QuickTicket">
<ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ErrorList>
<Message>sample string 2</Message>
<QuickTicket xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.API">
<d2p1:ErrorList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</d2p1:ErrorList>
<d2p1:Message>See ErrorList property.</d2p1:Message>
<d2p1:SavedTransactionKeys>
<d2p1:Key1>sample string 3</d2p1:Key1>
<d2p1:Key2>sample string 4</d2p1:Key2>
<d2p1:Key3>sample string 5</d2p1:Key3>
<d2p1:Key4>sample string 6</d2p1:Key4>
<d2p1:KeyDate>2026-02-27T04:46:59.0448469+00:00</d2p1:KeyDate>
<d2p1:KeyDateAsString>sample string 2</d2p1:KeyDateAsString>
<d2p1:KeyLocation>sample string 1</d2p1:KeyLocation>
<d2p1:KeyNumber>1</d2p1:KeyNumber>
<d2p1:TransactionGuid>86567d7d-21d3-4490-9e38-5e5a018a1677</d2p1:TransactionGuid>
<d2p1:UniqueId>1</d2p1:UniqueId>
</d2p1:SavedTransactionKeys>
<d2p1:WarningList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</d2p1:WarningList>
</QuickTicket>
<Status>sample string 1</Status>
<WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</WarningList>
</AgvQuickTicket>