CenResService

<back to all web services

TransactionRequest

The following routes are available for this service:
GET/v2/transaction/{Query}/{CendynPropertyId}
GET/v2/transaction/{Query}
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class TransactionRequest
{
    var cendynPropertyId:String? = null
    var transactionSource:String? = null
    var query:TransactionQueryType? = null
    var id:String? = null
    var startDate:Date? = null
    var endDate:Date? = null
    @DataMember(Name="Limit")
    @SerializedName("Limit")
    var pageSize:Int? = null

    @DataMember(Name="Page")
    @SerializedName("Page")
    var pageNumber:Int? = null
}

enum class TransactionQueryType
{
    TransactionId,
    LastUpdated,
    TransactionDate,
}

open class TransactionResponse : CenResResponse()
{
    var records:ArrayList<Transaction> = ArrayList<Transaction>()
}

open class CenResResponse
{
    var status:RequestStatus? = null
    var statusMessage:String? = null
    var recordsReturned:Int? = null
    var recordsAvailable:Int? = null
    var pageNumber:Int? = null
    var pageSize:Int? = null
}

enum class RequestStatus
{
    Success,
    Warning,
    Error,
    NotAuthorized,
    Failure,
}

open class Transaction
{
    var cendynPropertyID:String? = null
    var sourcePropertyID:String? = null
    var externalResID1:String? = null
    var externalProfileID:String? = null
    var externalRefType:String? = null
    var externalRefID:String? = null
    var transactionSource:String? = null
    var transactionID:String? = null
    var transactionGroup:String? = null
    var transactionDate:Date? = null
    var folioID:String? = null
    var folioGroupingID:String? = null
    var transactionCode:String? = null
    var description:String? = null
    var creditAmount:BigDecimal? = null
    var debitAmount:BigDecimal? = null
    var netAmount:BigDecimal? = null
    var displayOnInvoice:Boolean? = null
    var ledgerAccountNum:String? = null
    var ccTransactionType:String? = null
    var roomNumber:String? = null
    var transferType:String? = null
    var transferredResID:String? = null
    var referenceNum:String? = null
    var postedNights:Int? = null
    var itemQty:Int? = null
    var userID:String? = null
    var currencyCode:String? = null
    var decimals:Int? = null
    var customValue1:BigDecimal? = null
    var customValue2:BigDecimal? = null
}

Kotlin TransactionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v2/transaction/{Query}/{CendynPropertyId} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CenResSS.ServiceModel">
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RecordsAvailable>0</RecordsAvailable>
  <RecordsReturned>0</RecordsReturned>
  <Status>Success</Status>
  <StatusMessage>String</StatusMessage>
  <Records>
    <Transaction>
      <CCTransactionType>String</CCTransactionType>
      <CendynPropertyID>String</CendynPropertyID>
      <CreditAmount>0</CreditAmount>
      <CurrencyCode>String</CurrencyCode>
      <CustomValue1>0</CustomValue1>
      <CustomValue2>0</CustomValue2>
      <DebitAmount>0</DebitAmount>
      <Decimals>0</Decimals>
      <Description>String</Description>
      <DisplayOnInvoice>false</DisplayOnInvoice>
      <ExternalProfileID>String</ExternalProfileID>
      <ExternalRefID>String</ExternalRefID>
      <ExternalRefType>String</ExternalRefType>
      <ExternalResID1>String</ExternalResID1>
      <FolioGroupingID>String</FolioGroupingID>
      <FolioID>String</FolioID>
      <ItemQty>0</ItemQty>
      <LedgerAccountNum>String</LedgerAccountNum>
      <NetAmount>0</NetAmount>
      <PostedNights>0</PostedNights>
      <ReferenceNum>String</ReferenceNum>
      <RoomNumber>String</RoomNumber>
      <SourcePropertyID>String</SourcePropertyID>
      <TransactionCode>String</TransactionCode>
      <TransactionDate>0001-01-01T00:00:00</TransactionDate>
      <TransactionGroup>String</TransactionGroup>
      <TransactionID>String</TransactionID>
      <TransactionSource>String</TransactionSource>
      <TransferType>String</TransferType>
      <TransferredResID>String</TransferredResID>
      <UserID>String</UserID>
    </Transaction>
  </Records>
</TransactionResponse>