POST KwiktagReservation/CreateKwiktagReservation

Creates a Kwiktag reservation.

Request Information

URI Parameters

Body Parameters

The Kwiktag request object used to create the transaction.

Name	Description	Type	Additional Information
DrawerType	The type of Kwiktag reservation to make the request for	KwikTagDrawerType	Required
PageCount	If provided is the number of pages for the reservation request	integer	Cannot be negative
Comment	A user defined comment to be saved with the reservation	string	Max length: 200
BarcodeToUse	When provided will be the barcode that is assigned to the reservation. If null or blank, will use the next available barcode for the user and return that in the response	string	Max length: 20
VendorId	The Agvance vendor id for the AP Bill or Purchase Receipt	string	Max length: 10
TransactionNumber	The Agvance transaction number for the reservation	string	Max length: 25
TransactionDate	The date of the Agvance transaction	date
TransactionAmount	Used with the AP Bill to indicate the gross amount for the document	decimal number	Cannot be negative Max of 2 decimal places

Request Formats

application/json, text/json

Sample:

{
  "DrawerType": 1,
  "PageCount": 1,
  "Comment": "sample string 1",
  "BarcodeToUse": "sample string 2",
  "VendorId": "sample string 3",
  "TransactionNumber": "sample string 4",
  "TransactionDate": "2025-05-15T14:51:52.7648203+00:00",
  "TransactionAmount": 1.1
}

application/xml, text/xml

Sample:

<KwikTagReservationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.KwikTag">
  <BarcodeToUse>sample string 2</BarcodeToUse>
  <Comment>sample string 1</Comment>
  <DrawerType>VendorInvoice</DrawerType>
  <PageCount>1</PageCount>
  <TransactionAmount>1.1</TransactionAmount>
  <TransactionDate>2025-05-15T14:51:52.7648203+00:00</TransactionDate>
  <TransactionNumber>sample string 4</TransactionNumber>
  <VendorId>sample string 3</VendorId>
</KwikTagReservationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'KwikTagReservationRequest'.

Response Information

Resource Description

Creates a Kwiktag reservation.

AgvKwiktagReservation

Name	Description	Type
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
Data	The results of the reservation assignment	KwikTagReservationResponse

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": {
    "Barcode": "sample string 1",
    "DocumentId": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<AgvKwiktagReservation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Kwiktag">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.KwikTag">
    <d2p1:Barcode>sample string 1</d2p1:Barcode>
    <d2p1:DocumentId>sample string 2</d2p1:DocumentId>
  </Data>
  <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>
  <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>
</AgvKwiktagReservation>