Skip to content

ListFolioTransactionsRequest.md

Latest commit

 

History

History
45 lines (36 loc) · 3.48 KB

ListFolioTransactionsRequest.md

File metadata and controls

45 lines (36 loc) · 3.48 KB

ListFolioTransactionsRequest

Properties

Name Type Description Notes
source_id int Source ID (reservation ID, group profile ID, house account ID)
source_kind SourceKind
folio_id int Filter by specific folio [optional]
posted bool Filter by posted status. Omit to include both posted and pending. [optional]
description_filters List[str] Filter by transaction description identifiers. Accepts composite identifiers in the format: "{type}_{originId}" for item-level filtering (e.g. "product_123", "tax_456", "addon_789", "fee_101", "custom_item_202", "bookable_resource_303"), literal group names for room revenue ("rate", "roomRevenue_manual", "roomRevenue_cancellation", "roomRevenue_no_show", "accountsReceivable"), or payment method codes ("cash", "ebanking", "cards_visa", "cards_master", "pay_pal"). Server translates these to internalTransactionCode group + originId query conditions. [optional]
transaction_date_from datetime Filter transactions from this datetime (UTC, inclusive) [optional]
transaction_date_to datetime Filter transactions to this datetime (UTC, inclusive) [optional]
service_date_from date Filter by service date from (inclusive) [optional]
service_date_to date Filter by service date to (inclusive) [optional]
sub_source_ids List[int] Filter by sub-source IDs (booking room IDs for reservations) [optional]
search_query str Free text search on transaction description [optional]
group_by FolioTransactionGroupByField [optional]
sort List[Sort] [optional]
page_token str [optional]
limit int Page size. Default 100, max 1100. [optional] [default to 100]
include_voided bool Include voided transactions. When false, both void transactions and the original transactions they voided are excluded (full chain removal via rootId matching). [optional] [default to True]
include_total bool Include totals in response. On first page, totals are computed and cached in Redis. Subsequent pages return cached totals. When no filters are applied, total amount is read from the pre-computed source balance. [optional] [default to False]

Example

from cloudbeds_accounting.models.list_folio_transactions_request import ListFolioTransactionsRequest

# TODO update the JSON string below
json = "{}"
# create an instance of ListFolioTransactionsRequest from a JSON string
list_folio_transactions_request_instance = ListFolioTransactionsRequest.from_json(json)
# print the JSON string representation of the object
print(ListFolioTransactionsRequest.to_json())

# convert the object into a dict
list_folio_transactions_request_dict = list_folio_transactions_request_instance.to_dict()
# create an instance of ListFolioTransactionsRequest from a dict
list_folio_transactions_request_from_dict = ListFolioTransactionsRequest.from_dict(list_folio_transactions_request_dict)

[Back to Model list] [Back to API list] [Back to README]