CommissionsProvider Service

A provider to help manage and update commissions distributed by the TMC for services rendered.

Namespace
http://accounting.service.cbtweb.cbt.com/
WSDL
accounting.wsdl
Path
/CommissionsProviderService

refreshAgentCommissionStatusForItinerary Operation

Update commissions based on the segments in the given itinerary.

Input Parameters
name type description
itineraryId long The itineray ID to update.
Return Value
type description
list of agentCommissionStatement A list of updated commission statuses for the given itinerary.

getAgentCommissionsForItinerary Operation

Get the current status of commissions for a particular itinerary.

Input Parameters
name type description
itineraryId long The itinerary ID to get the commissions for.
Return Value
type description
list of agentCommissionStatement A list of commissions expected (or paid) for this itinerary.

getItineraryIdsForAgentCommissions Operation

Method to retrieve itinerary ids for reloading data. Used in the Commissions Import.

Input Parameters
name type description
startDate dateTime The earliest issue date to retrieve.
endDate dateTime The latest issue date to retrieve.
statusId long The status of commission to retrieve.
agentId long The agent to retrieve commissions for.
Return Value
type description
JAXBList A list of itinerary ids that have been issued that have commissions in the given status.

updateAgentCommissionStatement Operation

Update an agent commission statement with the given information. This can't be used to create new statements. To do that, you need to use the itinerary loader. This can be used to update expected amount and the closed date.

Input Parameters
name type description
statement agentCommissionStatement  
Return Value
type description
agentCommissionStatement The updated agent commission statement.

getAgentCommissionStatementById Operation

Get an AgentCommissionStatement object by its id. Use this to get objects so you can edit them.

Input Parameters
name type description
id long The ID of the AgentCommissionStatement.
Return Value
type description
agentCommissionStatement An AgentCommissionStatement represented by the given id.

getAvailableAgentCommissionFilters Operation

Get filterable properties for agent commissions

Return Value
type description
list of filterItem FilterItems

countAgentCommissions Operation

Get a count of the number of total commissions that fall under the given search criteria.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
long A count

getCommissionSummary Operation

Get a financial summary of all of the commissions that fall under the given search criteria.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
commissionSummary CommissionSummaries

searchAgentCommissions Operation

Get the commissions that fall under the given search criteria.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
list of agentCommissionPojo AgentCommissionPojos

countAgentCommissionsForAgent Operation

Get a count of the number of total commissions for the given agent that fall under the given search criteria. This method is used to prevent agents from seeing other agents' commissions.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
long A count

getCommissionSummaryForAgent Operation

Get a financial summary of all the commissions for the given agent that fall under the given search criteria. This method is used to prevent agents from seeing other agents' commissions.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
commissionSummary CommissionSummaries

searchAgentCommissionsForAgent Operation

Get the commissions for the given agent that fall under the given search criteria This method is used to prevent agents from seeing other agents' commissions.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
list of agentCommissionPojo AgentCommissions

searchUniqueAgentCommissions Operation

Get the commissions that fall under the given search criteria.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
list of agentCommissionPojo AgentCommissionPojos

countUniqueAgentCommissions Operation

Get a count of the number of total commissions that fall under the given search criteria.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
long A count

searchUniqueAgentCommissionsForAgent Operation

Get the commissions for the given agent that fall under the given search criteria This method is used to prevent agents from seeing other agents' commissions.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
list of agentCommissionPojo AgentCommissions

countUniqueAgentCommissionsForAgent Operation

Get a count of the number of total commissions for the given agent that fall under the given search criteria. This method is used to prevent agents from seeing other agents' commissions.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for commissions.
Return Value
type description
long A count

getCommissionNotesById Operation

Get the notes for the given commission statement.

Input Parameters
name type description
id long commission statement id
Return Value
type description
list of simpleCommissionNote Notes for the commission statement

getCommissionNotesByStatementId Operation

Input Parameters
name type description
id long  
Return Value
type description
list of simpleCommissionNote  

updateCommissionNote Operation

create or edit a Commission statement note

Input Parameters
name type description
note agentCommissionStatementNote the new note
Return Value
type description
agentCommissionStatementNote the updated note

matchNonInvoicedHotelAndCarCommissionsForDay Operation

Checks the accounting database for commissions applied on a specific day and tries to match them to non-invoiced records in Airportal.

Input Parameters
name type description
startDate dateTime The date to start checking commissions on.
endDate dateTime The date to end checking commissions on.
agencyid long The ID of the agency to get commissions for.
accountingsystemid long The ID of the accounting system type to get commissions for.
Return Value
type description
list of agentCommissionStatement A list of matched agent commission statements.