User Guide
On this page:
Clients
With SLA Invoice Manager you can manage all your clients in one overview.
Creating a Client
To create a new client:
- Log in as a user that is a member of the group configured as Contract administrator
- Choose Clients & contracts
- In the top right corner select the button 'Create client'
- Enter the name of the client
- Select 'Save'
Editing a client
- Log in as a user that is a member of the group configured as Contract administrator
- Choose Clients & contracts
- Click the 'edit' button in the corresponding row
- Change the Client name
- Select Save to store the changes or,
- Select Cancel to restore the original value and return to the overview
Deleting a client
In order to be able to delete a client you must first delete any related data (contracts, invoices). To remove a client:
- Log in as a user that is a member of the group configured as Contract administrator
- choose Clients & contracts
- Click the 'delete' button in the corresponding row
- Select Delete to confirm and delete the client or,
- select Cancel to return to the overview
Contracts
With SLA Invoice Manager its possible to create contracts for your clients.
Invoicing periods
A contract is divided in invoicing periods, an invoicing period is a period in the contract where a certain amount of work is done for the client and invoiced.
Its possible to create a contract for following periods:
- Monthly
- Quarterly
- Per 6 months
- Annually
An example:
If you have a contract starting from till and Monthly as invoice base, four invoicing periods will be created.
Period one from till
Period two from till
Period three from till
Period four from till
Your client will see a section called Invoicing period in his ticket. Here he can see how many time has been spent on his issues and how many time he has left inside the current invoicing period.
If the client exceeded the invoicing period the following will be displayed for the contract
Creating a Contract
A contract contains the following properties:
JQL
JIRA query language, used as issue filter for the contract.
Make sure that your JQL filter has no overlap with other contracts.
Contract type
The type of contract (fixed price, hour based)
Start date
The start date for the contract
End date
The end date for the contract
Invoice base
The period used to create the invoicing periods (from start date till end-date)
Base fee
Fixed price charged per invoicing period
Hourly rate
Cost per hour inside contract (available for Contract type hour based)
Rate outside contract
Cost per hour outside contract (available for Contract type hour based)
Hours included
Hours included in contract (available for Contract type hour based)
Rounding factor
Minimum number of minutes, spent on a issue. E.g 3m -> 15m
To create a new fixed price contract:
- Log in as a user that is a member of the group configured as Contract administrator
- Choose Clients & contracts
- Click on the row from the client
- In the top left corner select the button 'Create contract'
- Select Fixed price
- Click the Next button
- Enter the JQL you want as issue filter for the contract
- Use the date picker to select a start date
- Use the date picker to select a end date
- Select the invoice base
- Enter the base fee
- Fill in the rounding factor
- Select Save or,
- Select Cancel to close the dialog and return to the overview
To create a new hour based contract:
- Log in as a user that is a member of the group configured as Contract administrator
- Choose Clients & contracts
- Click on the row from the client
- In the top left corner select the button 'Create contract'
- Select Hour based
- Click the Next button
- Enter the JQL you want as issue filter for the contract
- Use the date picker to select a start date
- Use the date picker to select a end date
- Select the invoice base
- Fill in the base fee
- Fill in the hourly rate
- Fill in the rate outside contract
- Fill in the hours included
- Fill in the rounding factor
- Select Save or,
- Select Cancel to close the dialog and return to the overview
Deleting a Contract
To delete a contract:
- Log in as a user that is a member of the group configured as Contract administrator
- Choose Clients & contracts
- Click on the row from the client you want to view
- In the top left corner select the Contract you want to view
- In the top right corner select the button 'Delete contract'
- Select Delete to confirm to delete the Contract or,
- Select Cancel to close the dialog and return to the overview
Terminate a Contract
If you want to terminate a contract before its original end date you can change the end date with the Terminate option.
To terminate a contract:
- Log in as a user that is a member of the group configured as Contract administrator
- Choose Clients & contracts
- Click on the row from the client you want to view
- In the top left corner select the Contract you want to terminate
- In the top right corner select the button 'Terminate contract'
- Use the date picker to select a new end date
- Select Terminate to confirm the new end date for the contract or,
- Select Cancel to close the dialog and return to the overview
Hour management
Approving hours
To approve hours:
- Log in as a user that is a member of the group configured as Manager
- Choose Approve hours
- Press on the contract to start approving hours.
- Select the worklogs you want to approve
- Enter the time you want to invoice (default set to time spent)
- Select Approve to confirm and approve the hours or,
- Select Cancel to close the dialog and return to the overview
Disapproving hours
To disapprove previously approved hours:
- Log in as a user that is a member of the group configured as Manager
- Choose Approve hours
- Click Disapprove on contract row in the previously approved section.
Invoices
Generating an Invoice
To generate a new invoice:
- Log in as a user that is a member of the group configured as Financial administrator
- Choose Generate invoices
- Press on the contract to generate an invoice
- Select the hours and bundles you want to invoice
- Select Generate to confirm and generate an invoice or,
- Select Cancel to close the dialog and return to the overview
Deleting an Invoice
To delete a invoice:
- Log in as a user that is a member of the group configured as Financial administrator
- Choose Clients & contracts
- Click on the client you want to view
- In the top left corner select the Contract you want to view
- Click on the invoice you want to view
- In the top right corner select the button 'Delete'
- Select Delete to confirm and delete the invoice or,
- Select Cancel to close the dialog and return to the overview
Printing an Invoice
There are two printing options available:
Print for client
This option can be used if you want to print an invoice for a client. This option hides fields that the client doesn't need to see. The following fields will be printed:
- Type
- Ticket
- Date
- Time to invoice
- Cost
Print full
If you want to print a invoice for the administration you can use this option. The following fields will be printed:
- Type
- Ticket
- Date
- Time to invoice
- Time contract
- time spent
- By
- Cost
To print an Invoice:
- Log in as a user that is a member of the group configured as Financial administrator
- Choose Clients & contracts
- Click on the client you want to view
- In the top left corner select the Contract you want to view
- Click on the invoice you want to view
- Click on one of the two print buttons in the top right corner (depending on the type of print you want)
- Print the invoice
Generating a CSV
Its possible to generate a CSV file for an invoice.
To generate a CSV file:
- Log in as a user that is a member of the group configured as Financial administrator
- Choose Clients & contracts
- Click on the client you want to view
- In the top left corner select the Contract you want to view
- Click on the invoice you want to view
- Click on one the button CSV in the top right corner to generate a CSV