Fleet Operations API: Fm swann exportProposals

Fm swann exportProposals

This is an interface to send product proposals to Swann Insurance's SIS system. The products are selected at the quote stage, and currently include Tyre and Rim, and Extended Warranty. This interface is a direct replacement for Swann's Activ8 system.

Accepting a quote with one of the support products selected creates a special Contract Event that contains a unique proposal number. The event codes include:

SWANTRPN - Tyre and RimSWANEWPN - Extended WarrantySWANWAPN - Walkaway

Where 'PN' stands for Proposal Number.

Once the proposal has been sent and additional Contract Event is created to record the event and to prevent the proposal from being sent again. The event codes for these events include:

SWANTRPS - Tyre and RimSWANEWPS - Extended WarrantySWANWAPS - Walkaway

Where 'PS' stands for Proposal Sent.

See Swann Interface for further details on this interface and Swann Interface Setup for a checklist of set-up items.

Warning: This Job Type requires additional set-up. You will need to contact Catch-e at [mailto:support@catch-e.com.au], and Swann Insurance help set this up.

Parameters

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

Fm swann importPolicies

This job type is an interface used to import Policy Documents from Swann Insurance's SIS system. A Contract Event is created for each Policy Document imported, with the Policy Document (PDF) attached. The event code used depends on the product type:

SWANTRPR - Tyre and RimSWANEWPR - Extended WarrantySWANWAPR - Walkaway

See Swann Interface for further details on this interface and Swann Interface Setup for a checklist of set-up items.

Warning: This Job Type requires additional set-up. You will need to contact Catch-e at [mailto:support@catch-e.com.au], and Swann Insurance help set this up.

Fm swann importVehicles

This job type is an interface used to import Swann Vehicle Reference data into the fmswannvehicles table. This data is used by the exportProposals) job when creating Extended Warranty proposal documents.

See Swann Interface for further details on this interface and Swann Interface Setup for a checklist of set-up items.

Warning: This Job Type requires additional set-up. You will need to contact Catch-e at [mailto:support@catch-e.com.au], and Swann Insurance help set this up.

Fm billings

Fm financier rates

This table contains rates per financier and per lease term.

Go to the Financier page for a complete list of steps to follow to set-up a new financier.

Filters

• Financier Code (Lookup) — Enter a code or look up the financier record and press Go to return records for a particular financier. Leave this field empty and press Go to see all stored records.

Field Descriptions

Warning: Note: The Lower and Upper Limits do not work. Only one Interest Rate per Financier/Term can be applied.

• ID (Num) — Unique identifier for this record. This is a display-only field.
• Financier (Text) — Enter the "Supplier Code" of the financier you are adding a record for.
• Name (Text) — Displays the "Name" of the financier
• Term (Num) — Enter the term that the interest rate applies for. "Term" cannot be 0. This will be used on quotes that have a term that is on or below this term. E.g. a quote with a "Term" of '13' would use the interest rate stored on the record where "Term" is '24'.
• Lower Limit (Num) — Defaults to 0.The Lower and Upper Limits do not work. Only one Interest Rate per Financier / Term can be applied.
• Upper Limit (Num) — Mandatory, e.g. 9,999,999,999.99
• Interest Rate (% (4dp)) — Enter the Interest Rate to be used. This will populate into quotes that have a matching financer and term as the Quotes / Finance "Base Rate".
• Effective (Date) — Enter the effective date for new records. The date defaults to today's date, but this can be edited. When records are being matched to a quote, the record with a date that is on or before the quote's "Effective Date" will be selected.

Action Buttons

• — Press 'Go' to execute your chosen filtering. The page will refresh with the selected transactions and these can be viewed page by page. If 'Go' is greyed out, then the current filtering has been executed.
• — Press 'Edit' to adjust a record. We recommend only using this to correct errors in a record you have created.
• — Press 'New' to create a new record. Do this when making a change to the values that will default into a quote. Creating a new record for each change will allow you to filter and review changes you have made to each Financier / Term combination over time.

Validations and Alerts

Fm payments autoPostPayments

• Module — Choose 'sp' from the listbox.
• Class — Choose 'payments' from the list box.
• Method — Choose 'autoPostPayments' from the list box.
• Description — ‘Salary Packaging Disbursement Payments’ will be a default entry when “Method” = ‘autoPostPayments’
• Bank Account — Single Bank Account – where only one bank account is in use, this field will be a read-only display of the bank account name. Multiple Bank Accounts – where multiple bank accounts are in use, this field will default to ‘—All—’ where one of the multiple accounts can then be selected from a drop list. '--All--' can be saved as a selection.
• Delivery — Select 'Email' or 'Post'. Select the delivery type you need. If you are creating a job for a specific supplier, the "Delivery" selection must match the suppliers "Payment Delivery Type". If it does not, the job will run, but nothing will happen. If the delivery method is 'Email', emails will be sent and can be viewed from the Mail Queue screen. If the supplier's email address is blank, the job will still run, but the email will be in the Mail Queue with a 'Failed' status. If the delivery method is 'Post', no output files will be generated by the job. You can get the remittance advice PDF from the Payments / Periodic screen at any time.
• Dated To Method — Choose the method and day you want to determine the date that will be used to select records for payment. The options are “Run Date”, “Common Day” and “Run Date Plus”. Visit the Dated To Method page for more details.
• Dated To Day — If the "Dated To Method" is 'Run Date', the "Day" drop list is not available. If the "Dated To Method" is 'Common Day', choose from 1st - 31st or EOM from the drop list. If the "Dated To Method" is 'Run Date Plus', choose from days 1-31 from the drop list.
• Dated To — “Dated To” is calculated using the next 'pending' job in gbschedulerqueue. On clicking Edit any 'pending' jobs are deleted so "Dated To" cannot be calculated and it takes up to a minute on Save for the scheduler to tick over and create the next 'pending' job. When there are no 'pending' jobs "Next Due" has the value 'unavailable'. In ‘New’ mode the “Dated To” field will be blank In ‘Edit’ mode the “Dated To” field will be non-editable – display only.
• Run Times — We recommend you set these jobs to run out of business hours.

Fm payments periodic

Use this job type if you want to schedule payments to be posted instead of running the process manually from the Payments / Periodic screen.
If the supplier is set-up to receive a remittance advice by email, the email will be sent when the job is run.

Parameters

The parameters below are displayed on the Scheduler / Job tab when this Method has been selected.

• Module — Choose 'fm' from the listbox.
• Class — Chosse 'payments' from the listbox.
• Method — Choose 'periodic' from the listbox.
• Payment Type — Select the payment type you want to use. This is the same list as shown on the Payments / Periodic screen. A job can only post for one payment type. If 'Sundry Payment' is selected as the payment type, a 'Class' dropdown list will appear for selection. Supplier Code This displays as '--All--' and is disabled until you have selected a "Payment Type". You can leave this as '--All--', or you can select a specific supplier from the listbox. The listbox is limited to suppliers that have payment records stored against the payment type you have chosen. If you want to post payments for more than one supplier, set-up a separate job for each supplier.
• Bank Account — Single Bank Account – where only one bank account is in use, this field will be a read-only display of your bank account name. Multiple Bank Accounts – where multiple bank accounts are in use, this field will default to ‘—All—’ where one of the multiple accounts can then be selected from a drop list. '--All--' cannot be saved as a selection. Delivery Select 'Email' or 'Post'. If you are creating a job for a specific supplier, the "Delivery" selection must match the suppliers "Payment Delivery Type". If it does not, the job will run, but nothing will happen. If the delivery method is 'Email', emails will be sent and can be viewed from the Mail Queue screen. If the supplier's email address is blank, the job will still run, but the email will be in the Mail Queue with a 'Failed' status. If the delivery method is 'Post', no output files will be generated by the job. You can get the remittance advice PDF from the Payments / Periodic screen at any time.
• Dated To Method — Choose the method and day you want to determine the date that will be used to select records for payment. The options are “Run Date”, “Common Day” and “Run Date Plus”. Visit the Dated To Method page for more details.
• Dated To Day — If the "Dated To Method" is 'Run Date', the "Day" drop list is not available. If the "Dated To Method" is ‘Common Day Past’, choose from 1st - 31st or EOM from the drop list. If the "Dated To Method" is 'Common Day Future', choose from 1st - 31st or EOM from the drop list. If the "Dated To Method" is 'Run Date Plus', choose from days 1-31 from the drop list. Dated To This is a calculated date that shows the next selection date that will be used by the job. This is calculated based on the scheduled run time of the next pending job which is shown in the "Next Due" field. When this job has been created or edited, the "Dated To" and "Next Due" dates are recalculated. Until this done, the "Dated To" field will be blank and "Next Due" field will display as 'unavailable'. This can take a minute, so be patient!
• Run Times — We recommend you set these jobs to run out of business hours.

Validations and Alerts