Command Line Export

As an alternative to using the export screens, you can also invoke exports programmatically using the command line export utility. This functionality allows you to invoke each export without accessing the Unanet system application via the user interface. This may be useful if you would like to create your own process external to Unanet that could export data from Unanet and programmatically trigger another downstream process (without manual intervention) -- e.g. a nightly feed.

Introduction

The command-line export program is designed to allow you to execute any of the exports using a command-line interface. This program may be run either from the server running Unanet, of from a different computer that has standard TCP/IP access to the port (usually 80) on the Unanet server that is used to access Unanet. Basically, if you can access Unanet using a browser from a particular machine, then you can use the command-line export program from that machine.

The command-line export program is located in the unanet/utilities directory, and is named Export.jar. To run the program, simply make the directory containing the Export.jar file your current directory and type:

This will simply give you a help message, since it doesn't include all the required elements.

Requirements

You must have Java 1.8 or higher installed on the server invoking the command-line export program.

Syntax and Options

--url url

The base URL for the Unanet application. For example: http://www.yourdomain.com/unanet. This option is required.

--username username

A Unanet administrator login username. This option is required.

--password password

The password for the login username used. This option is required.

--file file

If specified, the name of the file that will contain the output of the template. It can be a fully qualified file name or a relative file (to the current directory). The file will only contain output from the export. All errors and other output will be written to standard err/out as appropriate. If a file is not specified, the output will be written to standard out.

--checkVersion

Causes the export.jar to initiate a communication with the specified unanet servlet and verify that the two are compatible. If any incompatibilities are found, the appropriate message will be displayed and an error code (2) will be returned.

--criteria saved_criteria

Specifies the name of the saved export criteria to use when running the export.

--quiet

Causes ONLY results from the export to be displayed to standard out. Criteria, Sql and other output will be suppressed. Any errors encountered will still be reported.

--template template_name

Specifies the name of an export template you wish to use. This will dictate the type of export that will run (Time, Expense, Project, etc.). This option is required.

--version

When using this option, the export will return a version number of the export.jar file. This is used internally for compatibility checking only.

--option var=value

Allows additional options to be provided to the export process. You may specify multiple options. If you are interested in supplying several values for the same option you will need to include separate option entries for each. For example, if passing in 2 users to export on the person export (having person keys of 100 and 101), you would include:

--option person=100
--option person=101

Note that rather than passing in these individual items, you may instead want to manually configure a selection criteria page, save the criteria and use the saved criteria instead.

Note that the default values used when specific options are not provided will match the default values that the user interface supplies (for each export type).

The options that are available vary by template type. See which options are available for each type of export below:

Generally Available for all Types

Employee Type Expense Type

Employee Type Pay Code

Expense

Expense Budget

Expense Plan

Expense Type - Master

Expense Type - Project

Fixed Price Item
General Ledger

General Ledger Journal Entry

Journal Entry

Labor Category - Master

Labor Category - Project

Organization Contact
Organization Contact Address
Organization Contact Email
Organization Contact Phone

Project Administrators

Project Fee

Project Invoice Setup

Syntax Example

c:\unanet\utilities> java -jar Export.jar --url http://yourco.com:8080/unanet --username admin --password test --template "Approval Group"

C:\unanet\utilities> java -jar Export.jar --url http://yourco.com:8080/unanet --username admin --password admin --template "Approval Group" --file myoutput.txt > c:\yourdirectory\export_output.txt 2>&1

Reading The Output

There are several sections of output which may come from the command line export depending on the options that the user specifies.

This section will have the export.jar version as well as the Unanet server version that the client is connecting to, along with the results of the compatibility check. This section will be written to stdout and will be omitted if the --quiet option is specified.

This section will display the SQL query that was used by the export including the criteria values were applicable. This section will be written to stdout and will be omitted if the --quiet option is specified.

This section will display the run date and time along with ALL criteria used during the run. This not only includes the visible criteria that the user would see on the selection criteria page, but ALL criteria including the hidden elements, keys, etc. It will be very handy for use in trouble-shooting. This section will be written to stdout and will be omitted if the --quiet option is specified.

This section will display the output of the export. In the event that the user specified the --file option, this section will only contain the filename to which the output will be written.

This section will only be displayed in the event of an error. Errors not only include critical things like "no Export.jar found", but also any unexpected conditions from the actual export OR any "!HALT!" messages (see export expressions for more information on the !HALT! expression). This section will be written to stderr and cannot be suppressed.

2 - if the checkVersion option was called and the version check showed an incompatibility.

6 - if the username or password was not accepted by the server OR the authentication cookie

StdErr and StdOut can be captured to a file for further interrogation. Depending on your operating system syntax, one possible example may be:

You will likely have some sort of shell script or batch file that runs your unattended export. Within this script you may want to email the resulting output to someone for manual review, or possibly create a process that will parse the output searching for an error condition. Upon receiving such a condition, you may wish to notify someone via email or some other means. The creation and maintenance of these types of processes are external to Unanet and are the responsibility of your IT staff.

Unanet has a stand-alone utility that can assist with the management of the outbound exports. Check out the Integration Management Utility (IMU) for additional information.

********************************************************************************

Running The Command Line Export from Another Machine

You must have a copy of the Export.jar file on the machine from which you will run the command-line export program (or have access to that file from the machine you are running from). This file is delivered with the Unanet software and resides in the "unanet/utilities" directory and is also available for download from the Support area on our web-site.

Also, you must have Java 1.8 or higher installed on the machine. You can obtain Java from Oracle following the links for "Java SE Downloads" (note: download the JDK latest update -- not the JRE).

Note: You must use the copy of the Export.jar file packaged with each release. When migrating from one major release to the next major release, you'll need to make sure you copy the new Export.jar file to your remote machine.

If you encounter a java "OutofMemoryError", you should check your memory setting on the server running Unanet (see Performance Tuning for more information), but you may also need to increase the memory on the machine running the command line export. To do this, you can include a memory setting directly within the command line you are running by including the following syntax "java –Xms128m –Xmx512m" in front of the rest of the command line parameters. Thus your complete command line syntax may resemble:

C:\unanet\utilities> java –Xms128m –Xmx512m -jar Export.jar --url http://yourco.com:8080/unanet --username admin --password admin --template "Approval Group"

Using SSL

If using SSL and attempting to run the command line export, you should ensure you are using Java 1.8 on the machine running the export.

Using a Self-Signed SSL Certificate

If you are using a self-signed SSL certificate on you web server instead of one from a recognized certificate issuing authority, and you are trying to use SSL for the command-line export, then you will probably get the No trusted certificate found exception. In this case you will need to do a little additional configuration.

The second service is the problem here. When you make an SSL connection, the server sends its certificate to the client. The certificate contains such information as:

To ensure that the certificate isn't lying about this information, it is signed by some "recognized" certificate authority, such as Verisign, Thawt, etc. The theory is that you trust Verisign, and Verisign claims that they've validated the information on the certificate, so you can trust the information.

In the case of a self-signed certificate, the certificate is not signed by a recognized certificate authority. This means that the information cannot be trusted. To get around that problem you have to import the server's certificate into your client JVM's keystore. Here's basically what you need to do:

Use Internet Explorer to go to your Unanet installation. You should get a security alert pop-up window warning you that there is a problem with the certificate on this site. (If you don't get this alert, then it's because you already told your browser to accept this certificate permanently. Go to a machine that hasn't and try it.) Click on the "View Certificate" button. Then select the "Details" tab and click on the "Copy to File..." button. This should start the certificate export wizard. Click next, then select the "DER encoded binary X.509 (.CER)" format. Click next again, and now enter any name for the certificate, like "c:\unanet.cer". Click next again and finish.

Now you should have a certificate file, unanet.cer, that you can import into your JVM's keystore file. Copy that file to the machine where you're trying to run the Unanet export. (If you're using FTP, remember to use binary mode.) Now the main thing is to find the keystore file for your JVM. If you are using Sun's JVM, then it is located in the Java home directory at %JAVA_HOME%/lib/security/cacerts. If you're not using Sun's JVM, then you'll have to poke around a little to find it, either in the file system, or in the documentation. Anyway, once you find it then run this command:

If the JAVA_HOME environment variable is not set correctly, then replace %JAVA_HOME% with the correct home directory of your Java installation. You should be prompted for a password to alter the cacerts file. If it has not been changed, then you should be able to use the default password of changeit. That should do it.

Using Command Line Export with Single Sign-On

When configuring authentication / single sign-on options, you need to ensure to include the native Unanet Authentication option in your configuration file. The command line export requires a "Unanet" username and password to operate (ie it will not function with an external authentication option).

Automated Export Example

If you are attempting to automate the process of exporting data from Unanet, you may need to create a process external to Unanet that accomplishes the following (this is just an example):

Unanet has a stand-alone utility that can assist with the management of the outbound exports. Check out the Integration Management Utility (IMU) for additional information.

--url url	The base URL for the Unanet application. For example: http://www.yourdomain.com/unanet. This option is required.
--username username	A Unanet administrator login username. This option is required.
--password password	The password for the login username used. This option is required.
--file file	If specified, the name of the file that will contain the output of the template. It can be a fully qualified file name or a relative file (to the current directory). The file will only contain output from the export. All errors and other output will be written to standard err/out as appropriate. If a file is not specified, the output will be written to standard out.
--checkVersion	Causes the export.jar to initiate a communication with the specified unanet servlet and verify that the two are compatible. If any incompatibilities are found, the appropriate message will be displayed and an error code (2) will be returned.
--criteria saved_criteria	Specifies the name of the saved export criteria to use when running the export.
--quiet	Causes ONLY results from the export to be displayed to standard out. Criteria, Sql and other output will be suppressed. Any errors encountered will still be reported.
--template template_name	Specifies the name of an export template you wish to use. This will dictate the type of export that will run (Time, Expense, Project, etc.). This option is required.
--version	When using this option, the export will return a version number of the export.jar file. This is used internally for compatibility checking only.
--option var=value	Allows additional options to be provided to the export process. You may specify multiple options. If you are interested in supplying several values for the same option you will need to include separate option entries for each. For example, if passing in 2 users to export on the person export (having person keys of 100 and 101), you would include: --option person=100 --option person=101 Note that rather than passing in these individual items, you may instead want to manually configure a selection criteria page, save the criteria and use the saved criteria instead. Note that the default values used when specific options are not provided will match the default values that the user interface supplies (for each export type). The options that are available vary by template type. See which options are available for each type of export below: Generally Available for all Types The following options are available across any export template type: filename -- provides or overrides the filename listed on the export criteria. Keep in mind that this file is written from the context of the Unanet server, NOT the machine running the export. Example: --option filename=myfile.csv email -- Provides or overrides the email listed on the export criteria. Keep in mind that this email is sent from the Unanet server, NOT the machine running the IMU. Example: --option email=myemail.mydomain.com distinct -- Provides or overrides the "Suppress repeating values" export criteria. Valid values include: true or false (not case sensitive). False is the default value if not provided. Example: --option distinct=true 1099 Vendor Payment The following options are available for the 1099 Vendor Payment exports: legalEntity: legal entity key organizations: vendor organization key dateRange: document date range custom - when using this option, you will need to supply a value for the following 2 options: dateRange_bDate: document begin date, example "3/10/2014" dateRange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific drange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option dateRange=bot_eot --option dateRange=cp_yr --option dateRange="custom" --option dateRange_bDate="03/10/2014" --option dateRange_eDate="05/10/2014" Accounts The following options are available for the Accounts exports: account: account key accountType: account type, optional values are A (Asset) E (Expense) L (Liability) R (Revenue) fin: Financials Parent Account key cost: Cost Pools Parent Account key Accounts Receivable The following options are available for the Accounts Receivable exports: markExtracted: Valid values include: true or false. If the data is to be marked as having been extracted, then you would include a value of true. legalEntity: legal entity key project_orgMode: true or false value. project: If parameter project_orgMode is true, parameter project is invoice customer key. If parameter project_orgMode is false, parameter project is invoice project key. invoiceNumber: invoice key invoiceDate_bDate: invoice begin date invoiceDate_eDate: invoice end date prange_bDate: post begin date, example "3/10/2014" prange_eDate: post end date, example "5/10/2014" fprange_fpBegin: fiscal period begin date,must be a correct fiscal period begin date, for example "8/1/2013". fprange_fpEnd: fiscal period end date,must be a correct fiscal period end date, for example "8/30/2013". invStatus: invoice status, optional values are D (Drafted) C (Completed) E (Extracted) voided: void status of invoice, optional values are NON_VOID VOIDING VOIDED Alternate The following options are available for the Alternate exports: person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). This is the person that has been defined as the alternate for some other person. Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true alternate_person -- The identifying key value for the user that is defined as the person configured as the alternate . Example: --option alternate_person=5 rolekeys -- This option can be used to restrict the output by including a role key. If no role keys are specified, no filtering occurs by role. Example: --option rolekeys=1 Approval Group The following options are available for the Approval Group exports: approvalGroup -- The identifying key value for an approval group. Example: --option approvalGroup=5 Assignment The following options are available for the Assignment exports: person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true organizationAssignment-- Valid values include: true or false. This option can be used to indicate that the output should include Organization level assignments (by providing a value of true). Example: --option organizationAssignment=true projectAssignment-- Valid values include: true or false. This option can be used to indicate that the output should include Project level assignments (by providing a value of true). Example: --option projectAssignment=true taskAssignment-- Valid values include: true or false. This option can be used to indicate that the output should include Task level assignments (by providing a value of true). Example: --option taskAssignment=true dRange: document date range custom - when using this option, you will need to supply a value for the following 2 options: dRange_bDate: document begin date, example "3/10/2014" dRange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific drange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option dRange=bot_eot --option dRange=cp_yr --option dRange="custom" --option dRange_bDate="03/10/2014" --option dRange_eDate="05/10/2014" Customer Payment The following options are available for the Customer Payment exports: legalEntity -- The identifying key value for the legal entity associated with customer profile organization. Example: --option legalEntity=3 customer -- The identifying key value for the customer organization associated with a customer payment Example: --option customer=5 document_number -- The identifying key value of the customer payment financial document Example: --option document_number=5 bankAcct -- bank account key Example: --option bankAcct=5 reference -- document reference, can be part of the document reference. Example: --option reference=ABC123 description -- document description, can be part of the document description. drange: document date range custom - when using this option, you will need to supply a value for the following 2 options: drange_bDate: document begin date, example "3/10/2014" drange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific drange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option drange=bot_eot --option drange=cp_yr --option drange="custom" --option drange_bDate="03/10/2014" --option drange_eDate="05/10/2014" prange: post date range (available options are identical to those available with drange). custom - when using this option, you will need to supply a value for the following 2 options: prange_bDate: document begin date, example "3/10/2014" prange_eDate: document end date, example "5/10/2014" Examples: --option prange=bot_eot --option prange=cp_yr --option prange="custom" --option prange_bDate="03/10/2014" --option prange_eDate="05/10/2014" fprange: fiscal period range (if supplying a value for this and prange, you will need to ensure they align -- supplying a value that does not align will result in no data returned). custom - when using this option, you will need to supply a value for the following 2 options (if not supplied, the prange values will determine fiscal period): fprange_fpBegin: fiscal period begin date, example "3/10/2014" fprange_fpEnd: fiscal period end date, example "5/10/2014" Examples: --option fprange="custom" --option fprange_fpBegin="03/10/2014" --option fprange_fpEnd="05/10/2014" f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_yr - Fiscal - Current Year f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_yr - Fiscal - Previous and Current Year status -- document status, optional values are: I (inuse) S (submitted) P (posted) voided -- document voided status, optional values are: NON_VOID VOIDING VOIDED Customer Profile The following options are available for the Customer Profile exports: orgs: customer org key legalEntity: legal entity key includeALL: true or false value, if true, include Customer Profiles valid for All Legal Entities includeSELECTED: true or false value, if true, include Customer Profiles valid for a Specific Legal Entity suppress: if set to true, suppress Customer Profiles valid for All Legal Entities when an Entity Specific profile exists Employee Type The following options are available for the Employee Type exports: employeeType: employee type key Employee Type Expense Type The following options are available for the Employee Type Expense Type exports: employeeType: employee type key expensetype: expense type key Employee Type Pay Code The following options are available for the Employee Type Pay Code exports: employeeType: employee type key payCode: pay code key Expense The following options are available for the Expense exports: legalEntity -- project owning org legal entity key markExtracted -- Valid values include: true or false. If the data is to be marked as having been extracted, then you would include a value of true. Example: --option markExtracted=true postDate -- Valid values should be formatted as MM/DD/YYYY. This represents the optional date that can be provided with marking expenses as extracted. This option should only be used if you are also using the markExtracted option. Example: --option postDate=04/25/2011 dateRange -- Valid values include: custom - When using this option, you will also need to supply a value for the dateRange_bDate and dateRange_eDate bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific dateRange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Example: --option custom dateRange_bDate -- Valid values should be formatted as MM/DD/YYYY. This represents the beginning date of the selection criteria date range. When using this option you will also need to supply the --option custom option (otherwise, this option will be ignored). Example: --option dateRange_bDate=01/01/2010 dateRange_eDate -- Valid values should be formatted as MM/DD/YYYY. This represents the ending date of the selection criteria date range. When using this option you will also need to supply the --option custom option (otherwise, this option will be ignored). Example: --option dateRange_eDate=03/31/2010 expenseDates -- Valid values include: INCURRED, COMPLETED, POSTED, and STATUS (you would supply only one of these). This option corresponds to the selection criteria option that determines how the expense details will be filtered as follows: INCURRED - this option would correlate to the 'Using Line Item within Date Range' option COMPLETED - this option would correlate to the 'Using Voucher Completion Date within Range' option - this is the default option if no specific dateRange option is specified POSTED- this option would correlate to the 'Using Posted Date within Range (Extracted Expense Reports only)' option STATUS- this option would correlate to the 'Using Current Voucher Status Date within Range' option Example: --option expenseDates=POSTED voucherNumber -- The identifying key value for the expense report/request voucher to be included in the output. Example: --option voucherNumber=5 approvalGroup-- The identifying key value for the approval group to be included in the output. Example: --option approvalGroup=5 person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true projtype -- The identifying key value for the project type to be included in the output. Example: --option projtype=5 expensetype -- The identifying key value for the expense type to be included in the output. Example: --option expensetype=10 paymentMethod -- The identifying key value for the payment method to be included in the output. Valid values include 1, 2 or 3 (typically 1 equates to Employee, 2 equates to Corp. Card and 3 equates to Company Paid) Example: --option paymentMethod=2 REQUESTING -- Valid values include: true or false. If true, then those expense requests having a status of this type can be included in the resulting output. Example: --option REQUESTING=true DENIED -- Valid values include: true or false. If true, then those expense requests having a status of this type can be included in the resulting output. Example: --option DENIED=true PREAPPROVING -- Valid values include: true or false. If true, then those expense requests having a status of this type can be included in the resulting output. Example: --option PREAPPROVING=true INUSE -- Valid values include: true or false. If true, then those expense reports / requests having a status of this type can be included in the resulting output. Example: --option INUSE=true SUBMITTED -- Valid values include: true or false. If true, then those expense reports having a status of this type can be included in the resulting output. Example: --option SUBMITTED=true APPROVING -- Valid values include: true or false. If true, then those expense reports having a status of this type can be included in the resulting output. Example: --option APPROVING=true DISAPPROVED -- Valid values include: true or false. If true, then those expense reports having a status of this type can be included in the resulting output. Example: --option DISAPPROVED=true COMPLETED -- Valid values include: true or false. If true, then those expense reports having a status of this type can be included in the resulting output. Example: --option COMPLETED=true LOCKED -- Valid values include: true or false. If true, then those expense reports having a status of this type can be included in the resulting output. Example: --option LOCKED=true EXTRACTED -- Valid values include: true or false. If true, then those expense reports having a status of this type can be included in the resulting output. Example: --option EXTRACTED=true Expense Budget The following options are available for the Expense Budget exports: project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true expensetype -- The identifying key value for the expense type to be included in the output. Example: --option expensetype=10 projectAssignment-- Valid values include: true or false. This option can be used to indicate that the output should include Project level expense budget entries (by providing a value of true). Example: --option projectAssignment=true taskAssignment-- Valid values include: true or false. This option can be used to indicate that the output should include Task level expense budget entries (by providing a value of true). Example: --option taskAssignment=true dateRange: document date range custom - when using this option, you will need to supply a value for the following 2 options: dateRange_bDate: document begin date, example "3/10/2014" dateRange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific drange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option dateRange=bot_eot --option dateRange=cp_yr --option dateRange="custom" --option dateRange_bDate="03/10/2014" --option dateRange_eDate="05/10/2014" Expense Plan The following options are available for the Expense Plan exports: project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true expensetype -- The identifying key value for the expense type to be included in the output. Example: --option expensetype=10 dateRange: document date range custom - when using this option, you will need to supply a value for the following 2 options: dateRange_bDate: document begin date, example "3/10/2014" dateRange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific drange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option dateRange=bot_eot --option dateRange=cp_yr --option dateRange="custom" --option dateRange_bDate="03/10/2014" --option dateRange_eDate="05/10/2014" Expense Type - Master The following options are available for the Expense Type - Master exports: expensetype -- The identifying key value for the expense type to be included in the output. Example: --option expensetype=10 Expense Type - Project The following options are available for the Expense Type - Project exports: project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true expensetype -- The identifying key value for the expense type to be included in the output. Example: --option expensetype=10 Fixed Price Item General Ledger The following options are available for the General Ledger Journal Entry exports: legalEntity: legal entity key account: account key accountType: account type, optional values are A (Asset) E (Expense) L (Liability) R (Revenue) financialOrg: organization key project: if project_ownOrgMode is set to true, project are owning org keys; if project_orgMode is set to true, project are project org keys; Otherwise project are project keys. drange: document date range custom - when using this option, you will need to supply a value for the following 2 options: jrange_bDate: document begin date, example "3/10/2014" jrange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific jrange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option drange=bot_eot --option drange=cp_yr --option drange="custom" --option drange_bDate="03/10/2014" --option drange_eDate="05/10/2014" prange: post date range (available options are identical to those available with drange). custom - when using this option, you will need to supply a value for the following 2 options: prange_bDate: document begin date, example "3/10/2014" prange_eDate: document end date, example "5/10/2014" Examples: --option prange=bot_eot --option prange=cp_yr --option prange="custom" --option prange_bDate="03/10/2014" --option prange_eDate="05/10/2014" fprange: fiscal period range (if supplying a value for this and prange, you will need to ensure they align -- supplying a value that does not align will result in no data returned). custom - when using this option, you will need to supply a value for the following 2 options (if not supplied, the prange values will determine fiscal period): fprange_fpBegin: fiscal period begin date, example "3/10/2014" fprange_fpEnd: fiscal period end date, example "5/10/2014" Examples: --option fprange="custom" --option fprange_fpBegin="03/10/2014" --option fprange_fpEnd="05/10/2014" f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_yr - Fiscal - Current Year f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_yr - Fiscal - Previous and Current Year documentNumber_type: document type "11": AL - Cost Pool Post "6": BR - Billing & Revenue Post. "7": CI - Invoice. "3": CP - Customer Payment. "4": D - Deposit. "9": EC - Expense Report Cost Post. "10": FY - General Ledger Closing. "5": JE - Journal Entry. "8": LC - Labor Cost Post. "0": VI - Vendor Invoice. "1": VP - Vendor Payment. documentNumber: document number The following options are available for the Fixed Price Item exports: project_orgMode: true or false value. project: If parameter project_orgMode is true, parameter project is fixed price project org key. If parameter project_orgMode is false, parameter project is fixed price project key. dateRange_bDate: Bill Date begin date, example "3/1/2014" dateRange_eDate: Bill Date end date, example "3/31/2014" wbsLevel: wbs level string, optional values are: project: Projects Only (Include only project-level fixed price schedules) task: Tasks Only (Include only task-level fixed price schedules) both: Projects and Tasks (Include both project-level and task-level fixed price schedules) includePosted: Include posted. True of false value. includeRevSchedules: Include Revenue Recognition Schedules. True of false value. General Ledger Journal Entry The following options are available for the General Ledger Journal Entry exports: legalEntity: legal entity key journal_number: financial document key reference: document reference, can be part of the document reference. description: document description, can be part of the document description. drange: document date range custom - when using this option, you will need to supply a value for the following 2 options: jrange_bDate: document begin date, example "3/10/2014" jrange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific jrange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option drange=bot_eot --option drange=cp_yr --option drange="custom" --option drange_bDate="03/10/2014" --option drange_eDate="05/10/2014" prange: post date range (available options are identical to those available with drange). custom - when using this option, you will need to supply a value for the following 2 options: prange_bDate: document begin date, example "3/10/2014" prange_eDate: document end date, example "5/10/2014" Examples: --option prange=bot_eot --option prange=cp_yr --option prange="custom" --option prange_bDate="03/10/2014" --option prange_eDate="05/10/2014" fprange: fiscal period range (if supplying a value for this and prange, you will need to ensure they align -- supplying a value that does not align will result in no data returned). custom - when using this option, you will need to supply a value for the following 2 options (if not supplied, the prange values will determine fiscal period): fprange_fpBegin: fiscal period begin date, example "3/10/2014" fprange_fpEnd: fiscal period end date, example "5/10/2014" Examples: --option fprange="custom" --option fprange_fpBegin="03/10/2014" --option fprange_fpEnd="05/10/2014" f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_yr - Fiscal - Current Year f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_yr - Fiscal - Previous and Current Year status: document status, optional values are: I (inuse) S (submitted) P (posted) voided: document voided status, optional values are: NON_VOID VOIDING VOIDED Journal Entry The following options are available for the Journal Entry exports: legalEntity: legal entity key project_orgMode: true or false value. project: If parameter project_orgMode is true, parameter project is project org key. If parameter project_orgMode is false, parameter project is project key. account: account key prange_bDate: posted date begin date, for example "3/1/2014" prange_eDate: posted date end date, for example "3/31/2014" fprange_fpBegin: fiscal period begin date,must be a correct fiscal period begin date, for example "8/1/2013". fprange_fpEnd: fiscal period end date,must be a correct fiscal period end date, for example "8/30/2013". following parameters are Journal Type values, all are true or false values: labor expense costPlus fixedPrice prebilledLabor oneTimeCharge documentExpense feeCapAdjust fundCapAdjust includeEntries: optional values for Journal Entry Status are: extracted unextracted both following parameters are Journal Entries Generated By, all are true or false values: billPost invoiceCompl laborPost expensePost Labor Category - Master The following options are available for the Labor Category - Master exports: labor_category-- The identifying key value for the labor category to be included in the output. Example: --option labor_category=10 dateRange_bDate -- Valid values should be formatted as MM/DD/YYYY. This represents the beginning date of the selection criteria date range. Example: --option dateRange_bDate=01/01/2010 dateRange_eDate -- Valid values should be formatted as MM/DD/YYYY. This represents the ending date of the selection criteria date range. Example: --option dateRange_eDate=03/31/2010 Labor Category - Project The following options are available for the Labor Category - Project exports: labor_category -- The identifying key value for the labor category to be included in the output. Example: --option labor_category=10 project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true dateRange_bDate -- Valid values should be formatted as MM/DD/YYYY. This represents the beginning date of the selection criteria date range. Example: --option dateRange_bDate=01/01/2010 dateRange_eDate -- Valid values should be formatted as MM/DD/YYYY. This represents the ending date of the selection criteria date range. Example: --option dateRange_eDate=03/31/2010 Location - Master The following options are available for the Location- Master exports: location -- The identifying key value for the location to be included in the output. Example: --option location=10 Location - Project The following options are available for the Location- Project exports: location -- The identifying key value for the location to be included in the output. Example: --option location=10 project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true Organization TThe following options are available for the Organization exports: legalEntity -- org legal entity key organization -- The identifying key value for the organization to be included in the output. organization_filterInactiveOrg -- Valid values include true and false. When true, the filtered results will include inactive Organizations. When false, the filtered results will not include inactive organizations (though, this value is only referenced when filtering). organizationtype -- The identifying key value for the organization type to be included in the output. parentOrganization -- The identifying key value for the parent organization to be included in the output. parentOrganization_filterInactiveOrg -- Valid values include true and false. When true, the filtered results will include inactive Organizations. When false, the filtered results will not include inactive organizations (though, this value is only referenced when filtering). orgFinancialParent -- Financials Parent Organization key orgFinancialParent_filterInactiveOrg -- Valid values include true and false. When true, the filtered results will include inactive Organizations. When false, the filtered results will not include inactive organizations (though, this value is only referenced when filtering). orgCostPoolsParent -- Cost Pools Parent Organization key orgCostPoolsParent_filterInactiveOrg -- Valid values include true and false. When true, the filtered results will include inactive Organizations. When false, the filtered results will not include inactive organizations (though, this value is only referenced when filtering). externalSystemCode -- The identifying value for the organization account number to be included in the output. organizationsic -- The identifying value for the organization account to be included in the output. organizationclassification -- The identifying value for the organization account to be included in the output. vendor1099 -- Valid values include: true or false. If true, then the resulting output will be limited to those Organizations that have been designated as Eligible to receive a 1099, otherwise, when false, no such filtering will occur. Example: --option vendor1099=true Organization Access The following options are available for the Organization Access exports: asOfDate -- Valid values should be formatted as MM/DD/YYYY. This date is used in conjunction with the user classification filter to determine when the classification should be compared. Example: --option asOfDate=01/01/2011 exempt -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of exempt. Example: --option exempt=true nonExempt -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of nonexempt. Example: --option nonExempt=true nonEmployee -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of nonemployee. Example: --option nonEmployee=true person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). This is the person that has been defined as the alternate for some other person. Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true includeAll -- Valid values include: true or false. If true, then the resulting output will include entries having the type of organization access level of "All". Example: --option includeAll=true includeNone -- Valid values include: true or false. If true, then the resulting output will include entries having the type of organization access level of "None". Example: --option includeNone=true includeSelected -- Valid values include: true or false. If true, then the resulting output will include entries having the type of organization access level of "Selected". Example: --option includeSelected=true orgs -- The identifying key value for the organization to be included in the output. This option should only be used if you are also using the includeSelected option. Example: --option orgs=10 rolekeys -- This option can be used to restrict the output by including a role key. If no role keys are specified, no filtering occurs by role. Example: --option rolekeys=1 Organization Address The following options are available for the Organization Address exports: organization: org key parentOrganization: parent org key organizationtype: org type key organizationaccount: org account number, example "acct123". organizationsic: org sic code, example "N985PE". organizationclassification: org classification, example "Class 132". Organization Contact Organization Contact Address Organization Contact Email Organization Contact Phone The following options are available for the Organization Contact Phone exports: contact: contact key contact_outputActive: Valid values include: true or false. If true, then the output will contain active contacts. Example: --option contact_outputActive=true contact_outputInactive: Valid values include: true or false. If true, then the output will contain inactive contacts. Example: --option contact_outputInactive=true email_address: comma-separated list of email addresses phone_number: comma-separated list of phone numbers title: comma-separated list of titles city: state_province: country: cntPhoneType: cntCategoryType: allCategories: Valid values include: true or false. If true, then the output will contain inactive contacts. The following options are available for the Organization Contact Email exports: contact: contact key contact_outputActive: Valid values include: true or false. If true, then the output will contain active contacts. Example: --option contact_outputActive=true contact_outputInactive: Valid values include: true or false. If true, then the output will contain inactive contacts. Example: --option contact_outputInactive=true email_address: comma-separated list of email addresses phone_number: comma-separated list of phone numbers title: comma-separated list of titles city: state_province: country: cntEmailType: cntCategoryType: allCategories: Valid values include: true or false. If true, then the output will contain inactive contacts. The following options are available for the Organization Contact Address exports: contact: contact key contact_outputActive: Valid values include: true or false. If true, then the output will contain active contacts. Example: --option contact_outputActive=true contact_outputInactive: Valid values include: true or false. If true, then the output will contain inactive contacts. Example: --option contact_outputInactive=true email_address: comma-separated list of email addresses phone_number: comma-separated list of phone numbers title: comma-separated list of titles city: state_province: country: cntAddressType: cntCategoryType: allCategories: Valid values include: true or false. If true, then the output will contain inactive contacts. The following options are available for the Organization Contact exports: organization: org key organizationtype: org type key parentOrganization: parent org key externalsystemcode: org account number, example "acct123". organizationsic: org sic code, example "N985PE". organizationclassification: org classification, example "Class 132". Person The following options are available for the Person exports: legalEntity -- project owning org legal entity key asOfDate -- Valid values should be formatted as MM/DD/YYYY. This date is used in conjunction with the user classification filter to determine when the classification should be compared. Example: --option asOfDate=01/01/2011 person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). This is the person that has been defined as the alternate for some other person. Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true timeApprovalGroup -- The identifying key value for the time approval group to be included in the output. Example: --option timeApprovalGroup=10 expenseApprovalGroup -- The identifying key value for the time approval group to be included in the output. Example: --option expenseApprovalGroup=10 exempt -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of exempt. Example: --option exempt=true nonExempt -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of nonexempt. Example: --option nonExempt=true nonEmployee -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of nonemployee. Example: --option nonEmployee=true rolekeys -- This option can be used to restrict the output to one or several specific roles by including a role key. If no role keys are specified, no filtering occurs by role. Example: --option rolekeys=1 Person Accrual The following options are available for the Person Accrual exports: legalEntity -- project owning org legal entity key accrualplan -- The identifying key value for the accrual plan to be included in the output. Example: --option accrualplan=5 outputActive -- Valid values include: true or false. If true, then the resulting output will include Active accrual plans. Example: --option outputActive=true outputInactive -- Valid values include: true or false. If true, then the resulting output will include Inactive accrual plans. Example: --option outputInactive=true dateRange_bDate -- Valid values should be formatted as MM/DD/YYYY. This represents the beginning date of the selection criteria date range. Example: --option dateRange_bDate=01/01/2010 dateRange_eDate -- Valid values should be formatted as MM/DD/YYYY. This represents the ending date of the selection criteria date range. Example: --option dateRange_eDate=03/31/2010 person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). This is the person that has been defined as the alternate for some other person. Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true Person Skills The following options are available for the Person Skills exports: person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). This is the person that has been defined as the alternate for some other person. Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true skill_level -- The identifying key value for the skill level to be included in the output. Example: --option skill_level=10 skill_level_and -- Valid values include: true or false. If true, then the resulting output will include only those people having ALL the selected skill levels specified (not just any of them). Example: --option skill_level_and=true Planned Work The following options are available for the Planned Work exports: person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true dateRange: document date range custom - when using this option, you will need to supply a value for the following 2 options: dateRange_bDate: document begin date, example "3/10/2014" dateRange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific drange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option dateRange=bot_eot --option dateRange=cp_yr --option dateRange="custom" --option dateRange_bDate="03/10/2014" --option dateRange_eDate="05/10/2014" Project The following options are available for the Project exports: legalEntity -- project owning org legal entity key project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true projMgr -- The identifying key value for the Project Manager to be included in the output. Example: --option projMgr=10 projtype -- The identifying key value for the project type to be included in the output. Example: --option projtype=5 status -- The identifying key value for the project status to be included in the output. Example: --option status=10 Project Administrators The following options are available for the Project Administrators exports: legalEntity -- project owning org legal entity key person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true projtype -- The identifying key value for the project type to be included in the output. Example: --option projtype=5 status -- The identifying key value for the project status to be included in the output. Example: --option status=10 rolekeys -- This option can be used to restrict the output by including a role key. If no role keys are specified, no filtering occurs by role. Example: --option rolekeys=1 Project Fee The following options are available for the Project Fee exports: legalEntity: legal entity key project_orgMode: true or false value. project: If parameter project_orgMode is true, parameter project is project org key. If parameter project_orgMode is false, parameter project is project key. Project Invoice Setup The following options are available for the Project Invoice Setup exports: project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 projtype -- The identifying key value for the project type to be included in the output. If you intend to search for multiple, you'll need to include multiple options. Example: --option projtype=5 --option projtype=7 status -- The identifying key value for the project status to be included in the output. Example: --option status=10 Skill Level The following options are available for the Skill Level exports: skillLevel-- The identifying key value for the skill level to be included in the output. Example: --option skillLevel=3 Skill Type The following options are available for the Skill Type exports: skill_type-- The identifying key value for the location to be included in the output. Example: --option skill_type=3 Skills The following options are available for the Skills exports: skillLevel-- The identifying key value for the skill level to be included in the output. Example: --option skillLevel=3 Task The following options are available for the Task exports: legalEntity -- project owning org legal entity key project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true projMgr -- The identifying key value for the Project Manager to be included in the output. Example: --option projMgr=10 projtype -- The identifying key value for the project type to be included in the output. Example: --option projtype=5 status -- The identifying key value for the project status to be included in the output. Example: --option status=10 Time The following options are available for the Time exports: legalEntity -- project owning org legal entity key markExtracted -- Valid values include: true or false. If the data is to be marked as having been extracted, then you would include a value of true. Example: --option markExtracted=true dateType -- Valid values include: timePeriod, relative, and range. This option corresponds to the selection criteria option that determines how the time details will be filtered as follows: timePeriod - this option would correlate to the ' Specific Time Period' option relative - this option would correlate to the 'Relative Time Period' option range - this option would correlate to the 'Specific Date Range' option Example: --option dateType=timePeriod timePeriod -- The value supplied in this field will be a concatenation of three different values separated by semi-colons, including the time period key, the time period begin date, and time period end date (with dates in the YYYY-MM-DD format) Example: --option timePeriod=1;2010-08-16;2010-08-22 relativePeriod -- Valid values include: curr, and prev. curr - this option would correlate to the ' Specific Time Period' option prev - this option would correlate to the 'Relative Time Period' option Example: --option relativePeriod=curr relativePeriodType -- The identifying key value for the type of time period to be included (time period key) in the output. Example: --option relativePeriodType=10 beginDate -- Valid value includes a date formatted as follows: YYYY-MM-DD, which represents the begin date for the selection criteria date range. Example: --option beginDate=2010-08-16 endDate -- Valid value includes a date formatted as follows: YYYY-MM-DD, which represents the end date for the selection criteria date range Example: --option endDate=2010-08-31 approvalGroup -- The identifying key value for an approval group. Example: --option approvalGroup=5 person -- The identifying key value for the user to be included in the output (or the person's organization key value if the person_orgMode is true). Example: --option person=3 person_orgMode -- Valid values include: true or false. If true, then the Person filter is relating to Person Organizations, otherwise, the default is that the Person filter is relating to Users. Example: --option person_orgMode=true project_orgMode -- Valid values include: true or false. If true, then the Project filter is relating to Project Organizations, otherwise, the default is that the Project filter is relating to Projects. Example: --option project_orgMode=true project -- The identifying key value for the project to be included in the output (or the project's organization key value if the project_orgMode is true). Example: --option project=3 projMgr -- The identifying key value (users person key) for the Project Manager to be included in the output. Example: --option projMgr=10 INUSE -- Valid values include: true or false. If true, then those timesheets having a status of this type can be included in the resulting output. Example: --option INUSE=true SUBMITTED -- Valid values include: true or false. If true, then those timesheets having a status of this type can be included in the resulting output. Example: --option SUBMITTED=true APPROVING -- Valid values include: true or false. If true, then those timesheets having a status of this type can be included in the resulting output. Example: --option APPROVING=true DISAPPROVED -- Valid values include: true or false. If true, then those timesheets having a status of this type can be included in the resulting output. Example: --option DISAPPROVED=true COMPLETED -- Valid values include: true or false. If true, then those timesheets having a status of this type can be included in the resulting output. Example: --option COMPLETED=true LOCKED -- Valid values include: true or false. If true, then those timesheets having a status of this type can be included in the resulting output. Example: --option LOCKED=true EXTRACTED -- Valid values include: true or false. If true, then those timesheets having a status of this type can be included in the resulting output. Example: --option EXTRACTED=true exempt -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of exempt. Example: --option exempt=true nonExempt -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of nonexempt. Example: --option nonExempt=true nonEmployee -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of nonemployee. Example: --option nonEmployee=true adjustmentStatus-- Valid values include: NO, POST, ENTERED, POSTONLY and ENTEREDONLY. The values in this option correspond to the list of options appearing in the Adjustments drop down list. Example: --option adjustmentStatus=POST incPrevExt-- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of nonemployee. Example: --option incPrevExt=true suppIntAdj -- Valid values include: true or false. If true, then the resulting output will include entries having a person classification of nonemployee. Example: --option suppIntAdj=true Vendor Invoice The following options are available for the Vendor Invoice exports: legalEntity: legal entity key vendor: vendor key document_number: financial document key description: document description, can be part of the document description. drange: document date range custom - when using this option, you will need to supply a value for the following 2 options: drange_bDate: document begin date, example "3/10/2014" drange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific drange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option drange=bot_eot --option drange=cp_yr --option drange="custom" --option drange_bDate="03/10/2014" --option drange_eDate="05/10/2014" prange: post date range (available options are identical to those available with drange). custom - when using this option, you will need to supply a value for the following 2 options: prange_bDate: document begin date, example "3/10/2014" prange_eDate: document end date, example "5/10/2014" Examples: --option prange=bot_eot --option prange=cp_yr --option prange="custom" --option prange_bDate="03/10/2014" --option prange_eDate="05/10/2014" fprange: fiscal period range (if supplying a value for this and prange, you will need to ensure they align -- supplying a value that does not align will result in no data returned). custom - when using this option, you will need to supply a value for the following 2 options (if not supplied, the prange values will determine fiscal period): fprange_fpBegin: fiscal period begin date, example "3/10/2014" fprange_fpEnd: fiscal period end date, example "5/10/2014" Examples: --option fprange="custom" --option fprange_fpBegin="03/10/2014" --option fprange_fpEnd="05/10/2014" f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_yr - Fiscal - Current Year f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_yr - Fiscal - Previous and Current Year status: document status, optional values are: I (inuse) S (submitted) P (posted) voided: document voided status, optional values are: NON_VOID VOIDING VOIDED organization: ap org key account: ap account key Vendor Payment The following options are available for the Vendor Payment exports: legalEntity: legal entity key vendor: vendor key document_number: financial document key bankAcct: bank account key reference: document reference, can be part of the document reference. description: document description, can be part of the document description. drange: document date range custom - when using this option, you will need to supply a value for the following 2 options: drange_bDate: document begin date, example "3/10/2014" drange_eDate: document end date, example "5/10/2014" bot_eot - BOT to EOT bot_today - BOT to Today c_mo selected - Calendar - Current Month - this is the default option if no specific drange option is specified c_qtr - Calendar - Current Quarter c_smo - Calendar - Current Semi-Month c_wk - Calendar - Current Week c_yr - Calendar - Current Year mtd - Calendar - Month to Date n_mo - Calendar - Next Month n_qtr - Calendar - Next Quarter n_smo - Calendar - Next Semi-Month n_wk - Calendar - Next Week n_yr - Calendar - Next Year p_mo - Calendar - Previous Month p_qtr - Calendar - Previous Quarter p_smo - Calendar - Previous Semi-Month p_wk - Calendar - Previous Week p_yr - Calendar - Previous Year cp_mo - Calendar - Previous and Current Month cp_qtr - Calendar - Previous and Current Quarter cp_smo - Calendar - Previous and Current Semi-Month cp_wk - Calendar - Previous and Current Week cp_yr - Calendar - Previous and Current Year qtd - Calendar - Quarter to Date ytd - Calendar - Year to Date f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_wk - Fiscal - Current Week f_c_yr - Fiscal - Current Year f_mtd - Fiscal - Month to Date f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_wk - Fiscal - Next Week f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_wk - Fiscal - Previous Week f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_wk - Fiscal - Previous and Current Week f_cp_yr - Fiscal - Previous and Current Year f_qtd - Fiscal - Quarter to Date f_ytd - Fiscal - Year to Date today - Today Examples: --option drange=bot_eot --option drange=cp_yr --option drange="custom" --option drange_bDate="03/10/2014" --option drange_eDate="05/10/2014" prange: post date range (available options are identical to those available with drange). custom - when using this option, you will need to supply a value for the following 2 options: prange_bDate: document begin date, example "3/10/2014" prange_eDate: document end date, example "5/10/2014" Examples: --option prange=bot_eot --option prange=cp_yr --option prange="custom" --option prange_bDate="03/10/2014" --option prange_eDate="05/10/2014" fprange: fiscal period range (if supplying a value for this and prange, you will need to ensure they align -- supplying a value that does not align will result in no data returned). custom - when using this option, you will need to supply a value for the following 2 options (if not supplied, the prange values will determine fiscal period): fprange_fpBegin: fiscal period begin date, example "3/10/2014" fprange_fpEnd: fiscal period end date, example "5/10/2014" Examples: --option fprange="custom" --option fprange_fpBegin="03/10/2014" --option fprange_fpEnd="05/10/2014" f_c_mo - Fiscal - Current Month f_c_qtr - Fiscal - Current Quarter f_c_yr - Fiscal - Current Year f_n_mo - Fiscal - Next Month f_n_qtr - Fiscal - Next Quarter f_n_yr - Fiscal - Next Year f_p_mo - Fiscal - Previous Month f_p_qtr - Fiscal - Previous Quarter f_p_yr - Fiscal - Previous Year f_cp_mo - Fiscal - Previous and Current Month f_cp_qtr - Fiscal - Previous and Current Quarter f_cp_yr - Fiscal - Previous and Current Year status: document status, optional values are: I (inuse) S (submitted) P (posted) voided: document voided status, optional values are: NON_VOID VOIDING VOIDED Vendor Profile The following options are available for the Vendor Profile exports: organization: vendor key legalEntities: legal entity key includeALL: true or false value, if true, include vendor profiles valid for All Legal Entities includeSELECTED: true or false value, if true, include vendor profiles valid for a Specific Legal Entity suppress: if set to true, suppress vendor profiles valid for All Legal Entities when an Entity Specific profile exists