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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"records":[{"cendynPropertyID":"String","sourcePropertyID":"String","externalResID1":"String","externalProfileID":"String","externalRefType":"String","externalRefID":"String","transactionSource":"String","transactionID":"String","transactionGroup":"String","transactionDate":"0001-01-01T00:00:00.0000000","folioID":"String","folioGroupingID":"String","transactionCode":"String","description":"String","creditAmount":0,"debitAmount":0,"netAmount":0,"displayOnInvoice":false,"ledgerAccountNum":"String","ccTransactionType":"String","roomNumber":"String","transferType":"String","transferredResID":"String","referenceNum":"String","postedNights":0,"itemQty":0,"userID":"String","currencyCode":"String","decimals":0,"customValue1":0,"customValue2":0}],"status":"Success","statusMessage":"String","recordsReturned":0,"recordsAvailable":0,"pageNumber":0,"pageSize":0}