CenResService

TransactionRequest

The following routes are available for this service:
GET	/v2/transaction/{Query}/{CendynPropertyId}
GET	/v2/transaction/{Query}


export enum RequestStatus
{
    Success = 'Success',
    Warning = 'Warning',
    Error = 'Error',
    NotAuthorized = 'NotAuthorized',
    Failure = 'Failure',
}

export class CenResResponse
{
    public status?: RequestStatus;
    public statusMessage?: string;
    public recordsReturned?: number;
    public recordsAvailable?: number;
    public pageNumber?: number;
    public pageSize?: number;

    public constructor(init?: Partial<CenResResponse>) { (Object as any).assign(this, init); }
}

export class Transaction
{
    public cendynPropertyID?: string;
    public sourcePropertyID?: string;
    public externalResID1?: string;
    public externalProfileID?: string;
    public externalRefType?: string;
    public externalRefID?: string;
    public transactionSource?: string;
    public transactionID?: string;
    public transactionGroup?: string;
    public transactionDate?: string;
    public folioID?: string;
    public folioGroupingID?: string;
    public transactionCode?: string;
    public description?: string;
    public creditAmount?: number;
    public debitAmount?: number;
    public netAmount?: number;
    public displayOnInvoice?: boolean;
    public ledgerAccountNum?: string;
    public ccTransactionType?: string;
    public roomNumber?: string;
    public transferType?: string;
    public transferredResID?: string;
    public referenceNum?: string;
    public postedNights?: number;
    public itemQty?: number;
    public userID?: string;
    public currencyCode?: string;
    public decimals?: number;
    public customValue1?: number;
    public customValue2?: number;

    public constructor(init?: Partial<Transaction>) { (Object as any).assign(this, init); }
}

export class TransactionResponse extends CenResResponse
{
    public records?: Transaction[];

    public constructor(init?: Partial<TransactionResponse>) { super(init); (Object as any).assign(this, init); }
}

export enum TransactionQueryType
{
    TransactionId = 'TransactionId',
    LastUpdated = 'LastUpdated',
    TransactionDate = 'TransactionDate',
}

export class TransactionRequest
{
    public cendynPropertyId?: string;
    public transactionSource?: string;
    public query?: TransactionQueryType;
    public id?: string;
    public startDate?: string;
    public endDate?: string;
    // @DataMember(Name="Limit")
    public pageSize?: number;

    // @DataMember(Name="Page")
    public pageNumber?: number;

    public constructor(init?: Partial<TransactionRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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}