Export APIs
The following topics provide details on available Export APIs.
- Create HESTA Statistics Exports
- Post HESTA Statistics Export
- Set / View Global Variable Name Reference
- Get Report Table ID for Last / Current Export
- Get Cached Value of Export Data Passed from Package Global Variable
- Set Start Date for Exports
- Set End Date for Exports
- Get Currency Exchange Rate
- Get Block Code for Resort / Allotment
- Get Reservation External Reference Number
- Get Reservation Guest Name
- Check for Existing Resort Export
- Get Current Business Date
- Get Parameter Value Configured for Logged-in Resort
- Get the Resort Code of the Logged-in Resort
- Set Business Date for a Given Session
- Get the Property’s Date
- Get BOF Interface Code2
- Get Checked Out Reservations for Specified Dates
- Get Considered Date of a Reservations Export
- Get Considered Date of an Export
- Get External Reference Value from Membership
- Get Hotel Code
- Get Include Guests without VAT Number Indicator
- Get Minimum Amount
- Get Report ID of the Export Data
- Get the Export Country
- Get the Export’s “From Date”
- Get the Export’s “To Date”
- Set the Export’s “End Date”
- Initialize Buckets Summed Value
- Initialize/Set Export Type
- Set Global Data to Date
- Set Age Credit
- Get Parameter Method
- Get Parameter Value
- Get External Reference
- Set Global Variable
- Get Last Report ID
- Get the Number of Cached Records
- Create Export Data for Italian ASTAT
- Create Export Data for Istat Firenze
- Clean Export Data for Istat Firenze
- Create Export Data for Istat Puglia Region
- Create Export Data for Istat Veneto Region
- Create Export Data for Vietnam Vat
- Clean Export Data for Vietnam Vat
- Get the Commission Code for Profile
- Get Total Available Rooms for the Property
- Set Trial Balance Statistics Export
- Create Export Data for Austria Cash Register
- Clean Export Data for Austria Cash Register
- Set Value Of Start Date
- Set Gen Export
- Set Export for CODENTX
- Set Export for CODESVC
- Get Last Report ID
- Get Next Export Sequence
- Get Export Value
- Get Property Codes
- Get Next Invoice
- Get C Operating Unit
- Get Property Primary Code
- Clean Export Data for Italy
- Create Export Data for Italy
- Create JPK Export for Poland
- Clean JPK Export for Poland
- Create SAFT Export for Portugal
- Clean SAFT Export for Portugal
- Create Export Data for France
- Clean Export Data for France
- Create Export for India
- Get the Version Information
- Get Total Count of Records for ALL
- Get Total Count of Records for TMP
- Get Number Of Rooms Reserved
- Get Province
- Get Country ID
- Get City ID
- Get Rooms By Date
- Get Physical Inventory
- Get Available Beds
- Get Last Reservation ID
- Get Last Group
- Get Name ID
- Get Membership Level
- Get Commission Code For Rate Code
- Get Profile Info
- Fix Characters
- Get the Country Description
- Get State Description
- Get Out of Service Room Count
- Get Out of Order Room Count
- Get Bill Generation Date
- Get Export Considered Run Date
- Determine Value Type
- Convert Business Date
- Get Payment Methods
- Get New Time
- Get Property Currency
- Get Property Language
- Get Timezone
- Search Entity Detail Translation
- Set Bucket Code Type
- Get Export Start Date
- Get Availability
- Get COMM End Date
- Get COMM Check Number
- Get COMM Begin Date
- Get COMM Agent ID
- Get COMM Account ID
- Set Data To Date
- Get All Export Values
- Get Filename Format
- Set Data From Date
- Get Date Iteration
- Get Export Data ID
- Get Export Mode
- Get ISO Language Code
- Get Data to Folio
- Get Data From Folio
- Get Cash Register ID
- Get ISO Date Format
- Get District Code
- Get Data From Date
Parent topic: Exports
Create HESTA Statistics Exports
EXP_COUNTRY_CH.CREATE_HESTA_STAT_EXP(IN_DATE_FROM’,’IN_DATE_TO)
This procedure acts as the pre export procedure for HESTA Statistics Exports. The procedure finds the eligible reservations in the given date range for HESTA statistics exports. If the in_date_from and in_date_to are passed as null, the procedure finds the reservations for the last 30 days based on the current business date.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATE_FROM |
Yes |
Date |
Beginning date range. |
IN_DATE_TO |
Yes |
Date |
Ending date range. |
EXAMPLE
EXP_COUNTRY_CH.CREATE_HESTA_STAT_EXP(01-JAN-2021’,’10-JAN-2021)
Parent topic: Export APIs
Post HESTA Statistics Export
EXP_COUNTRY_CH.POST_HESTA_STAT_EXP
This procedure acts as the Post Export procedure for HESTA Statistics export. The API deletes the temporary table entries made for the HESTA export creation. The API has relevance only with HESTA statistics exports.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
No |
NA |
Post export procedure. |
EXAMPLE
EXP_COUNTRY_CH.POST_HESTA_STAT_EXP;
Parent topic: Export APIs
Set / View Global Variable Name Reference
NAME_REF.SET_VIEW_INACTIVE_FLAG(IN_YN)
This function sets the Global variable name_ref. g_View_Inactive_Flag with the value passed with the argument IN_YN.
Parameter | Required | Type | Description |
---|---|---|---|
IN_YN (DEFAULT’N’) |
Y |
VARCHAR2 |
Sets Inactive flag view. |
EXAMPLE
NAME_REF.SET_VIEW_INACTIVE_FLAG(‘Y’) This sets the global variable as Yes.
NAME_REF.SET_VIEW_INACTIVE_FLAG(‘N’) This sets the global variable as No.
Parent topic: Export APIs
Get Report Table ID for Last / Current Export
BACKLOG_BLOCKS.GET_LAST_REPORT_ID
This function returns the unique ID associated with the report_table for the Last/Current Export execution. Currently, this API is used in the WHERE CONDITION of Backlog and Room Pace Exports. The Report ID is set in the pre-export procedure of these exports.
Parameter | Required | Type | Description |
---|---|---|---|
No |
Returns report ID for last/current export. |
EXAMPLE
WHERE_CLAUSE=export_id=backlog_blocks.get_last_report_id
Parent topic: Export APIs
Get Cached Value of Export Data Passed from Package Global Variable
EXPORT_DATA_P.GET_CACHED_NUM(IN_CODE)
This function returns the value associated with the code passed in the input argument from the package global variable.
Parameter | Required | Type | Description |
---|---|---|---|
IN_CODE |
Yes |
VARCHAR2 |
Value of code passed. |
EXAMPLE
EXPORT_DATA_P.GET_CACHED_NUM
Parent topic: Export APIs
Set Start Date for Exports
REP_RESV_STATISTICS.SET_START_DATE(IN_DATE)
This API sets the Start date for Exports like Stats by Market Code, Tiers, and Room Types. If the IN_DATE is passed as NULL, the business date will be considered as the start date for the export.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATE |
Yes |
Date |
Sets the Start date of Exports. |
EXAMPLE
rep_resv_statistics.SET_start_date(EXP_GENERAL_RESV_PKG.EXP_START_DATE)
Here, EXP_GENERAL_RESV_PKG.EXP_START_DATE will contain the date provided in the export parameter screen.
Parent topic: Export APIs
Set End Date for Exports
REP_RESV_STATISTICS.SET_END_DATE(IN_DATE)
This API sets the end date for exports such as Stats by Market Code, Tiers, and Room Types. If the IN_DATE is passed as NULL, the business date will be considered as the end date for the export.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATE |
Yes |
Date |
Sets end date of exports. |
EXAMPLE
rep_resv_statistics.SET_END_date(EXP_GENERAL_RESV_PKG.EXP_start_DATE)
Here, EXP_GENERAL_RESV_PKG.EXP_START_DATE will contain the date provided in the export parameter screen.
Parent topic: Export APIs
Get Currency Exchange Rate
MULTI_CURRENCY.GET_EXCHANGE_RATE
This function converts an amount from one currency to another based on a specific exchange type, property, and date.
Parameter | Required | Type | Description |
---|---|---|---|
FROM_CURRENCY |
Yes |
VARCHAR2 |
Returns the currency type. |
FROM_CURRENCY_AMT |
No |
NUMBER |
Transaction amount converted into a specific currency. |
TO_CURRENCY |
No |
VARCHAR2 |
Sets the currency type. |
EXCH_TYPE |
No |
VARCHAR2 |
Sets the currency exchange type. |
IN_DATE |
No |
DATE |
Sets the exchange date. |
IN_RESORT |
No |
VARCHAR2 |
Identifies the property. |
EXAMPLE
MULTI_CURRENCY.GET_EXCHANGE_RATE ('USD','100','INR','P','15-SEP-2021','BANGKOK')
Parent topic: Export APIs
Get Block Code for Resort / Allotment
RESERVATION_REF.GET_BLOCK_CODE(IN_RESORT','IN_ALLOTMENT_HEADER_ID)
This function returns the block for a given resort/allotment header ID combination.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESORT |
Yes |
VARCHAR2 |
Returns block for given resort. |
IN_ALLOTMENT_HEADER_ID |
Yes |
NUMBER |
Returns block for given allotment header. |
EXAMPLE
Vblockcode := RESERVATION_REF.GET_BLOCK_CODE(‘TOKYO’,112356);
Parent topic: Export APIs
Get Reservation External Reference Number
RESERVATION_REF.GET_EXTERNAL_REFERENCE(IN_RESORT','IN_RESV_NAME_ID)
This function returns the external reference number of a reservation. The resort and resv name id will be passed as IN arguments.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESORT |
Yes |
VARCHAR2 |
Passes resort name. |
IN_RESV_NAME_ID |
Yes |
NUMBER |
Passes resv name ID. |
EXAMPLE
Vrefno := RESERVATION_REF.GET_EXTERNAL_REFERENCE(‘TOKYO’,11223);
Parent topic: Export APIs
Get Reservation Guest Name
Vname := RESERVATION_REF.GET_NAME(IN_NAME_ID,’IN_NAME_PREFERENCE’,’IN_EXTENDED_YN')
Vname := RESERVATION_REF.GET_NAME('IN_RESORT’,IN_RESV_NAME_ID,’IN_NAME_PREFERENCE’,’IN_EXTENDED_YN')
This function is overloaded. It can be either invoked with NAME ID, NAME PREFERENCE AND EXTENDED_YN OR with RESORT, RESV NAME ID, NAME PREFERENCE AND EXTENDED_YN. This function returns the guest name based on the given arguments.
Parameter | Required | Type | Description |
---|---|---|---|
IN_NAME_ID |
Yes |
NUMBER |
Returns guest name ID. |
IN_NAME_PREFERENCE (DEFAULT ‘L’) |
Yes |
VARCHAR2 |
Returns guest name preference. |
IN_EXTENDED_YN (DEFAULT ‘N’) |
Yes |
VARCHAR2 |
Indicates extended: yes, no. |
IN_RESORT |
Yes |
VARCHAR2 |
Returns resort name. |
IN_RESV_NAME_ID |
Yes |
NUMBER |
Returns reservation ID. |
IN_NAME_PREFERENCE (DEFAULT ‘L’) |
Yes |
VARCHAR2 |
Returns guest name preference. |
IN_EXTENDED_YN (DEFAULT ‘N’) |
Yes |
VARCHAR2 |
Indicates extended: yes, no. |
EXAMPLE
Vname := RESERVATION_REF.GET_NAME(1000,’L’,’N’)
Vname := RESERVATION_REF.GET_NAME(‘TOKYO’,100010,‘L’,‘N’)
Parent topic: Export APIs
Check for Existing Resort Export
EXP_GEN.EXPORTS_EXIST(IN_EXPORT_TYPE’,’IN_RESORT)
This API checks whether an export exists for a given resort.
Parameter | Required | Type | Description |
---|---|---|---|
IN_EXPORT_TYPE |
No |
VARCHAR2 |
Export type that maps to field: export_type in table exp_file_hdr. |
IN_RESORT |
Yes |
VARCHAR2 |
Resort that the export belongs to (value of the Resort column from the Resort table). |
EXAMPLE
TRX_GENERATES_EXPORT = Transaction Codes Configuration with Generate Information (Template Export).
You can use this in a formula column in export configuration, for example, (CASE WHEN exp_gen.exports_exist('TRXGEN') = 'N' THEN 'Y' ELSE FULL_REFRESH_YN END).
Parent topic: Export APIs
Get Current Business Date
PMS_P.BUSINESS_DATE
This API gets the current business date for the logged-in property.
Parameter | Required | Type | Description |
---|---|---|---|
No |
Date |
Gets logged-in property’s current business date. |
EXAMPLE
TO_CHAR(pms_p.business_date,'MM-DD-YYYY')
This example shows a formula column created to get the current business date.
Parent topic: Export APIs
Get Parameter Value Configured for Logged-in Resort
PMS_P.GET_PARAMETER(IN_PARAMETER)
Use this API to get the parameter value configured for the parameter of the logged-in resort.
Parameter | Required | Type | Description |
---|---|---|---|
IN_PARAMETER |
No |
VARCHAR2 |
OPERA parameter name |
EXAMPLE
PMS_P.GET_PARAMETER('DEFAULT_CURRENCY')
You can use this in the Pre Export Procedure field.
Parent topic: Export APIs
Get the Resort Code of the Logged-in Resort
PMS_P.RESORT
You can use this in a formula column to get the hotel code of the logged-in resort.
Parameter | Required | Type | Description |
---|---|---|---|
No |
Gets resort code. |
EXAMPLE
EXP_CREATE_DATA.get_hotel_code(pms_p.resort)
Parent topic: Export APIs
Set Business Date for a Given Session
PMS_P.SET_BUSINESS_DATE(IN_NEW_DATE)
You can use this to set the business date for a given session. The default value is SysDate (system date)
Parameter | Required | Type | Description |
---|---|---|---|
IN_NEW_DATE |
Yes |
Date |
Sets session business date. |
EXAMPLE
PMS_P.SET_BUSINESS_DATE(12-JUN-21)
Parent topic: Export APIs
Get the Property’s Date
TZ.GET_PROPERTY_DATE(IN_RESORT’,’IN_FR_DATE)
This API returns the new date-time for the given property based on Database time zone.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESORT |
Y |
VARCHAR2 |
Resort (value of RESORT column from RESORT table). |
IN_FR_DATE |
Y |
DATE |
Date that needs conversion (mostly sysdate is passed). |
EXAMPLE
tz.get_property_date(pms_p.resort, sysdate)
Parent topic: Export APIs
Get BOF Interface Code2
EXP_CREATE_BTR.GET_PROD_ID
This procedure returns the bof_code2 of an active BOF interface of the current resort.
Parameter | Required | Type | Description |
---|---|---|---|
NONE |
NA |
NA |
NA |
EXAMPLE
EXP_CREATE_BTR.GET_PROD_ID
Parent topic: Export APIs
Get Checked Out Reservations for Specified Dates
EXP_CREATE_DATA2.CHKOUT_RES_DATA
This procedure provides Information about checked out reservations between the specified start and end dates.
Parameter | Required | Type | Description |
---|---|---|---|
in_from_Date |
No |
DATE |
From Date. Defaults to pms_p.business_date -1 |
in_to_Date |
No |
DATE |
To Date. Defaults to pms_p.business_date -1 |
EXAMPLE
EXP_CREATE_DATA2.CHKOUT_RES_DATA (pms_p.business_date-1, pms_p.business_date)
Parent topic: Export APIs
Get Considered Date of a Reservations Export
EXP_GENERAL_RESV_PKG.GET_CONSIDERED_DATE
This procedure returns the From_Date of the Guests Reservations Export.
Parameter | Required | Type | Description |
---|---|---|---|
NONE |
NA |
NA |
NA |
EXAMPLE
EXP_GENERAL_RESV_PKG.GET_CONSIDERED_DATE
Parent topic: Export APIs
Get Considered Date of an Export
EXP_CREATE_DATA.GET_CONSIDERED_DATE
This procedure returns the From_Date of the export execution.
Parameter | Required | Type | Description |
---|---|---|---|
IN_Default/DATE (default null) |
No |
DATE |
Export From Date. Defaults to Null |
EXAMPLE
EXP_CREATE_DATA.GET_CONSIDERED_DATE
Parent topic: Export APIs
Get External Reference Value from Membership
EXP_CREATE_DATA.GET_EXTERNAL_REF
This procedure returns the External Reference Value of the input active Membership and External Ref Types.
Parameter | Required | Type | Description |
---|---|---|---|
IN_Resort |
YES |
VARCHAR2 |
Resort |
IN_Membership_Type |
YES |
VARCHAR2 |
Membership Type |
IN_Ref_Type |
YES |
VARCHAR2 |
Reference Type |
EXAMPLE
EXP_CREATE_DATA.GET_EXTERNAL_REF('TOKYO','VIP', 'REF1')
Parent topic: Export APIs
Get Hotel Code
EXP_CREATE_DATA.GET_HOTEL_CODE
This procedure returns the Hotel Code that corresponds to the Resort parameter, if not found than return default hotel code as in the input parameter.
Parameter | Required | Type | Description |
---|---|---|---|
in_default |
No |
VARCHAR2 |
Hotel Code. Defaults to Null |
in_resort |
No |
VARCHAR2 |
Resort. Defaults to PMS_P.RESORT |
EXAMPLE
EXP_CREATE_DATA.GET_HOTEL_CODE('EXTTOKYO',pms_p.resort)
Parent topic: Export APIs
Get Include Guests without VAT Number Indicator
EXP_GENERAL_RESV_PKG.GET_INCL_PROF
This is set with exp_country.tax_export’s parameter form "TAX1". This form has a checkbox "Include Guests without VAT Number" which when checked, the EXP_GENERAL_RESV_PKG.GET_INCL_PROF will return Y, else N.
Parameter | Required | Type | Description |
---|---|---|---|
NONE |
NA |
NA |
NA |
EXAMPLE
EXP_GENERAL_RESV_PKG.GET_INCL_PROF
Parent topic: Export APIs
Get Minimum Amount
EXP_GENERAL_RESV_PKG.GET_MIN_AMOUNT
This procedure returns the minimum amount value set for the Export.
Parameter | Required | Type | Description |
---|---|---|---|
NONE |
NA |
NA |
NA |
EXAMPLE
EXP_GENERAL_RESV_PKG.GET_MIN_AMOUNT
Parent topic: Export APIs
Get Report ID of the Export Data
EXP_CREATE_DATA.GET_LAST_REPORT_ID
This procedure returns the last report ID stored in the global variable g_report_id, that corresponds to the REPORT_TABLE data created by other functions for the data export.
Parameter | Required | Type | Description |
---|---|---|---|
NONE |
NA |
NA |
NA |
EXAMPLE
EXP_CREATE_DATA.GET_LAST_REPORT_ID
Parent topic: Export APIs
Get the Export Country
EXP_GENERAL_RESV_PKG.GET_EXP_COUNTRY
This procedure returns the export country of the Guests Reservations Export.
Parameter | Required | Type | Description |
---|---|---|---|
NONE |
NA |
NA |
NA |
EXAMPLE
EXP_GENERAL_RESV_PKG.GET_EXP_COUNTRY
Parent topic: Export APIs
Get the Export’s “From Date”
EXP_GENERAL_RESV_PKG.EXP_START_DATE
This procedure returns the Export’s start date.
Parameter | Required | Type | Description |
---|---|---|---|
NONE |
NA |
NA |
NA |
EXAMPLE
EXP_GENERAL_RESV_PKG.EXP_START_DATE
Parent topic: Export APIs
Get the Export’s “To Date”
EXP_GENERAL_RESV_PKG.EXP_END_DATE
This procedure returns the Export’s end date.
Parameter | Required | Type | Description |
---|---|---|---|
NONE |
NA |
NA |
NA |
EXAMPLE
EXP_GENERAL_RESV_PKG.EXP_END_DATE
Parent topic: Export APIs
Set the Export’s “End Date”
EXP_GENERAL_RESV_PKG.SET_EXP_END_DATE
This procedure sets the export end date to the value provided.
Parameter | Required | Type | Description |
---|---|---|---|
in_date |
Yes |
DATE |
Date |
EXAMPLE
EXP_GENERAL_RESV_PKG.SET_EXP_END_DATE(PMS_P.BUSINESS_DATE)
Parent topic: Export APIs
Initialize Buckets Summed Value
EXP_CREATE_DATA.SUM_BUCKET_INIT
This procedure is used to initialize all buckets to 0 for the input “in_max_buckets” rows.
Parameter | Required | Type | Description |
---|---|---|---|
in_max_buckets |
No |
NUMBER |
Number of Buckets. Defaults to Null |
EXAMPLE
EXP_CREATE_DATA.SUM_BUCKET_INT(10)
Parent topic: Export APIs
Initialize/Set Export Type
EXP_CREATE_DATA2.SET_EXPORT_TYPE
This procedure sets the export type to the value provided.
Parameter | Required | Type | Description |
---|---|---|---|
in_type |
Yes |
VARCHAR2 |
Export Type |
EXAMPLE
EXP_CREATE_DATA2.SET_EXPORT_TYPE(' EFOLIO ')
Parent topic: Export APIs
Set Global Data to Date
EXPORT_DATA_P.SET_DATA_TO_DATE (IN_DATA_TO_DATE)
This API sets the global data to date variable in the package with the parameter.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATA_TO_DATE Defaulted to ‘N’ |
NA |
DATE |
Sets admin context to EXPORT_END_DATE |
Parent topic: Export APIs
Set Age Credit
AR_TRX_I.SET_AGE_CREDIT
This API moves accruals to next aging bucket, prior to the night audit.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Moves accruals to next aging bucket, prior to the night audit. |
Parent topic: Export APIs
Get Parameter Method
EXPORT_DATA_P.GET_PARAMETER (IN_PARAM_CODE)
This API calls the overloaded get_parameter method with the global file id as first parameter.
Parameter | Required | Type | Description |
---|---|---|---|
IN_PARAM_CODE Defaulted to ‘N’ |
NA |
VARCHAR2 |
This function is used when file id is not available as a parameter and SET_PARAMETER sets the value. |
Parent topic: Export APIs
Get Parameter Value
EXPORT_DATA_P.GET_PARAMETER (IN_PARAM_CODE, IN_EXP_FILE_ID)
This API returns the parameter value based on the file id, and the parameter code overloaded function in the package is used to generate country-specific views for all hotels in one particular country.
Parameter | Required | Type | Description |
---|---|---|---|
IN_EXP_FILE_ID Defaulted to ‘N’ |
NA |
VARCHAR2 |
Returns the parameter value based on the file id. |
IN_PARAM_CODE Defaulted to ‘N’ |
NA |
VARCHAR2 |
This is used in extracting the value of one particular parameter in the view. |
Parent topic: Export APIs
Get External Reference
RESERVATION_REF. GET_EXTERNAL_REFERENCE (in_resort, in_resev_name_ id)
Fetches external reference for the reservation.
Parameter | Required | Type | Description |
---|---|---|---|
in_resort |
NA |
VARCHAR2, |
Returns external reference for the reservation. |
in_resev_name_ id |
NA |
NUMBER |
EXAMPLE
RESERVATION_REF.GET_EXTERNAL_REFERENCE( 'TOKYO',344597)
Parent topic: Export APIs
Set Global Variable
AR_TRX_I.SETRUNNINGFROMNA
Sets global variable gRunningFromNa.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Sets the global variable. |
Parent topic: Export APIs
Get Last Report ID
BACKLOG_BLOCKS.GET_LAST_REPORT_ID
Returns the last report ID.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Returns the last report ID. |
EXAMPLE
BACKLOG_BLOCKS.GET_LAST_REPORT_ID
Parent topic: Export APIs
Get the Number of Cached Records
EXPORT_DATA_P. GET_CACHED_NUM (in_code)
Returns the number of cached records for in_code.
Parameter | Required | Type | Description |
---|---|---|---|
IN_CODE |
NA |
VARCHAR2 |
Returns the number of cached records. |
EXAMPLE
EXPORT_DATA_P.GET_CACHED_NUM('CL')
Parent topic: Export APIs
Create Export Data for Italian ASTAT
EXP_ITALY_PKG.CREATE_ASTAT (IN_EXPORT_DATE)
Pre-procedure related to the Italian ASTAT export using export view EXP_IT_ASTAT.
Parameter | Required | Type | Description |
---|---|---|---|
IN_EXPORT_DATE Defaulted to ‘N’ |
NA |
DATE |
Creates the data required for Italian ASTAT export. |
Parent topic: Export APIs
Create Export Data for Istat Firenze
EXP_ITALY_PKG.PRE_ISTAT (IN_MODE)
Pre-procedure related to the Istat Firenze export using export view EXP_XML_BASE.
Parameter | Required | Type | Description |
---|---|---|---|
IN_MODE Defaulted to ‘N’ |
NA |
VARCHAR2 |
Creates the data required for Istat Firenze export. |
Parent topic: Export APIs
Clean Export Data for Istat Firenze
EXP_ITALY_PKG.POST_ISTAT(IN_MODE)
Post-procedure to clean up the export data for Istat Firenze export using export view EXP_XML_BASE.
Parameter | Required | Type | Description |
---|---|---|---|
IN_MODE Defaulted to ‘N’ |
NA |
VARCHAR2 |
Clean up the Istat Firenze export data. |
Parent topic: Export APIs
Create Export Data for Istat Puglia Region
EXP_ITALY_PKG.PRE_EXPORT
Pre-procedure for Istat Puglia Region export using the export view EXP_XML_BASE.
Parameter | Required | Type | Description |
---|---|---|---|
IN_MODE |
NA |
VARCHAR 1 |
Creates the data required for Istat Puglia Region export. |
IN_EXPORT_TYPE |
NA |
VARCHAR 2 |
Parent topic: Export APIs
Create Export Data for Istat Veneto Region
EXP_ITALY_PKG.PRE_ISTAT (IN_MODE)
Pre-procedure related to the Export for Istat Veneto Region using export view EXP_ITALY_ISTAT.
Parameter | Required | Type | Description |
---|---|---|---|
IN_MODE Defaulted to ‘N’ |
NA |
VARCHAR2 |
Creates the data required for export. |
Parent topic: Export APIs
Create Export Data for Vietnam Vat
EXP_GEN.SET_EXPORT_BUCKET_TYPE (IN_EXPORT_BUCKET_TYPE)
Pre-procedure related to the Vietnam Vat export using export view EXP_VIETNAM_VAT.
Parameter | Required | Type | Description |
---|---|---|---|
IN_EXPORT_BUCKET_TYPE Defaulted to ‘N’ |
NA |
VARCHAR2 |
Creates the data required for Vietnam Vat export. |
Parent topic: Export APIs
Clean Export Data for Vietnam Vat
EXPORT_DATA_P.SET_DATA_FROM_DATE (IN_DATA_FROM_DATE)
Post-procedure to clean up export data for the Vietnam Vat export using export view EXP_VIETNAM_VAT.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATA_FROM_DATE Defaulted to ‘N’ |
NA |
VARCHAR2 |
Cleans up the Vietnam Vat export data. |
Parent topic: Export APIs
Get the Commission Code for Profile
NAME_REF.GET_COMM_CODE (IN_NAME_ID - NUMBER)
This procedure returns the Commission Code for a Profile.
Parameter | Required | Type | Description |
---|---|---|---|
IN_NAME_ID - NUMBER |
NA |
NA |
Returns the Commission Code for a Profile |
EXAMPLE
NAME_REF.GET_COMM_CODE(AGENT_NAME_ID)
Parent topic: Export APIs
Get Total Available Rooms for the Property
EXP_STATISTIC_PKG. GET_TOTAL_ROOMS (IN_RESORT)
This procedure returns the total available rooms for the property.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESORT - (default to login property if not passed) |
NA |
VARCHAR2 |
Returns the total available rooms for the property. |
EXAMPLE
EXP_STATISTIC_PKG.GET_TOTAL_ROOMS
Parent topic: Export APIs
Set Trial Balance Statistics Export
EXPORT_DATA_P.SET_DATA_FROM_DATE (IN_DATA_FROM_DATE)
This pre-procedure is related to the Trial Balance Statistics export view. It creates the data used for the export.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATA_FROM_DATE (DEFAULT ’N’) |
NA |
DATE |
Pre export procedure. |
EXAMPLE
EXPORT_DATA_P.SET_DATA_FROM_DATE
Parent topic: Export APIs
Create Export Data for Austria Cash Register
EXP_AUSTRIA_DEP.CREATE_DEPEXPORT(IN_CASH_REGISTER_ID, IN_FROM_DATE, IN_TO_DATE)
This is a pre-procedure related to the Austria Cash Register export. It creates the data for export by using Export View EXP_AUSTRIA_DEP_VW.
Parameter | Required | Type | Description |
---|---|---|---|
IN_CASH_REGISTER_ID DEFAULT ‘Y’ |
Yes |
VARCHAR2 |
Indicates the IN_CASH_REGISTER_ID |
IN_FROM_DATE DEFAULT ‘Y’ |
Yes |
DATE |
Indicates beginning date range. |
IN_TO_DATE DEFAULT ‘Y’ |
Yes |
DATE |
Indicates ending date range. |
Parent topic: Export APIs
Clean Export Data for Austria Cash Register
EXP_AUSTRIA_DEP.CLEAN_DEPEXPORT
This is a post-procedure to clean the export data for Austria Cash Register export using Export View EXP_AUSTRIA_DEP_VW.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Post-procedure to clean up export data. |
Parent topic: Export APIs
Set Value Of Start Date
EXP_GEN.GET_EXP_START_DATE (EXP_GENERAL_RESV_PKG.EXP_START_DATE, PMS_P.BUSINESS_DATE)
This API is used in generating reports for transaction codes configurations. SET_EXP_START_DATE sets the value.
Parameter | Required | Type | Description |
---|---|---|---|
EXP_GENERAL_RESV_PKG.EXP_START_DATE |
NA |
DATE |
Returns the value of start date. |
PMS_P.BUSINESS_DATE |
NA |
DATE |
If it is null returns the business date. |
Parent topic: Export APIs
Set Gen Export
EXP_GEN.SET_EXPORT_BUCKET_TYPE (IN_EXPORT_BUCKET_TYPE)
This API sets the value of g_export_bucket_type.
Parameter | Required | Type | Description |
---|---|---|---|
IN_EXPORT_BUCKET_TYPE |
NA |
VARCHAR2 |
NA |
Parent topic: Export APIs
Set Export for CODENTX
EXP_GEN.SET_EXP_BUCKET_CODENTX (IN_EXPORT_BUCKET_CODE)
This API sets the global variable value of g_exp_bucket_codeNTX.
Parameter | Required | Type | Description |
---|---|---|---|
IN_EXPORT_BUCKET_CODE |
NA |
VARCHAR2 |
This procedure sets/initializes the global variable value of Bucket Code NTX for export execution. |
Example
EXP_GEN.SET_EXP_BUCKET_CODENTX('NTX123')
Parent topic: Export APIs
Set Export for CODESVC
EXP_GEN.SET_EXP_BUCKET_CODESVC (IN_EXPORT_BUCKET_CODE)
This API sets the value of exp_bucket_codeSVC.
Parameter | Required | Type | Description |
---|---|---|---|
IN_EXPORT_BUCKET_CODE |
NA |
VARCHAR2 |
This procedure sets/initializes the global variable value of Bucket Code SVC for export execution. |
Example
EXP_GEN.SET_EXP_BUCKET_CODESVC ( 'BCK123')
Parent topic: Export APIs
Get Last Report ID
EXP_STATISTIC_PKG.GET_LAST_REPORT_ID (G_REPORT_ID)
This API is used in export view to get the revenue bucket amounts by date,
Parameter | Required | Type | Description |
---|---|---|---|
G_REPORT_ID |
NA |
NUMBER |
Returns value of g_report_id. g_report_id is populated from the value v_report id while creating the report and set to null while deleting the report. |
Parent topic: Export APIs
Get Next Export Sequence
OPERA_SEQ.GET_NEXTCOUNTRYEXPORTSEQNO (IN_COUNTRY_CODE, IN_RESORT)
This API is used to get the next country export sequence.
Parameter | Required | Type | Description |
---|---|---|---|
IN_COUNTRY_CODE |
NA |
VARCHAR2 |
Returns the next export sequence in format "EXPORT_" appended with country code and resort code. |
IN_RESORT |
NA |
VARCHAR2 |
Parent topic: Export APIs
Get Export Value
EXP_MAPPING_API.GET_EXPORT_VALUE (IN_MAPPING_TYPE, IN_MAPPING_CODE, IN_LINKED_CODE, IN_CONFIG_TYPE, IN ESORT)
This API is used in generating views data about paidouts, payments, receivers, issuers and revenue details of Sales Documents.
Parameter | Required | Type | Description |
---|---|---|---|
IN_MAPPING_TYPE DEFAULT ‘N’ |
NA |
VARCHAR2 |
Get export value of a linked code using EXP_MAPPING_ID, MAPPING_CODE and LINKED_CODE. This method is used to get value of export type of a particular string. |
IN_MAPPING_CODE DEFAULT ‘N’ |
NA |
NA |
|
IN_LINKED_CODE DEFAULT ‘N’ |
NA |
NA |
|
IN_CONFIG_TYPE DEFAULT ‘Y’ |
NA |
NA |
|
IN_RESORT DEFAULT ‘Y’ |
NA |
NA |
Parent topic: Export APIs
Get Property Codes
EXP_MAPPING_API.GET_PROPERTYCODES_TYPE (C_PROPERTY_CODES_TYPE)
This API returns c_property_codes_type which is a constant String of value " PROPERTY_CODES' that is used in generating views data about paidouts, payments, receivers, issuers and revenue details of Sales Documents.
Parameter | Required | Type | Description |
---|---|---|---|
C_PROPERTY_CODES_TYPE |
NA |
VARCHAR2 |
Returns value of c_property_codes_type variable. |
Parent topic: Export APIs
Get Next Invoice
OPERA_SEQ.GET_NEXTITEINVOICE (IN_RESORT)
This API is used to increment sequence value.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESORT (DEFAULT ’Y’) |
NA |
VARCHAR2 |
Returns an incremented sequence value categorized resort-wise as the invoice number. The invoice number can be alphanumeric in number. |
Parent topic: Export APIs
Get C Operating Unit
TRANCODE_DU.GET_C_OPERATING_UNIT (C_OPERATINGUNIT)
In this API, "OPERATING_UNIT" which is a constant string of value returns the value of variable c_operatingunit.,
Parameter | Required | Type | Description |
---|---|---|---|
C_OPERATINGUNIT |
NA |
VARCHAR2 |
Returns the value of variable c_operatingunit, |
Parent topic: Export APIs
Get Property Primary Code
TRANCODE_DU.GET_PROPERTY_PRIMARY_CODE (IN_RESORT, IN_CORPORATE_INFO_TYPE)
This API function returns the primary code of property.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESORT DEFAULT ‘Y’ |
NA |
VARCHAR2 |
Returns the primary code of property from based on resort and corporate information. |
IN_CORPORATE_INFO_TYPE DEFAULT ‘N’ |
NA |
VARCHAR2 |
Parent topic: Export APIs
Clean Export Data for Italy
EXP_COUNTRY_IT.POST_SPESOMETRO
You can use this API to clean up export data for Italy export.
Parameter | Required | Type | Description |
---|---|---|---|
No parameters |
NA |
NA |
Post-procedure to clean up export data for Italy export |
EXAMPLE
EXP_COUNTRY_IT.POST_SPESOMETRO ();Parent topic: Export APIs
Create Export Data for Italy
EXP_COUNTRY_IT.PRE_SPESOMETRO (IN_DATE_FROM, IN_DATE_TO)
You can use this API to create the JPK data required for the export.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATE_FROM |
Y |
DATE |
Procedure to create JPK export for Poland. |
IN_DATE_TO |
Y |
DATE |
EXAMPLE
EXP_COUNTRY_IT.PRE_SPESOMETRO ( '10052022','30052022');
Parent topic: Export APIs
Create JPK Export for Poland
EXP_COUNTRY_PL.CREATE_JPK_EXPORT (IN_DATE_FROM, IN_DATE_TO)
You can use this API create JPK export for Poland.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATE_FROM |
Y |
DATE |
Pre-procedure related to Italy export. Creates the data required for the export. |
IN_DATE_TO |
Y |
DATE |
EXAMPLE
EXP_COUNTRY_PL.CREATE_JPK_EXPORT ( '10052022','30052022');
Parent topic: Export APIs
Clean JPK Export for Poland
EXP_COUNTRY_PL.POST_JPK_EXPORT();
You can use this API to clean up JPK export data for Poland export.
Parameter | Required | Type | Description |
---|---|---|---|
No parameters |
NA |
NA |
Post-procedure to clean up export data for Poland export. |
EXAMPLE
EXP_COUNTRY_PL. POST_JPK_EXPORT();Parent topic: Export APIs
Create SAFT Export for Portugal
EXP_COUNTRY_PT.CREATE_SAFT_EXPORT (IN_FROM_DATE, IN_DATE_TO)
You can use this API to create SAFT export for Portugal.
Parameter | Required | Type | Description |
---|---|---|---|
IN_FROM_DATE |
Y |
DATE |
Procedure to create SAFT export for Portugal. |
IN_DATE_TO |
Y |
DATE |
EXAMPLE
EXP_COUNTRY_PT.CREATE_SAFT_EXPORT ( '10052022','30052022');Parent topic: Export APIs
Clean SAFT Export for Portugal
EXP_COUNTRY_PT.POST_SAFT_EXPORT
You can use this API to clean up export data for the Portugal SAFT.
Parameter | Required | Type | Description |
---|---|---|---|
No parameters |
NA |
NA |
Post-procedure to clean up export data for the Portugal SAFT export. |
EXAMPLE
EXP_COUNTRY_PT.POST_SAFT_EXPORT();Parent topic: Export APIs
Create Export Data for France
EXP_CREATE_FR_ARCHIVE.CREATE_EXPORT (IN_RESORT, IN_DATE)
You can use this API to create export for France.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESORT |
Y |
VARCHAR2 |
Procedure to create export for France. |
IN_DATE |
Y |
DATE |
EXAMPLE
EXP_CREATE_FR_ARCH IVE.CREATE_EXPORT ('LUCY', '12092020');Parent topic: Export APIs
Clean Export Data for France
EXP_CREATE_FR_ARCHIVE.POST_EXPORT
You can use this API to clean up export data for France export.
Parameter | Required | Type | Description |
---|---|---|---|
No parameters |
NA |
NA |
Post-procedure to clean up export data for France export. |
EXAMPLE
EXP_CREATE_FR_ARCHIVE.POST_EXPORT();Parent topic: Export APIs
Create Export for India
EXP_HSN_OUTSTANDING.CREATE_EXPORT (IN_RESORT, IN_DATE)
You can use this procedure to create export for India.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESORT |
Y |
VARCHAR2 |
Procedure to create export for India. |
IN_DATE |
Y |
DATE |
EXAMPLE
EXP_HSN_OUTSTANDING.CREATE_EXPORT('LUCY', '12092020');
Parent topic: Export APIs
Get the Version Information
EXP_CREATE_IT_EINVOICE.GET_VERSIONE_ATTRIB
You can use this API will return the version information.
Parameter | Required | Type | Description |
---|---|---|---|
No Parameters |
NA |
NA |
The function will return the version information. |
EXAMPLE
EXP_CREATE_IT_EINVOICE.GET_VERSIONE_ATTRIB();
Parent topic: Export APIs
Get Total Count of Records for ALL
EXP_ITALY_PKG.TOTRECORDS (IN_DATE)
You can use this API will return the total count of records for export_type='ALL' and business date combination.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATE |
N |
DATE |
The function will return the total count of records for export_type='ALL' and business date combination |
EXAMPLE
EXP_ITALY_PKG.TOTRECORDS('12092020');
Parent topic: Export APIs
Get Total Count of Records for TMP
EXP_ITALY_PKG.TOTRECORDSISTAT (IN_DATE IN_EXPORT_TYPE)
You can use this API will return the total count of records for export_type='TMP' and business date combination.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATE |
N |
DATE |
The function will return the total count of records for export_type='TMP' and business date combination. |
IN_EXPORT_TYPE |
N |
VARCHAR2 |
EXAMPLE
EXP_ITALY_PKG.TOTRECORDSISTAT('12092020','TMP');
Parent topic: Export APIs
Get Number Of Rooms Reserved
EXP_ITALY_PKG.GET_ROOMS_BY_RESV (IN_TIPPO_ALLOGGIATO, IN_RESV_NAME_ID, IN_ALLOTMENT_HEADER_ID)
You can use this API will return the total number of rooms reserved.
Parameter | Required | Type | Description |
---|---|---|---|
IN_TIPPO_ALLOGGIATO |
N |
VARCHAR2 |
The function will return the total number of reserved rooms. |
IN_RESV_NAME_ID |
N |
NUMBER |
|
IN_ALLOTMENT_HEADER_ID |
N |
NUMBER |
EXAMPLE
EXP_ITALY_PKG.GET_ROOMS_BY_RESV( '16', 100, 1988 );
-
16 OSPITE SINGOLO
-
17 CAPOFAMIGLIA
-
18 CAPOGRUPPO
-
19 FAMILIARE
-
20 MEMBRO GRUPPO
Parent topic: Export APIs
Get Province
EXP_ITALY_PKG.GET_PROVINCE (IN_CITY)
You can use this API to get the province.
Parameter | Required | Type | Description |
---|---|---|---|
IN_CITY |
N |
VARCHAR2 |
The function will return the province. |
EXAMPLE
EXP_ITALY_PKG.GET_PROVINCE('HYD');
Parent topic: Export APIs
Get Country ID
EXP_ITALY_PKG.GET_COUNTRY_ID (IN_COUNTRY_CODE)
You can use this API to get the Country ID.
Parameter | Required | Type | Description |
---|---|---|---|
IN_COUNTRY_CODE |
N |
VARCHAR2 |
The function will return the Country ID. |
EXAMPLE
EXP_ITALY_PKG.GET_COUNTRY_ID('PT');
Parent topic: Export APIs
Get City ID
EXP_ITALY_PKG.GET_CITY_ID (IN_CITY)
You can use this API to get the City ID.
Parameter | Required | Type | Description |
---|---|---|---|
IN_CITY |
N |
VARCHAR2 |
The function will return the City ID. |
EXAMPLE
EXP_ITALY_PKG.GET_CITY_ID('HYD');
Parent topic: Export APIs
Get Rooms By Date
EXP_ITALY_PKG.GET_AVL_ROOMSBYDATE (IN_DATE)
You can use this API to get the number of available rooms on a particular date.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATE |
N |
VARCHAR2 |
The function will return the number of available rooms on a particular date. |
EXAMPLE
EXP_ITALY_PKG.GET_AVL_ROOMSBYDATE('12092020');
Parent topic: Export APIs
Get Physical Inventory
EXP_ITALY_PKG.GET_AVL_ROOMS
You can use this API to get the physical inventory.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
This function will fetch the physical inventory. |
EXAMPLE
EXP_ITALY_PKG.GET_AVL_ROOMS();
Parent topic: Export APIs
Get Available Beds
EXP_ITALY_PKG.GET_AVL_BEDS
You can use this API to get the physical inventory.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
This function will return the total number of available beds. |
EXAMPLE
EXP_ITALY_PKG.GET_AVL_BEDS();
Parent topic: Export APIs
Get Last Reservation ID
EXP_ITALY_PKG.GETLASTRESVID
You can use this API to get the last Reservation ID.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
This function will return the Last Reservation ID. |
EXAMPLE
EXP_ITALY_PKG.GETLASTRESVID();
Parent topic: Export APIs
Get Last Group
EXP_ITALY_PKG.GETLASTGROUP
You can use this API to get the Last Group.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
This function will return the Last Group. |
EXAMPLE
EXP_ITALY_PKG.GETLASTGROUP();
Parent topic: Export APIs
Get Name ID
EXP_ITALY_PKG.GETNAMEID (IN_RESV_NAME_ID, IN_NAME_ID, IN_UDFSEARCH)
You can use this API to get the Name ID.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESV_NAME_ID |
N |
NUMBER |
This function will return the Name ID. |
IN_NAME_ID |
N |
NUMBER |
|
IN_UDFSEARCH |
N |
VARCHAR2 |
EXAMPLE
EXP_ITALY_PKG.GETNAMEID(100, 344, 'TEST' );
Parent topic: Export APIs
Get Membership Level
EXP_CREATE_DATA.GET_MEMBER_LEVEL (IN_RESV_NAME_ID, IN_MEMBERSHIP_TYPE, IN_MEMBERSHIP_NO, IN_RESORT)
You can use this API to get Get membership level based on the reservation name id, member type, member number.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESV_NAME_ID |
NA |
NUMBER |
Get membership level based on the reservation name id, member type, member number |
IN_MEMBERSHIP_TYPE |
NA |
VARCHAR2 |
|
IN_MEMBERSHIP_NO |
NA |
VARCHAR2 |
|
IN_RESORT |
NA |
VARCHAR2 |
EXAMPLE
EXP_CREATE_DATA.GET_MEMBER_LEVEL(RESV_NAME_ID, LOYALTY_MEMBER_TYPE, LOYALTY_MEMBER_NO, PMS_P.RESORT)
Parent topic: Export APIs
Get Commission Code For Rate Code
EXP_CREATE_DATA.RATE_COMM_CODE (IN_RATE_CODE, IN_RESORT)
You can use this API to get the commission code for rate code.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RATE_CODE |
NA |
VARCHAR2 |
Get commission code for rate code |
IN_RESORT |
NA |
VARCHAR2 |
EXAMPLE
-
EXP_CREATE_DATA.RATE_COMM_CODE(RATE_CODE)
Parent topic: Export APIs
Get Profile Info
EXP_CREATE_DATA.GET_PROF_INFO (N_NAME_ID, IN_COLUMN, IN_RESORT)
You can use this API to fetch the specific values of a profile.
Parameter | Required | Type | Description |
---|---|---|---|
N_NAME_ID |
NA |
NUMBER |
Get value in column specified from name_view for name_id specified. So in this example function will get IATA_CORP_NO for profile. |
IN_COLUMN |
NA |
VARCHAR2 |
Get value in column specified from name_view for name_id specified. So in this example function will fetch the 'Display Name' (Last and First) of profile. |
IN_RESORT |
NA |
VARCHAR2 |
Get value in column specified from name_view for name_id specified. So in this example function will fetch "Currency code" column value for profile. |
EXAMPLE
-
EXP_COUNTRY_PL.CREATE_JPK_EXPORT ( '10052022','30052022')
-
EXP_CREATE_DATA.GET_PROF_INFO(RESV_CONTACT_ID,'DISPLAY_NAME')
-
EXP_CREATE_DATA.GET_PROF_INFO(AGENT_NAME_ID,'CURRENCY_CODE')
Parent topic: Export APIs
Fix Characters
EXP_ITALY_PKG.FIXCHAR (IN_STRING)
You can use this API to replace the characters.
Parameter | Required | Type | Description |
---|---|---|---|
IN_STRING |
NA |
VARCHAR2 |
This function will replace Unicode characters with substitution characters. |
EXAMPLE
EXP_ITALY_PKG.FIXCHAR('ó');
Parent topic: Export APIs
Get the Country Description
NAME_REF.GET_COUNTRY_NAME (in_name_id)
This API helps you to get the country description for the profile.
Parameter | Required | Type | Description |
---|---|---|---|
IN_NAME_ID |
Y |
Number |
Gets the Country description for the profile. |
EXAMPLE
NAME_REF.GET_COUNTRY_NAME(AGENT_NAME_ID)
Parent topic: Export APIs
Get State Description
NAME_REF.GET_STATE_NAME (in_name_id - number)
This API helps you to get the state description for the profile.
Parameter | Required | Type | Description |
---|---|---|---|
IN_NAME_ID - NUMBER |
Y |
Number |
Gets the State description for the profile. |
EXAMPLE
NAME_REF.GET_STATE_NAME(AGENT_NAME_ID)
Parent topic: Export APIs
Get Out of Service Room Count
CTR_PANEL_PKG.OSROOMS (IN_RESORT, CONSIDERED_DATE, PMS_P.RESORT)
This API Returns Out of Service room count.
Parameter | Required | Type | Description |
---|---|---|---|
CONSIDERED_DATE |
NA |
DATE |
Returns Out of Service room count based on input data considered and Resort |
IN_RESORT |
NA |
VARCHAR2 |
|
PMS_P.RESORT |
NA |
DEFAULT |
EXAMPLE
CTR_PANEL_PKG.OSROOMS (PMS_P.BUSINESS_DATE,'PROP1')
Parent topic: Export APIs
Get Out of Order Room Count
CTR_PANEL_PKG.OOROOMS (in_resort, considered_date)
This API Returns Out of Order room count.
Parameter | Required | Type | Description |
---|---|---|---|
considered_date |
NA |
DATE |
Returns Out of Order room count based on input data considered and Resort |
in_resort DEFAULT pms_p.resort |
NA |
VARCHAR2 |
EXAMPLE
CTR_PANEL_PKG.OSROOMS (PMS_P.BUSINESS_DATE,'PROP1')
Parent topic: Export APIs
Get Bill Generation Date
FIN_TRAN_VIEW_REF.GET_BILL_GENERATION_DATE (IN_RESV_NAME_ID, IN_BILL_NO, IN_FOLIO_TYPE, IN_RESORT)
This function will Returns Bill Generation Date value.
Parameter | Required | Type | Description |
---|---|---|---|
IN_RESV_NAME_ID |
NUMBER |
Returns Bill Generation Date value based on input bill number/Folio Type/Reservation Id and Resort values. |
|
IN_BILL_NO |
NUMBER |
||
IN_FOLIO_TYPE |
VARCHAR2 |
||
IN_RESORT |
VARCHAR2 |
EXAMPLE
FIN_TRAN_VIEW_REF.GET_BILL_GENERATION_DATE (4352412,678,'DEBIT','PROP1');)
Parent topic: Export APIs
Get Export Considered Run Date
EXP_STAYSTYPE_PKG.GET_CONSIDERED_DATE
This function will returns export considered Run Date.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NUMBER |
Returns Export considered Run Date ( Considered Date). |
EXAMPLE
EXP_STAYSTYPE_PKG.GET_CONSIDERED_DATE
Parent topic: Export APIs
Determine Value Type
GEN_UTIL.VALUE_IS_NUMERIC_YN (IN_VALUE )
This function will determine if a given value is numeric(Y) or alpha(N).
Parameter | Required | Type | Description |
---|---|---|---|
IN_VALUE |
Yes |
VARCHAR2 |
Determines the if a given function value is numeric(Y) or alpha(N). |
EXAMPLE
GEN_UTIL.VALUE_IS_NUMERIC_YN('ABCDEF');
Parent topic: Export APIs
Convert Business Date
OPERA_FUNC.CONVERT_FROM_BUSINESS_DATE (IN_BUSINESS_DATE, IN_RESORT, PMS_P.RESORT)
Returns the inserted date for a given business date.
Parameter | Required | Type | Description |
---|---|---|---|
IN_BUSINESS_DATE |
NA |
DATE |
This function will return the insert date for a given business date. |
IN_RESORT |
NA |
VARCHAR2 |
|
PMS_P.RESORT |
NA |
DEFAULT |
EXAMPLE
OPERA_FUNC.CONVERT_FROM_BUSINESS_DATE(PMS_P.BUSINESS_DATE, 'PROP1' );
Parent topic: Export APIs
Get Payment Methods
EXP_MAPPING_API.GET_PAYMENT_METHODS_TYPE
This API will return the export payment method type.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NUMBER |
Returns a constant value payment methods. |
EXAMPLE
EXP_MAPPING_API.GET_PAYMENT_METHODS_TYPE;
Parent topic: Export APIs
Get New Time
TZ.GET_NEW_TIME (IN_FR_DATE, IN_FR_TZ_REGION, IN_TO_TZ_REGION)
You can use this API to get the new date-time.
Parameter | Required | Type | Description |
---|---|---|---|
IN_FR_DATE |
N |
DATE |
This function will return the new date-time for the given date-time based on from and to_time zone. |
IN_FR_TZ_REGION |
N |
VARCHAR2 |
|
IN_TO_TZ_REGION |
N |
VARCHAR2 |
EXAMPLE
TZ.GET_NEW_TIME(SYSDATE,'+00:00','GMT');
Parent topic: Export APIs
Get Property Currency
PMS_P.CURRENCY
You can use this API to currency of a particular country.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
The function will return the property currency. |
EXAMPLE
PMS_P.CURRENCY. For example, Australia/Brisbane.
Parent topic: Export APIs
Get Property Language
PMS_P.LANGUAGE
You can use this API to language of a particular property.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
The function will return the property language. |
EXAMPLE
PMS_P.LANGUAGE. For example, ES.
Parent topic: Export APIs
Get Timezone
PMS_P.TIMEZONE_REGION
You can use this API to get time zone of a particular property.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
The function will return the property time zone. |
EXAMPLE
PMS_P.TIMEZONE_REGION; for example, Australia/Brisbane.
Parent topic: Export APIs
Search Entity Detail Translation
SC_TRANSLATION.ENTITY_DETAIL_TRANSLATION (IN_CODE_TYPE, IN_LANG, IN_CODE, IN_RESORT)
You can use this API to search for a translation for a description of entity detail table on the description translation table.
Parameter | Required | Type | Description |
---|---|---|---|
IN_CODE_TYPE |
NA |
VARCHAR2 |
This functions searches for a translation for a 'DESCRIPTION' of entity_detail table on the desc_translation table. If not found returns the english version. |
IN_LANG |
NA |
VARCHAR2 |
|
IN_CODE |
NA |
VARCHAR2 |
|
IN_RESORT |
NA |
VARCHAR2 |
EXAMPLE
SC_TRANSLATION.ENTITY_DETAIL_TRANSLATION ('MARKET_CODE', 'DE','CORI','TOKYO');
Parent topic: Export APIs
Set Bucket Code Type
EXP_GEN.SET_EXPORT_BUCKET_TYPE
This API sets the global variable value of Bucket Code Type.
Parameter | Required | Type | Description |
---|---|---|---|
IN_EXPORT_BUCKET_TYPE |
NA |
VARCHAR2 |
This procedure sets/initializes the global variable value of Bucket Code Type for export execution. |
Example
EXP_GEN.SET_EXPORT_BUCKET_TYPE('BCKTY123')
Parent topic: Export APIs
Get Export Start Date
EXP_GEN.GET_EXP_START_DATE
This API returns the start date of a particular export.
Parameter | Required | Type | Description |
---|---|---|---|
N/A |
NA |
NA |
Returns Export Start Date. Defaults to Business Date when not set by Export execution. |
Example
EXP_GEN.GET_EXP_START_DATE
Parent topic: Export APIs
Get Availability
CTR_PANEL_PKG.GET_AVAILABILITY (CONSIDEREDDATE)
This API returns the Inventory Availability based on input data.
Parameter | Required | Type | Description |
---|---|---|---|
CONSIDEREDDATE |
NA |
DATE |
Returns Inventory Availability based on input data considered and Resort. |
Example
CTR_PANEL_PKG.GET_AVAILABILITY (PMS_P.BUSINESS_DATE)
Parent topic: Export APIs
Get COMM End Date
COMM_PMNT_EXP_API.GET_COMM_END_DT
This API returns COMM End Date set for the export execution.
Parameter | Required | Type | Description |
---|---|---|---|
N/A |
NA |
N/A |
Returns COMM End Date set for the export execution. |
Example
COMM_PMNT_EXP_API.GET_COMM_END_DT
Parent topic: Export APIs
Get COMM Check Number
COMM_PMNT_EXP_API.GET_COMM_CHECK_NO
This API returns COMM check number.
Parameter | Required | Type | Description |
---|---|---|---|
N/A |
NA |
N/A |
Returns COMM Check No set for the export execution. |
Example
COMM_PMNT_EXP_API.GET_COMM_CHECK_NO
Parent topic: Export APIs
Get COMM Begin Date
COMM_PMNT_EXP_API.GET_COMM_BEGIN_DT
This API returns COMM begin date.
Parameter | Required | Type | Description |
---|---|---|---|
N/A |
NA |
N/A |
Returns COMM Begin Date set for the export execution. |
Example
COMM_PMNT_EXP_API.GET_COMM_BEGIN_DT
Parent topic: Export APIs
Get COMM Agent ID
COMM_PMNT_EXP_API.GET_COMM_AGNT_ID
This API returns COMM Agent ID.
Parameter | Required | Type | Description |
---|---|---|---|
N/A |
NA |
N/A |
Returns COMM Begin Date set for the export execution. |
Example
COMM_PMNT_EXP_API.GET_COMM_BEGIN_DT
Parent topic: Export APIs
Get COMM Account ID
COMM_PMNT_EXP_API.GET_COMM_ACNT_ID
This API returns COMM Account ID.
Parameter | Required | Type | Description |
---|---|---|---|
N/A |
NA |
N/A |
Returns COMM Account Id set for the export execution. |
Example
COMM_PMNT_EXP_API.GET_COMM_ACNT_ID
Parent topic: Export APIs
Set Data To Date
EXPORT_DATA_P.SET_DATA_TO_DATE
This API helps you to set to date.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATA_TO_DATE |
NA |
DATE |
Sets TO_DATE for export execution. |
EXPORT_DATA_P.SET_DATA_TO_DATE(pms_p.business_date);
Parent topic: Export APIs
Get All Export Values
EXP_MAPPING_API.GET_ALL_EXPORT_VALUES (IN_MAPPING_TYPE, IN_LINKED_CODE, IN_DELIMITER, IN_RESORT, IN_CONFI_TYPE)
This API returns all export values of a code.
Parameter | Required | Type | Description |
---|---|---|---|
IN_MAPPING_TYPE |
NA |
VARCHAR2 |
Returns all export values of a code linked to in_mapping_type, delimited with in_delimiter; Sequence is determined by SEQ_NO, EXP_MAPPING_CODE of the mapping codes belonging to that mapping type. |
IN_LINKED_CODE |
NA |
VARCHAR2 |
|
IN_DELIMITER |
NA |
VARCHAR2 |
|
IN_RESORT |
NA |
VARCHAR2 |
|
IN_CONFIG_TYPE |
NA |
VARCHAR2 |
EXAMPLE
EXP_MAPPING_API.GET_ALL_EXPORT_VALUES ('E_INVOICE_ITA','CIT','/'','CITALY','PROPERTY_CODES');
Parent topic: Export APIs
Get Filename Format
SC_EXPORTS.GET_FILE_NAME_FORMAT
You can use this API to get the filename format for exports based on Resort Name and Business Date.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
This function returns filename format for exports based on Resort Name and Business Date. |
EXAMPLE
SC_EXPORTS.GET_FILE_NAME_FORMAT;
For example, returns ROSA_D21339 when Resort = 'ROSIE' and Business_Date = 05-DEC-21
Parent topic: Export APIs
Set Data From Date
EXPORT_DATA_P.SET_DATA_FROM_DATE
This API helps you to set data from date.
Parameter | Required | Type | Description |
---|---|---|---|
IN_DATA_FROM_DATE |
NA |
DATE |
Sets FROM_DATE for export execution. |
EXPORT_DATA_P.SET_DATA_FROM_DATE(pms_p.business_date-1);
Parent topic: Export APIs
Get Date Iteration
EXPORT_DATA_P.GET_DATE_ITERATION
You can use this API to get the date iteration number.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Returns date iteration number. |
EXAMPLE
EXPORT_DATA_P.GET_DATE_ITERATION
Parent topic: Export APIs
Get Export Data ID
EXPORT_DATA_P.GET_EXP_DATA_ID
You can use this API to get the Export Data Id.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Returns Export Data Id from current session. |
EXAMPLE
EXPORT_DATA_P.GET_EXP_DATA_ID;
Parent topic: Export APIs
Get Export Mode
EXPORT_DATA_P.GET_EXPORT_MODE
You can use this API to get the Export Mode.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Returns Export running mode. |
EXAMPLE
EXPORT_DATA_P.GET_EXPORT_MODE
Parent topic: Export APIs
Get ISO Language Code
EXPORT_DATA_P.GET_ISO_LANG_CODE (IN_LANGUAGE_CODE)
You can use this API to get the ISO Language Code.
Parameter | Required | Type | Description |
---|---|---|---|
IN_LANGUAGE_CODE |
NA |
VARCHAR2 |
Returns ISO Language Code for the input language code. |
EXAMPLE
GET_ISO_LANG_CODE('EN');
Parent topic: Export APIs
Get Data to Folio
EXPORT_DATA_P.GET_DATA_TO_FOLIO
You can use this API to get the folio value.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Returns To Folio value. |
EXAMPLE
EXPORT_DATA_P.GET_DATA_TO_FOLIO
Parent topic: Export APIs
Get Data From Folio
EXPORT_DATA_P.GET_DATA_FROM_FOLIO
You can use this API to get the from folio value.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Returns From Folio Value. |
EXAMPLE
EXPORT_DATA_P.GET_DATA_FROM_FOLIO
Parent topic: Export APIs
Get Cash Register ID
EXPORT_DATA_P.GET_CASHREG_ID
You can use this API to get the cash register Id.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Returns Cash Register ID. |
EXAMPLE
EXPORT_DATA_P.GET_CASHREG_ID
Parent topic: Export APIs
Get ISO Date Format
BUSINESS_EVENT_EXT.GETISODATEFORMAT
This API returns the ISO date format.
Parameter | Required | Type | Description |
---|---|---|---|
N/A |
NA |
N/A |
Returns date format 'YYYY-MM-DD'. |
Example
BUSINESS_EVENT_EXT.GETISODATEFORMAT
Parent topic: Export APIs
Get District Code
CALCULATE_FORECAST.GET_DISTRICT
This API returns the District Code.
Parameter | Required | Type | Description |
---|---|---|---|
IN_COUNTRY_CODE |
NA |
VARCHAR2 |
Returns District Code based on input Country,Postal and City codes. |
IN_POSTAL_CODE |
NA |
VARCHAR2 |
|
IN_CITY |
NA |
VARCHAR2 |
Example
CALCULATE_FORECAST.GET_DISTRICT ('IN','560068',''HYD')
Parent topic: Export APIs
Get Data From Date
EXPORT_DATA_P.GET_DATA_FROM_DATE
You can use this API to get the from date value.
Parameter | Required | Type | Description |
---|---|---|---|
NA |
NA |
NA |
Returns From Date value. |
EXAMPLE
EXPORT_DATA_P.GET_DATA_FROM_DATE
Parent topic: Export APIs