Quote & Lease Operations API: Qt Quotes copyQuote

API endpoints for quote (Qt_*) and lease (Qq_*) operations and fleet reports

Qt Quotes copyQuote

Synopsis

Warning: This web service has been deprecated and can no longer be run.
Use copyQuote instead.

With this web service you can copy an existing Catch-e Quote. This service replicates the Copy button.

The Quote ID is the only parameter required to be passed into the web service.

If a problem occurs a Catch-e error code (listed below) will be returned with the result.

Input Fields

	Query string key	Format	Notes	Mandatory
1	quote_id	string	Catch-e Quote ID	yes

Input URL Example

https://yourname.catch-e.net.au/services/qt/quotes/copyQuote/?quote_id=100000&login=yourlogin&password=yourpassword

Output Fields

	XML element	Format	Notes
1	quote_id	integer	Returns the Quote ID for the copied Quote

Output Example

<?xml version="1.0" encoding="UTF-8"?><response><return_status>1</return_status> <quote_id>100001</quote_id></response>

Error Codes

Error Codes	Comments
CATCHEERRORBLANKQUOTE_ID	Input field missing
CATCHEERRORMISSINGFIELDQUOTEID	Input field missing

| CATCHEERRORQUOTECOPYFAILED | Input field missing | | CATCHEERRORQUOTECOPYFAILED Validation failed because of the following fatal error: FBT Payable amount out of sync with FBT Value. | If you see the following Validation error, you may be copying a Quote modified by patchQuote API where there is a small rounding difference (typically 0.01 cent) in the calculation. Set Global Control 'validationtoleranceforfbtvalueyearly' value to 0.01 to allow a 0.01 cent tolerance for when copying a Quote. The current Global Control 'validationtoleranceforfbtvalueyearly' value is shown in the error alert.

Validation failed because of the following fatal error:FBT Payable amount out of sync with FBT Value! Current Value = 4343.99 Expected Value = 4343.97 Global Control validation_tolerance_for_fbt_value_yearly = 0.01

|
| CATCHEERRORQUOTECOPYFAILED Validation failed due to the following errors(s): Previous FBT Value must be 0 or a positive number. | FBT Value from previous quote incorrect. Fix the original quote data. || CATCHEERRORTOOMANYREQUESTS | Rest call requests exceeded the limit set in ). |
| CATCHEERRORUNKNOWNQUOTE_ID | Input field missing |

Error Output Example 1

<?xml version="1.0" encoding="UTF-8"?><response> <error>CATCH_E_ERROR_MISSING_FIELD_QUOTE_ID</error></response>

Qt Quotes getAftermarketOrder

Synopsis

Warning: This web service has been deprecated and can no longer be run.
Use Print a report query instead.

Generates a aftermarket order based on a Catch-e quote id. An aftermarket_order.xml file is required for this service to work. See Import Or Export Files for further details on loading files into Catch-e.

The default return value is the binary aftermarket order document in Excel Xml format. This can be written to a file and opened using recent versions of Microsoft Office.

Possible values for the input report_format field differ depending upon situation. Contact Catch-e support for a list of available formats or to add a new format.

It is essential that the given quote have only one related contract. A quote with multiple related contracts will not export Aftermarket Order forms via this interface.

Input Fields

	Query string key	Format	Notes	Mandatory
1	quote_id	int	Catch-e quote id	yes
2	report_format	string	A valid Catch-e output report format, default is ExcelXml	no
3	encode	string	Format to encode return data. base64 is the only alternate supported encoding format.	no
4	httpheadercontent_type	string	Send an HTTP header for 'Content-type:' e.g. application/pdf. Used when outputting direct to the browser.	no
5	httpheadercontent_disposition	string	Send an HTTP header for Content-Disposition:' e.g. attachment;filename="test.pdf". Used when outputting direct to the browser.	no

See Field Names below

Input URL Example

https://yourname.catch-e.net.au/services/qt/quotes/getAftermarketOrder/?quote_id=100000

Output Fields

	XML element	Format	Notes	Mandatory
1	*none	binary	binary content of the aftermarket order	no

Excel Xml document is returned, see output example below

Output Example

…............. 6 2 False False ### Error Codes| | Error Codes || --- | --- || 1 | CATCH_E_ERROR_MISSING_FIELD_QUOTE_ID || 2 | CATCH_E_ERROR_BLANK_QUOTE_ID || 3 | CATCH_E_ERROR_IDENTIFYING_CONTRACT || 4 | CATCH_E_ERROR_INVALID_REPORT_FORMAT || 5 | CATCH_E_ERROR_TOO_MANY_REQUESTS |#### Error Output Example

CATCHEERRORMISSINGFIELDQUOTEID

Field Names

Excel Xml document is returned.

Qt Quotes getDealerOrder

Warning: This web service is in the process of being deprecated and is no longer supported by Catch-e.
You must use getDealerOrder instead and contact Catch-e Support if you need assistance with the set-up.

Generates a dealer order based on a Catch-e quote id.

The default return value is the binary dealer order document in Excel Xml format. This can be written to a file and opened using recent versions of Microsoft Office.

Possible values for the input report_format field differ depending upon situation. Contact Catch-e support for a list of available formats or to add a new format.

It is essential that the given quote have only one related contract. A quote with multiple related contracts will not export Dealer Order forms via this interface.

Input Fields

	Query string key	Format	Notes	Mandatory
1	quote_id	int	Catch-e quote id	yes
2	report_format	string	A valid Catch-e output report format, default is ExcelXml	no
3	encode	string	Format to encode return data. base64 is the only alternate supported encoding format.	no
4	httpheadercontent_type	string	Send an HTTP header for 'Content-type:' e.g. application/pdf. Used when outputting direct to the browser.	no
5	httpheadercontent_disposition	string	Send an HTTP header for Content-Disposition:' e.g. attachment;filename="test.pdf". Used when outputting direct to the browser.	no

See Field Names below

Input URL Example

https://yourname.catch-e.net.au/services/qt/quotes/getDealerOrder/?quote_id=100000

Output Fields

	XML element	Format	Notes	Mandatory
1	*none	binary	binary content of the dealer order	no

Excel Xml document is returned, see output example below

Output Example

CATCHEERRORMISSINGFIELDQUOTEID

Field Names

Excel Xml document is returned.

Qt Quotes getQuote

This service returns quote template placeholders or a quote PDF.
The default return value is the binary quote document. This can be written to a file and opened using a PDF viewer.
Alternatively the return value can be changed to a list of field value pairs in XML format.

The getQuote spreadsheet contains a list of the placeholders that are available if you are using the recommended 'quote' library.

Warning: getQuote) is no longer supported by Catch-e.
You must use the getQuoteFieldsWebService or Render Quote PDF API instead.

Input Fields

	Query string key	Format	Notes	Mandatory
1	quote_id	int	Catch-e quote id	yes
2	output_mode	string	The type of content to return to the caller. 'PDF' or 'fields', default is 'PDF'.	no
3	return[fieldname]*	mixed	[outputmode = 'fields'] As many of the Field Name(s) as required prefixed with 'return'. If no fields are requested then all fields are returned.	no
4	encode	string	[output_mode = 'PDF'] Format to encode return data. base64 is the only alternate supported encoding format.	no
5	httpheadercontent_type	string	[output_mode = 'PDF'] Send an HTTP header for 'Content-type:' e.g. application/pdf. Used when outputting direct to the browser.	no
6	httpheadercontent_disposition	string	[output_mode = 'PDF'] Send an HTTP header for Content-Disposition:' e.g. attachment;filename="test.pdf". Used when outputting direct to the browser.	no

Contact Catch-e if you need help matching the returned values to the values on Quote PDF

Input URL Examples

All fields:https://yourname.catch-e.net.au/services/qt/quotes/getQuote?quote_id=100000&output_mode=fieldsExample returning selected fields only:https://yourname.test.catch-e.net.au/services/qt/quotes/getQuote?quote_id=100000&output_mode=fields&return_packageing_benefitExample returning PDF binary data:https://yourname.catch-e.net.au/services/qt/quotes/getQuote?quote_id=100000&output_mode=PDF

Output Fields

	XML element	Format	Notes	Mandatory
1	*n/a	binary	binary content of the PDF	no
2	quote	string	XML field / value pairs from the target quote	no

Binary data is returned, see output example below

Output Example [output_mode = 'fields']

4000

Output Example [output_mode = 'PDF']

%PDF-1.3

3 0 obj

stream

…………….

/Size 14

/Root 13 0 R

/Info 12 0 R

>

startxref

73516

%%EOF

Error Codes

	Error Codes	Notes
1	CATCHEERRORMISSINGFIELDQUOTEID	Input field missing
2	CATCHEERRORBLANKQUOTE_ID	Input field invalid
3	CATCHEERRORUNKNOWNQUOTE_ID	Input field invalid record not found
4	CATCHEERRORSYSTEMERROR	Data set up issue
5	CATCHEERRORUNKNOWNOUTPUT_MODE	Input field invalid
6	CATCHEERRORPRINTTEMPLATENOTFOUND	Quote template not found
7	CATCHEERRORACCOUNTMANAGER_EMPTY	Quote Client A/C Manager field invalid
8	CATCHEERRORTOOMANY_REQUESTS	Rest call requests exceeded the limit set in .
9	CATCHEERRORERICQUOTE_EXPIRED	An Eric Interface quote is either expired or did not complete successfully.

Error Output Example

CATCHEERRORMISSINGFIELDQUOTEID

Field Names

Binary quote data is returned.

Qt Quotes recalculateQuote

Warning: This web service has been deprecated and is no longer supported by Catch-e.
Use patchQuote instead and contact Catch-e Support if you need assistance with the set-up.

This web service replicates the manual steps a user would take within the Catch-e application as outlined here:

Click ‘Edit’ on the Vehicle tab
Click inside the List Price Net field
Click outside the List Price Net field

The result should be that the Quote is recalculated and will not reload any Client Quote Defaults, nor reload any Profile elements such as Maintenance, Tyre etc.

This web service locks the Quote whilst performing the recalculation.

Input Fields

#	Query string key	Format	Notes	Catch-e Screen Location	Mandatory
1	quote_id	int	Catch-e quote ID	Quotes / Contract -> Quote ID	yes

Input URL Example

https://[client_name].catch-e.net.au/services/qt/quotes/recalculateQuote?login=xxxxxxx&password=xxxxxxx&quote_id=xxxxxxx

Output Fields

	XML element	Format	Notes	Mandatory
1	result	integer	1 when successful	no

Output Example

Error Codes

	Error Codes	Notes
1	CATCHEERRORAUTHENTICATIONFAILED	Your login credentials are incorrect or don't belong to the 'web_services' role.
2	CATCHEERRORQUOTEID_MISSING	Input field missing
3	CATCHEERRORQUOTEID_INVALID	Input field invalid
4	CATCHEERRORQUOTEID_LOCKED	The target quote is currently being edited
5	CATCHEERRORQUOTESAVE_FAILED	Quote save has failed
6	CATCHEERRORTOOMANY_REQUESTS	Rest call requests exceeded the limit set in .

Error Output Example

CATCHEERRORQUOTEID_INVALID

Qt Quotes updateQuotePricing

Warning: This service has been deprecated. Use patchQuote API instead.

Output Example

Status: 410 Gone

<?xml version="1.0" encoding="UTF-8"?><response><return_status></return_status><error>CATCH_E_ERROR_UNSUPPORTED</error><error_message>updateQuotePricing is no longer supported! Please use the patchQuote API instead.</error_message></response>

Qt Red book importVehicleData

Set-up this job to import RedBook vehicle data from Redbook's FTP server.

Go to the the Variants / Detail page to review the data that is imported for a variant.

If you are receiving paint data in your subscription, users can select the Colour Preferences using a list of available colours when they quote.

Note: Import Redbook data uses an FTP connection.
This function is marked for upgrade to SFTP, but at this stage FTP must be used.

Manual Processing

We recommend using scheduler jobs to process RedBook data, but you can also manually import the data in the following system menu.

Fleet / Import Data → RedBook Data

Fleet / Import Data → RedBook Photos

Job Process

Downloads the zip file containing the latest Redbook vehicle data from Redbook's FTP site.
The service will only download the Redbook file if it has changed since the last successful import. This allows the service to be run daily without unnecessarily downloading these large files.
Extracts and import the data into the family of vehicle data tables.
On successful download and import, an email attachment is created containing details of the Redbook vehicle data file. You can turn the Attachment Required? checkbox on, so you will only receive a notification when this occurs.

Warning: This Job Type requires a development deployment. You will need to forward your Redbook FTP connection details to [mailto:support@catch-e.com.au] first.

Parameters

These are the different parameter settings that you can set up on the Job Screen screen:

Parameter	Notes
Filename	This is the name of the file to download from Redbook's FTP server e.g. Catche.zip.

Messages

The messages below are shown on Scheduler / Schedule as "Last Message" and also on Scheduler / Queue as "Message".

Failed

System error, Catch-e notified — One or more of the files provided by RedBook files contain the wrong number of columns. Catch-e Support will also be notified of the issue. This can happen if RedBook has added new columns to one of your import files and the changes have not been added to the Catch-e System. In this situation, either a code change is required to incorporate the new columns, or RedBook will need to update their files to revert to the prior format.

Troubleshooting

Check the login credentials in redbookftpconnection are correct
Verify the connection in FileZilla - FTP, not SFTP
Check the Filename in the job matches the name of the FTP zip file
Copy the zip file and manually import the file - check for error messages
Extract the zip file and check that all mandatory files are present