CenResService

TransactionRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class RequestStatus(str, Enum):
    SUCCESS = 'Success'
    WARNING = 'Warning'
    ERROR = 'Error'
    NOT_AUTHORIZED = 'NotAuthorized'
    FAILURE = 'Failure'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CenResResponse:
    status: Optional[RequestStatus] = None
    status_message: Optional[str] = None
    records_returned: Optional[int] = None
    records_available: Optional[int] = None
    page_number: Optional[int] = None
    page_size: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Transaction:
    cendyn_property_i_d: Optional[str] = None
    source_property_i_d: Optional[str] = None
    external_res_i_d1: Optional[str] = None
    external_profile_i_d: Optional[str] = None
    external_ref_type: Optional[str] = None
    external_ref_i_d: Optional[str] = None
    transaction_source: Optional[str] = None
    transaction_i_d: Optional[str] = None
    transaction_group: Optional[str] = None
    transaction_date: Optional[datetime.datetime] = None
    folio_i_d: Optional[str] = None
    folio_grouping_i_d: Optional[str] = None
    transaction_code: Optional[str] = None
    description: Optional[str] = None
    credit_amount: Optional[Decimal] = None
    debit_amount: Optional[Decimal] = None
    net_amount: Optional[Decimal] = None
    display_on_invoice: Optional[bool] = None
    ledger_account_num: Optional[str] = None
    cc_transaction_type: Optional[str] = None
    room_number: Optional[str] = None
    transfer_type: Optional[str] = None
    transferred_res_i_d: Optional[str] = None
    reference_num: Optional[str] = None
    posted_nights: Optional[int] = None
    item_qty: Optional[int] = None
    user_i_d: Optional[str] = None
    currency_code: Optional[str] = None
    decimals: Optional[int] = None
    custom_value1: Optional[Decimal] = None
    custom_value2: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransactionResponse(CenResResponse):
    records: Optional[List[Transaction]] = None


class TransactionQueryType(str, Enum):
    TRANSACTION_ID = 'TransactionId'
    LAST_UPDATED = 'LastUpdated'
    TRANSACTION_DATE = 'TransactionDate'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransactionRequest:
    cendyn_property_id: Optional[str] = None
    transaction_source: Optional[str] = None
    query: Optional[TransactionQueryType] = None
    id: Optional[str] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    page_size: Optional[int] = None
    page_number: Optional[int] = None

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