Folios

Post a manual channel commission

Manually post a channel commission line on a reservation folio. This covers the edge case where a reservation that should have been channel-delivered was created manually in the PMS, so no commission line was posted automatically. The commission is posted under the same transaction code as channel-delivered commission (so it rolls up identically in cost-of-acquisition reporting) but is flagged as manually sourced, which allows multiple manual commissions per reservation and makes the line voidable from the folio. Processing is asynchronous; the returned event id can be used to track completion.

post/accounting/v1.0/folios/transactions/channel-commission

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/accounting/v1.0/folios/transactions/channel-commission
  • Auth
    HTTP bearer

Headers

X-Property-IDinteger required

Unique identifier of the property. Required for all requests to scope data to a specific property.

Request body

reservationIdinteger required

Reservation ID the commission is posted against.

guestIdinteger required

Guest (customer) ID associated with the commission.

channelCodestring required

Channel code the commission belongs to (e.g. the Hostelworld channel code).

transactionDatetimestring date-time nullable

Posting date/time. When omitted (or not in the future) the line is posted immediately; when set to a future date/time the line stays pending until then.

amountnumber required

Commission amount in decimal form (e.g. 50.00).

notesstring nullable

Optional free-text notes for the commission line.

folioIdinteger nullable

Target folio the commission is assigned to. When omitted the line lands on the reservation's default folio.

Response

OK

eventIdstring

Id of event which will be processed asynchronous.

Changes

No recorded changes to this operation across all 1 revision of this API.