CenResService

<back to all web services

TransactionPost

The following routes are available for this service:
POST/transaction/{SubscriptionId}/{CendynPropertyId}
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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Response:
    status_code: Optional[str] = None
    record_count: Optional[int] = None
    error_count: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransactionHeader:
    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_header_source: Optional[str] = None
    external_i_d1: Optional[str] = None
    external_i_d2: Optional[str] = None
    opened_date: Optional[datetime.datetime] = None
    closed_date: Optional[datetime.datetime] = None
    posted_date: Optional[datetime.datetime] = None
    user_i_d: Optional[str] = None
    user_name: Optional[str] = None
    sales_rep: Optional[str] = None
    shipping_code: Optional[str] = None
    reference_num: Optional[str] = None
    custom_code1: Optional[str] = None
    custom_code2: Optional[str] = None
    custom_code3: Optional[int] = None
    tax_code: Optional[str] = None
    is_tax_exempt: Optional[bool] = None
    tax_amount: Optional[Decimal] = None
    fee_amount: Optional[Decimal] = None
    discount_amount: Optional[Decimal] = None
    net_amount: Optional[Decimal] = None
    total_amount: Optional[Decimal] = None
    currency_code: Optional[str] = None
    import_source: Optional[str] = None
    import_source_i_d: Optional[str] = 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 TransactionContainer:
    echo_token: Optional[str] = None
    transaction_header: Optional[TransactionHeader] = None
    transactions: Optional[List[Transaction]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransactionPost:
    transaction_container: Optional[TransactionContainer] = None
    subscription_id: Optional[str] = None
    cendyn_property_id: Optional[str] = None

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

POST /transaction/{SubscriptionId}/{CendynPropertyId} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TransactionPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CenResSS.ServiceModel">
  <CendynPropertyId>String</CendynPropertyId>
  <SubscriptionId>String</SubscriptionId>
  <TransactionContainer>
    <EchoToken>String</EchoToken>
    <TransactionHeader>
      <CendynPropertyID>String</CendynPropertyID>
      <ClosedDate>0001-01-01T00:00:00</ClosedDate>
      <CurrencyCode>String</CurrencyCode>
      <CustomCode1>String</CustomCode1>
      <CustomCode2>String</CustomCode2>
      <CustomCode3>0</CustomCode3>
      <DiscountAmount>0</DiscountAmount>
      <ExternalID1>String</ExternalID1>
      <ExternalID2>String</ExternalID2>
      <ExternalProfileID>String</ExternalProfileID>
      <ExternalRefID>String</ExternalRefID>
      <ExternalRefType>String</ExternalRefType>
      <ExternalResID1>String</ExternalResID1>
      <FeeAmount>0</FeeAmount>
      <ImportSource>String</ImportSource>
      <ImportSourceID>String</ImportSourceID>
      <IsTaxExempt>false</IsTaxExempt>
      <NetAmount>0</NetAmount>
      <OpenedDate>0001-01-01T00:00:00</OpenedDate>
      <PostedDate>0001-01-01T00:00:00</PostedDate>
      <ReferenceNum>String</ReferenceNum>
      <SalesRep>String</SalesRep>
      <ShippingCode>String</ShippingCode>
      <SourcePropertyID>String</SourcePropertyID>
      <TaxAmount>0</TaxAmount>
      <TaxCode>String</TaxCode>
      <TotalAmount>0</TotalAmount>
      <TransactionHeaderSource>String</TransactionHeaderSource>
      <UserID>String</UserID>
      <UserName>String</UserName>
    </TransactionHeader>
    <Transactions>
      <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>
    </Transactions>
  </TransactionContainer>
</TransactionPost>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CenResSS.ServiceModel">
  <ErrorCount>0</ErrorCount>
  <RecordCount>0</RecordCount>
  <StatusCode>String</StatusCode>
</Response>