Contracts

For more details on contracts please refer to the help article.

The contract object represents recurring financial commitments such as recurring budgets. Recurring commitments are either created automatically or triggered manually.

Please note that we rate limit POST requests for generating recurring budgets to 50 requests per minute.

Attributes

contract_interval_id integer
Parameter `filter`

ID of the recurrence interval (e.g. monthly, quarterly, annually) for this contract.

copy_expenses boolean
Response Request

Whether to copy expenses from the template.

copy_purchase_order_number boolean
Response Request

Whether to copy the purchase order number.

ends_on string
Response Request Parameter `filter`

Date when this contract ends, or null if it has no end date.

id integer
Parameter `filter`

The unique identifier of this contract.

interval_id integer
Response Request

ID of the recurrence interval of this contract (alias for contract_interval_id).

next_occurrence_on string
Response Request Parameter `filter`

The date of the next occurrence.

organization organization
Response

The organization this contract belongs to.

starts_on string
Response Parameter `filter`

Date when this contract starts.

template deal
Response

The budget used as the template for generating new budgets from this contract.

template_id object
Request

ID of the budget used as the template for generating new budgets from this contract.

use_rollover_hours boolean
Response Request

Whether to roll over unused hours.