CenResService

<back to all web services

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 .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>