Skip to main content

Invoice Default Description Item Customisation

Invoice descriptions can be set with a custom default format, using useful tags to pull the appropriate data from ShiftCare

Written by Andrew

Overview

Invoice descriptions are essential in accurately conveying the services provided for both client and carer. Through account settings, you can set up the default format for your invoice descriptions, while also using convenient tags that reference shift and client information.

Edit Default Descriptions

First, navigate to Account > Invoice Settings. Read this complete guide on Setting Up and Customising Invoice Settings for more information on this page.

Click 'Edit' in the Invoices section.

Scroll down to 'Invoice item default format'. The next setting, 'Fixed Recurring Invoice item default format', works the same way, but for recurring invoices. Read this guide for more information on Recurring Billing.

The setting is filled with a default format that looks like this:

{client} @ {shift_date} {shift_start_time} - {shift_end_time} [{price_book}] [{price_ref_no}]

This yields an example invoice description that looks like this:

The description syntax tags must be used with brackets { } enclosing each item. Any text outside of this parameter will appear as text only. Thus, you can choose to further format the code with other punctuation and symbols.

An example using the default tags, with a formatting variation:

{client} [{price_book}]: {shift_start_time} - {shift_end_time} on {shift_date}. Support code: {price_ref_no}

This yields an example description such as:

The text can say anything you want, but to use data from ShiftCare, official description tags must be used.

To view these official description tags, click the 'question mark (?)' next to the heading. This will open a menu where you can copy and paste the tags you want to include in your invoices.

Description Tags

These tags must be used exactly as they appear in this list to correctly display the relevant data, always with curly brackets { } around the text. The above examples showed how the tags are interpreted.

{client} - Name of client

This is the name of the client for whom the invoice is being generated.

{shift_date} - Date of the shift

This will be the date of the shift for each unique line item in the invoice.

{shift_day} - Day of the shift

This will be the day of the week (Monday, Tuesday, etc.) the shift falls on.

{shift_start_time} {shift_end_time} - Start time - End time

The time period of the shift for each unique line item in the invoice.

{price_book} - Price book name

Name of the price book attached to the shift:

{price_ref_no} - Price reference number

Reference number from the price book attached to the shift:

{client_ndia_no} - Client NDIA number

This information can be found in the Client's Details Page.

{client_ref_no} - Client reference number

This information can be found in the Client's Details Page.

{client_type} - Client type

This information can be found in the Client's Details Page.

{carers} - List of carers

The carers that were assigned for the shift for each unique line item in the invoice. Listed with a comma between names.

{shift_type} - Shift Type setting

This is taken from the shift's settings.

{address} - Shift address

Where the shift took place.

{rate} - the amount charged for the shift

The rate displayed is either the fixed cost of the shift for fixed price books or the hourly charge for the shift.

{ratio} - the ratio set via advanced edit mode

The ratio selected for the shift or split is shown when this is entered.

{quantity} - either the number of hours or 1 for fixed price shifts

When a time-based price book is used, the number of ours is output. If it is a fixed price cost then 1 is output.


{client_expense} - expense description

This is taken from the expense description field.

{fund_name} - Fund name

The name of the fund attached to the shift.

Further reading


For further assistance with Invoice Default Description Item Customisation, please contact our Support team using online chat when you're logged into ShiftCare or email our Support team at support@shiftcare.com.

Did this answer your question?