Contracts (also known as retainers) are ideal for managing recurring client work, maintenance quotas or periodic invoicing - such as licence fees.
A retainer is created against a company/client record, and work is tracked against the retainer through periods. You can configure your retainer to automatically create periods at certain intervals, and invoice up-front for a fixed amount or at the end of the period for the work done.
The retainers modules integrates seamlessly with the issues and projects modules so that you can even allocate work from those into a retainer period.
| TYPE | RESOURCE | DESCRIPTION |
|---|---|---|
| GET | /contracts/:id/extensions/values | Returns a list of extension values |
| GET | /contracts/ | Returns a list of contracts |
| GET | /contracts/:id | Returns a specific contract object |
| GET | /contracts/count | Returns the total count of contracts |
| GET | /contracts/:id/periods | Returns an array of periods for a given contract object |
| GET | /contracts/periods/:period_id | Returns a specific contract period object. |
| PUT | /contracts/:id/extensions/values/:extension_value_id | Update a contract's extension value |
| GET | /contracts/:id/progressions | Returns an array of available progressions for the contract. |
| [PUT|POST] | /contracts/:id/progressions/:progression_id/auto | Runs a status update for the given progression on the given contract. |
| GET | /contracts/extensions/fields | Returns a list of extension fields. |
| POST | /contracts/:contract_id/extensions/fields/:extension_field_id | Create an extension value for a contract. |