CenResService

<back to all web services

TransactionRequest

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

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>