要求
語法
TaxFeeInfo
訊息使用下列語法:
<?xml version="1.0" encoding="UTF-8"?>
<TaxFeeInfo timestamp="timestamp"
id="message_ID"
partner="partner_key">
<Property action="[overlay]">
<ID>HotelID</ID>
<Taxes>
<Tax>
<RoomTypes>
<RoomType id="RoomID_1"/>
<RoomType id="RoomID_2"/>
</RoomTypes>
<RatePlans>
<RatePlan id="PackageID_1"/>
<RatePlan id="PackageID_2"/>
</RatePlans>
<BookingDates>
<DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week="MTWHFSU_or_subset"/>
</BookingDates>
<CheckinDates>
<DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week="MTWHFSU_or_subset"/>
</CheckinDates>
<CheckoutDates>
<DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week="MTWHFSU_or_subset"/>
</CheckoutDates>
<StayDates application="[all|any|overlap]">
<DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week="MTWHFSU_or_subset"/>
</StayDates>
<Type>[percent|amount|cumulative_percent]</Type>
<Basis>[room|person]</Basis>
<Period>[stay|night]</Period>
<Currency>currency_code</Currency>
<Amount>tax_amount</Amount>
<ApplicableNights max="integer" excluded="integer"/>
<LengthOfStay min="integer" max="integer"/>
<!-- Use either <Amount> or <Brackets> -->
<Brackets base_amount="tax_amount"/>
<Bracket starts_at="nightly_rate" amount="tax_amount"/>
</Brackets>
<AgeBrackets>
<AdultCharge amount="tax_amount"/>
<ChildAgeBrackets>
<ChildAgeBracket max_age="max_age" amount="tax_amount"/>
</ChildAgeBrackets>
</AgeBrackets>
<UserCountries type="[include|exclude]">
<Country code="country_code1"/>
<Country code="country_code2"/>
</UserCountries>
<Rank>integer</Rank>
</Tax>
</Taxes>
<Fees>
<Fee>
<RoomTypes>
<RoomType id="RoomID_1"/>
<RoomType id="RoomID_2"/>
</RoomTypes>
<RatePlans>
<RatePlan id="PackageID_1"/>
<RatePlan id="PackageID_2"/>
</RatePlans>
<BookingDates>
<DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week="MTWHFSU_or_subset"/>
</BookingDates>
<CheckinDates>
<DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week="MTWHFSU_or_subset"/>
</CheckinDates>
<CheckoutDates>
<DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week="MTWHFSU_or_subset"/>
</CheckoutDates>
<StayDates application="[all|any|overlap]">
<DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week="MTWHFSU_or_subset"/>
</StayDates>
<Type>[percent|amount|cumulative_percent]</Type>
<Basis>[room|person]</Basis>
<Period>[stay|night]</Period>
<Currency>currency_code</Currency>
<Amount>fee_amount</Amount>
<ApplicableNights max="integer" excluded="integer"/>
<LengthOfStay min="integer" max="integer"/>
<!-- Use either <Amount> or <Brackets> -->
<Brackets base_amount="tax_amount"/>
<Bracket starts_at="nightly_rate" amount="tax_amount"/>
</Brackets>
<AgeBrackets>
<AdultCharge amount="tax_amount"/>
<ChildAgeBrackets>
<ChildAgeBracket max_age="max_age" amount="tax_amount"/>
</ChildAgeBrackets>
</AgeBrackets>
<UserCountries type="[include|exclude]">
<Country code="country_code1"/>
<Country code="country_code2"/>
</UserCountries>
<Rank>integer</Rank>
</Fee>
</Fees>
</Property>
</TaxFeeInfo>
元素與屬性
TaxFeeInfo
訊息包含下列元素和
屬性:
元素 / @屬性 | 發生次數 | 類型 | 說明 |
---|---|---|---|
TaxFeeInfo | 1 | Complex element | 為單一訊息定義稅金與費用的訊息根元素 資源。 |
TaxFeeInfo / @timestamp | 1 | DateTime | 這則訊息的建立日期和時間。 |
TaxFeeInfo / @id | 1 | string | 此要求訊息的專屬 ID。系統會傳回這個值
。允許的字元包括 a-z 。
A-Z 、0-9 、_
(底線) 和 - (破折號)。 |
TaxFeeInfo / @partner | 1 | string | 這則訊息的合作夥伴帳戶。這個字串值為
「合作夥伴金鑰」列在
Hotel Center 的帳戶設定頁面。
注意:如果您的後端
多個帳戶,這個值必須符合 |
TaxFeeInfo / Property | 1..n | Property | 用來為單一房源定義稅金和費用的容器。 |
TaxFeeInfo / Property / @action | 0..1 | string | 指定套用更新的方式,只有 overlay 是
且預設值為 overlay 。先前所有
這項資源的 Taxes 和 Fees 將會是
。 |
TaxFeeInfo / Property / ID | 1 | string | 房源的專屬 ID。這個值必須符合 使用 <id> 指定飯店 ID英吋 飯店的 <listing> 元素 列出動態饋給。飯店 ID 也會列在 Hotel Center 中。 |
TaxFeeInfo / Property / Taxes | 0..1 | Taxes | 一或多個 <Tax> 元素的容器。 |
TaxFeeInfo / Property / Taxes / Tax | 1..n | Tax | 適用於房源的個別稅金, |
TaxFeeInfo / Property / Taxes / Tax / RoomTypes | 0..1 | RoomTypes | 用來儲存稅金的房型清單容器。
稅金已套用至各<RoomType>
。如未指定 <RoomTypes> ,
稅金適用於所有客房。 |
TaxFeeInfo / Property / Taxes / Tax / RoomTypes / RoomType | 1..n | RoomType | 指定房間類型。房間類型的定義是在
中的 <RoomData> 元素
「交易 (資源資料)」訊息,以及
藉由 RoomID 識別(
<RoomID> 值也會由
OTA_HotelRateAmountNotifRQ 中的 InvTypeCode 屬性
messages.) |
TaxFeeInfo / Property / Taxes / Tax / RoomTypes / RoomType / @id | 1 | string | 商品目錄 (客房類型) 的專屬 ID。這個值對應
透過交易資料傳送給 <RoomID>
(資源資料) 訊息。允許的字元數上限為
50. |
TaxFeeInfo / Property / Taxes / Tax / RatePlans | 0..1 | RatePlans | 用來標示適用稅金的費率方案清單。
如未指定 <RatePlans> ,則適用稅金
適用於所有房價方案。 |
TaxFeeInfo / Property / Taxes / Tax / RatePlans / RatePlan | 1..n | RatePlan | 指定房價方案。費率方案是由下列項目組成: 套件、費率和供應情形,如「交易」中所定義 (房源資料)、OTA_HotelRateAmountNotifRQ 和 OTA_HotelAvailNotifRQ 訊息,並由 PackageID 識別。 |
TaxFeeInfo / Property / Taxes / Tax / RatePlans / RatePlan / @id | 1 | string | 房價方案的專屬 ID。這個值對應至
取得
交易 (資源資料) 訊息的
<PackageData> 和
RatePlanCode
兩者皆有 <StatusApplicationControl> 屬性
<OTA_HotelRateAmountNotifRQ> 和
<OTA_HotelAvailNotifRQ> 則訊息。
長度上限為 50 個半形字元。 |
TaxFeeInfo / Property / Taxes / Tax / BookingDates | 0..1 | BookingDates | 用來存放一或多個日期範圍的容器,用來定義必須預訂的時機 需要繳納稅金。 |
TaxFeeInfo / Property / Taxes / Tax / BookingDates / DateRange | 1..99 | DateRange | 指定必須預訂稅金的日期範圍 已套用。 |
TaxFeeInfo / Property / Taxes / Tax / BookingDates / DateRange / @start | 0..1 | Date | 開始日期 (以房源的時區為準),含
日期範圍這個日期必須早於或等於
end 日期。如果未指定 start ,則日期
範圍實際上沒有限制。 |
TaxFeeInfo / Property / Taxes / Tax / BookingDates / DateRange / @end | 0..1 | Date | 結束日期 (以房源的時區為準),含
日期範圍。這個日期必須與 start 相同或晚於
日期。如果未指定 end ,則日期
範圍實際上沒有限制。 |
TaxFeeInfo / Property / Taxes / Tax / BookingDates / DateRange / @days_of_week | 0..1 | string | 日期範圍內允許的星期幾。如果不是 指定的日期,您可以在日期範圍內允許所有日期。每項 字元指定天數。例如「MTWHF」會指定 日期範圍。 有效的字元包括:
任何字元組合都有效。 |
TaxFeeInfo / Property / Taxes / Tax / CheckinDates | 0..1 | CheckinDates | 用來存放一或多個日期範圍的容器,用來定義簽到時間 可能需要繳納稅金 |
TaxFeeInfo / Property / Taxes / Tax / CheckinDates / DateRange | 1..20 | DateRange | 指定報稅必須入住的日期範圍 |
TaxFeeInfo / Property / Taxes / Tax / CheckinDates / DateRange / @start | 0..1 | Date | 開始日期 (以房源的時區為準),含
日期範圍這個日期必須早於或等於
end 日期。如果未指定 start ,則日期
範圍實際上沒有限制。 |
TaxFeeInfo / Property / Taxes / Tax / CheckinDates / DateRange / @end | 0..1 | Date | 結束日期 (以房源的時區為準),含
日期範圍。這個日期必須與 start 相同或晚於
日期。如果未指定 end ,則日期
範圍實際上沒有限制。 |
TaxFeeInfo / Property / Taxes / Tax / CheckinDates / DateRange / @days_of_week | 0..1 | string | 日期範圍內允許的星期幾。如果不是 指定的日期,您可以在日期範圍內允許所有日期。每項 字元指定天數。例如「MTWHF」會指定 日期範圍。 有效的字元包括:
任何字元組合都有效。 |
TaxFeeInfo / Property / Taxes / Tax / CheckoutDates | 0..1 | CheckoutDates | 用來裝載一或多個退房日期的容器 必須自行支付稅金。 |
TaxFeeInfo / Property / Taxes / Tax / CheckoutDates / DateRange | 1..20 | DateRange | 指定退房稅日期的日期範圍 |
TaxFeeInfo / Property / Taxes / Tax / CheckoutDates / DateRange / @start | 0..1 | Date | 開始日期 (以房源的時區為準),含
日期範圍這個日期必須早於或等於
end 日期。如果未指定 start ,則日期
範圍實際上沒有限制。 |
TaxFeeInfo / Property / Taxes / Tax / CheckoutDates / DateRange / @end | 0..1 | Date | 結束日期 (以房源的時區為準),含
日期範圍。這個日期必須與 start 相同或晚於
日期。如果未指定 end ,則日期
範圍實際上沒有限制。 |
TaxFeeInfo / Property / Taxes / Tax / CheckoutDates / DateRange / @days_of_week | 0..1 | string | 日期範圍內允許的星期幾。如果不是 指定的日期,您可以在日期範圍內允許所有日期。每項 字元指定天數。例如「MTWHF」會指定 日期範圍。 有效的字元包括:
任何字元組合都有效。 |
TaxFeeInfo / Property / Taxes / Tax / StayDates | 0..1 | StayDates | 包含一或多個日期範圍的容器 收取稅金,例如因應季節性折扣。 |
TaxFeeInfo / Property / Taxes / Tax / StayDates / @application | 1 | enum | 說明如何課徵稅金。 有效值如下:
必須一律指定此屬性。 |
TaxFeeInfo / Property / Taxes / Tax / StayDates / DateRange | 1..99 | DateRange | 指定套用稅金的日期範圍。 |
TaxFeeInfo / Property / Taxes / Tax / StayDates / DateRange / @start | 0..1 | Date | 開始日期 (以房源的時區為準),含
日期範圍這個日期必須早於或等於
end 日期。如果未指定 start ,則日期
範圍實際上沒有限制。 |
TaxFeeInfo / Property / Taxes / Tax / StayDates / DateRange / @end | 0..1 | Date | 結束日期 (以房源的時區為準),含
日期範圍。這個日期必須與 start 相同或晚於
日期。如果未指定 end ,則日期
範圍實際上沒有限制。 |
TaxFeeInfo / Property / Taxes / Tax / StayDates / DateRange / @days_of_week | 0..1 | string | 日期範圍內允許的星期幾。如果不是 指定的日期,您可以在日期範圍內允許所有日期。每項 字元指定天數。例如「MTWHF」會指定 日期範圍。 有效的字元包括:
任何字元組合都有效。 |
TaxFeeInfo / Property / Taxes / Tax / Type | 1 | enum | 有效值如下:
「 |
TaxFeeInfo / Property / Taxes / Tax / Basis | 1 | enum | 有效值如下:
|
TaxFeeInfo / Property / Taxes / Tax / Period | 1 | enum |
有效值如下:
|
TaxFeeInfo / Property / Taxes / Tax / Currency | 0..1 | string | 稅金的幣別代碼 (共 3 個字母),例如「USD」。 |
TaxFeeInfo / Property / Taxes / Tax / Amount | 0..1 | float | 稅額的百分比或金額。 |
TaxFeeInfo / Property / Taxes / Tax / ApplicableNights | 0..1 | ApplicableNights | 只有在 <Type> 設為
amount 和 <Period> 已設為
晚。
限制可獲得稅金的住宿天數。 指定 |
TaxFeeInfo / Property / Taxes / Tax / ApplicableNights / @max | 0..1 | integer | <ApplicableNights max="N"> 表示晚上
前 N 晚過後即可排除這些時段。 |
TaxFeeInfo / Property / Taxes / Tax / ApplicableNights / @excluded | 0..1 | integer | <ApplicableNights excluded="N"> 表示
應排除前 N 晚。 |
TaxFeeInfo / Property / Taxes / Tax / LengthOfStay | 0..1 | LengthOfStay | 定義可套用這項稅金的入住天數限制。 入住天數超出下限和上限時,系統不會套用稅金 |
TaxFeeInfo / Property / Taxes / Tax / LengthOfStay / @min | 0..1 | integer | 入住入住天數的最低住宿天數限制,以收取稅金。 如未指定,則沒有下限。 |
TaxFeeInfo / Property / Taxes / Tax / LengthOfStay / @max | 0..1 | integer | 入住天數最多允許收取稅金。 如果沒有指定,則沒有上限。 |
TaxFeeInfo / Property / Taxes / Tax / Brackets | 0..1 | Brackets | 一或多個 <Bracket> 元素的容器。
定義一組連續且不重疊的稅號。例如印度商品及服務稅研究室稅。
您必須將 |
TaxFeeInfo / Property / Taxes / Tax / Brackets / @base_amount | 0..1 | float | 適用於每晚房價的稅金百分比或金額
低於第一個括號的 starts_at 值。 |
TaxFeeInfo / Property / Taxes / Tax / Brackets / Bracket | 1..n | Bracket | 依據每晚房價定義稅率。 |
TaxFeeInfo / Property / Taxes / Tax / Brackets / Bracket / @starts_at | 1 | float | 定義稅項的下限。上限為
於後續括號的 當每晚房價大於或等於
加到括號的 這個值必須嚴格大於 0。 |
TaxFeeInfo / Property / Taxes / Tax / Brackets / Bracket / @amount | 1 | float | 這個稅號適用的稅額百分比或稅額值。 |
TaxFeeInfo / Property / Taxes / Tax / AgeBrackets | 0..1 | AgeBrackets | 允許根據入住人數指定一組稅金年齡。
這個元素只有在 |
TaxFeeInfo / Property / Taxes / Tax / AgeBrackets / AdultCharge | 0..1 | AdultCharge | 用來指定成人稅金的容器。 |
TaxFeeInfo / Property / Taxes / Tax / AgeBrackets / AdultCharge / @amount | 1 | float | 成人適用的固定稅額。 |
TaxFeeInfo / Property / Taxes / Tax / AgeBrackets / ChildAgeBrackets | 0..1 | ChildAgeBrackets | 用來保留一或多個 <ChildAgeBracket> 的容器
元素。 |
TaxFeeInfo / Property / Taxes / Tax / AgeBrackets / ChildAgeBrackets / ChildAgeBracket | 1..n | ChildAgeBracket | 定義兒童適用的年齡層和相應的稅額。 |
TaxFeeInfo / Property / Taxes / Tax / AgeBrackets / ChildAgeBrackets / ChildAgeBracket / @max_age | 1 | integer | 定義兒童年齡上限。下限為
已指定在上述括號的
|
TaxFeeInfo / Property / Taxes / Tax / AgeBrackets / ChildAgeBrackets / ChildAgeBracket / @amount | 1 | float | 這個年齡層的兒童適用固定稅額。 |
TaxFeeInfo / Property / Taxes / Tax / UserCountries | 0..1 | UserCountries | 用來列出相關稅金的使用者國家/地區容器 納入或排除如果有的話,報表中只會列出稅金。 排除在指定國家/地區外的使用者。 |
TaxFeeInfo / Property / Taxes / Tax / UserCountries / @type | 0..1 | enum | UserCountry 規格的類型。
有效值為 如果使用者國家/地區 而使用者國家/地區 如果未設定使用者國家/地區 |
TaxFeeInfo / Property / Taxes / Tax / UserCountries / Country | 1..n | Country | 定義使用者國家/地區清單中的一個國家/地區。 |
TaxFeeInfo / Property / Taxes / Tax / UserCountries / Country / @code | 1 | string | CLDR 國家/地區代碼
例如 DE 或 FR 請注意
國家/地區,CLDR 國家/地區代碼與 2 個字母的 ISO 不同
國家/地區代碼。而且不支援 CLDR 區碼。 |
TaxFeeInfo / Property / Taxes / Tax / Rank | 1 | integer | 一種等級,用來指定這項稅金或費用的申請順序。
例如,如果值為 2,則代表系統會收取第二筆稅金。
如果
|
TaxFeeInfo / Property / Fees | 0..1 | Fees | 一或多個 <Fee> 元素的容器。 |
TaxFeeInfo / Property / Fees / Fee | 1..n | Fee | 針對房源支付的個人費用, |
範例
每項房源有 300 筆稅金和費用的上限。詳情請參閱 「刪除稅金」例如移除房源的稅金和相關費用
基本訊息
基本的 TaxFeeInfo
訊息:
<?xml version="1.0" encoding="UTF-8"?> <TaxFeeInfo timestamp="2020-05-18T16:20:00-04:00" id="12345678" partner="partner_key"> <Property> <ID>Property_1</ID> <Taxes> <Tax> <Type>percent</Type> <Basis>room</Basis> <Period>stay</Period> <Amount>10.00</Amount> </Tax> </Taxes> <Fees> <Fee> <Type>amount</Type> <Basis>person</Basis> <Period>night</Period> <Currency>USD</Currency> <Amount>5.00</Amount> </Fee> </Fees> </Property> </TaxFeeInfo>
刪除稅金
刪除指定飯店的所有房源層級稅金和費用:
<?xml version="1.0" encoding="UTF-8"?> <TaxFeeInfo timestamp="2022-06-16T16:20:00-04:00" id="12345678" partner="partner_key" <Property action="overlay"/> <ID>Property_1</ID> </Property> </TaxFeeInfo>
Slab 稅
依每晚房價計算的印度商品及服務稅研究室稅。稅務括號 是:
- 如果每晚房價小於或等於 1000,則免稅。
- 如果每晚房價超過 1000 且低於或等於 12%,則稅金另計 等於 7500。
- 如果每晚房價超過 7500,稅金為 18%。
<?xml version="1.0" encoding="UTF-8"?> <TaxFeeInfo timestamp="2020-05-18T16:20:00-04:00" id="12345678" partner="partner_key"> <Property> <ID>Property_1</ID> <Taxes> <Tax> <Type>percent</Type> <Basis>room</Basis> <Period>night</Period> <Brackets base_amount="0"> <Bracket starts_at="1000.01" amount="12"/> <Bracket starts_at="7500.01" amount="18"/> </Brackets> </Tax> </Taxes> </Property> </TaxFeeInfo>
依年齡計算的稅金
根據入住人數計算的稅金:
- 成人入住的稅金為 $20 美元。
- 年齡 11 至 17 歲兒童的稅金為 $10 美元。
- 年齡 0 至 10 歲兒童的稅金為 $5 美元。
<?xml version="1.0" encoding="UTF-8"?> <TaxFeeInfo timestamp="2020-05-18T16:20:00-04:00" id="12345678" partner="partner_key"> <Property> <ID>Property_1</ID> <Taxes> <Tax> <Type>amount</Type> <Basis>person</Basis> <Period>night</Period> <AgeBrackets> <AdultCharge amount="20"/> <ChildAgeBrackets> <ChildAgeBracket max_age="10" amount="5"/> <ChildAgeBracket max_age="17" amount="10"/> </ChildAgeBrackets> </AgeBrackets> </Tax> </Taxes> </Property> </TaxFeeInfo>
回應
語法
TaxFeeInfoResponse
訊息使用下列語法:
<?xml version="1.0" encoding="UTF-8"?>
<TaxFeeInfoResponse timestamp="timestamp"
id="message_ID"
partner="partner_key">
<!-- Either Success or Issues will be populated. -->
<Success/>
<Issues>
<Issue code="issue_code" status="issue_type">issue_description</Issue>
</Issues>
</TaxFeeInfoResponse>
元素與屬性
TaxFeeInfoResponse
訊息包含下列內容
元素與屬性:
元素 / @屬性 | 發生次數 | 類型 | 說明 |
---|---|---|---|
TaxFeeInfoResponse | 1 | Complex element | 表示接收端成功或問題的根元素 TaxFeeInfo 要求訊息。 |
TaxFeeInfoResponse / @timestamp | 1 | DateTime | 這則訊息的建立日期和時間。 |
TaxFeeInfoResponse / @id | 1 | string | 相關 TaxFeeInfo 訊息中的專屬 ID。 |
TaxFeeInfoResponse / @partner | 1 | string | 這則訊息的合作夥伴帳戶。 |
TaxFeeInfoResponse / Success | 0..1 | Success | 表示 TaxFeeInfo 訊息已順利處理完畢
而不會出現警告、錯誤或失敗
|
TaxFeeInfoResponse / Issues | 0..1 | Issues | 用來存放處理
TaxFeeInfo 訊息。
|
TaxFeeInfoResponse / Issues / Issue | 1..n | Issue | 出現警告、錯誤或失敗情形的說明 處理 TaxFeeInfo 訊息的程序。查看這些問題的詳細資料 動態饋給狀態錯誤訊息一文中的指示。 |
TaxFeeInfoResponse / Issues / Issue / @code | 1 | integer | 問題的 ID。 |
TaxFeeInfoResponse / Issues / Issue / @status | 1 | enum | 遇到的問題類型。 有效值為 |
範例
成功
以下的回應內容是成功處理的 TaxFeeInfo 撰寫新的電子郵件訊息
<?xml version="1.0" encoding="UTF-8"?> <TaxFeeInfoResponse timestamp="2020-05-18T16:20:00-04:00" id="12345678" partner="partner_key"> <Success/> </TaxFeeInfoResponse>
問題
以下是對 TaxFeeInfo 訊息的回覆,原因是 發生錯誤。
<?xml version="1.0" encoding="UTF-8"?> <TaxFeeInfoResponse timestamp="2020-05-18T16:20:00-04:00" id="12345678" partner="partner_key"> <Issues> <Issue code="1001" status="error">Example</Issue> </Issues> </TaxFeeInfoResponse>