Columns
| Column | Type | Children | Parents | Comments |
|---|---|---|---|---|
| id | int8 |
|
|
|
| timeframe | varchar |
|
|
The specificity of the scheduled timeframe. @example ‘specific’, ‘no’ |
| start_date | date |
|
|
The start date of a specific timeframe. @example ‘2025-01-01’ |
| end_date | date |
|
|
The end date of a specific timeframe. @example ‘2025-01-01’ |
| start_time | time |
|
|
The start date of a specific timeframe. @example ‘13:00’ |
| end_time | time |
|
|
The end date of a specific timeframe. @example ‘15:00’ |
| beginning_at | timestamp |
|
|
The start timestamp of a specific timeframe. @example ‘2025-01-01T10:00:00Z’ |
| ending_at | timestamp |
|
|
The end timestamp of a specific timeframe. @example ‘2025-01-01T10:00:00Z’ |
| duration | interval |
|
|
An optional duration of a service within a timeframe. @example ‘1 hour’ |
| interval | varchar |
|
|
An interval this service repeats on. @example ‘weekly’, ‘monthly’ |
| interval_frequency | int4 |
|
|
The frequency of the interval this service repeats on. @example ‘1’, ‘2’ |
| interval_end_date | date |
|
|
An optional end date for a repeating interval. @example 2025-01-31 |
| weekdays | _varchar |
|
|
The weekdays a weekly interval repeats on. @example ‘mon,wed,fri’ |
| provisional_price_cents | int4 |
|
|
An optional provisional price in cents. @example 1500 |
| provisional_price_currency | varchar |
|
|
The provisional price currency code. @example ‘AUD’ |
| created_at | timestamp |
|
|
|
| updated_at | timestamp |
|
|
|
| company_id | int8 |
|
|
The foreign key to the company record. @example 1 |
| budget_id | int8 |
|
|
The foreign key to the budget record. @example 1 |
| product_id | int8 |
|
|
An associated rate used in combination with duration. @example 1 |
| daily_amount_cents | int4 |
|
|
The calculated daily amount for this service_plan. @example 1500 |
| daily_amount_currency | varchar |
|
|
The calculated daily amount currency code. @example ‘AUD’ |
| exclude_public_holidays | bool |
|
|
Whether or not public holidays are excluded from this service plan @example: true |
| excluded_dates | _varchar |
|
|
Array of dates excluded from this service plan @example: ‘2025-1-1’ |
| public_holiday_product_id | int8 |
|
|
Optional reference to the product that takes effect on public holidays. @example 1 |
| public_holiday_provisional_price_cents | int4 |
|
|
An optional public holiday provisional price in cents. This only applies to occurrences happening on public holidays. @example 1500 |
| public_holiday_provisional_price_currency | varchar |
|
|
The public holiday provisional price currency code. @example ‘AUD’ |
| product_price_cents | int4 |
|
|
The suggested price cloned from the associated product at the time the service plan is saved. @example 1500 |
| product_price_currency | varchar |
|
|
The product price currency code. @example ‘AUD’ |
| product_quantity_type | varchar |
|
|
The quantity type cloned from the associated product at the time the service plan is saved. @example ‘AUD’ |
| public_holiday_product_price_cents | int4 |
|
|
The suggested price cloned from the associated public holiday product at the time the service plan is saved. @example 1500 |
| public_holiday_product_price_currency | varchar |
|
|
The public holiday product price currency code. @example ‘AUD’ |
| public_holiday_product_quantity_type | varchar |
|
|
The quantity type cloned from the associated public holiday product at the time the service plan is saved. @example ‘AUD’ |
| quantity | numeric |
|
|
The quantity for the service plan (hours/units/items). Used in combination with rates as appropriate. @example 1.25 |
| external_id | text |
|
|
A specific external id, or item code as applicable for the budget’s funding scheme @example ‘SERV-0001’ |
| daily_client_contribution_amount_cents | int4 |
|
|
The calculated daily client contribution amount for this service_plan. @example 1500 |
| daily_client_contribution_amount_currency | varchar |
|
|
The calculated daily client contribution amount currency code. @example ‘AUD’ |
| provider_travel_distance_rate_id | int8 |
|
|
The provider travel distance rate associated with this service plan. @example 1 |
| provider_travel_distance | int4 |
|
|
The distance applied to the provider travel distance rate quantity type. @example 1.5 |
| provider_travel_distance_rate_price_cents | int4 |
|
|
The suggested price cloned from the associated provider travel distance rate at the time the service plan is saved. @example 1500 |
| provider_travel_distance_rate_price_currency | varchar |
|
|
The provider travel distance rate currency code. @example ‘AUD’ |
| provider_travel_distance_rate_quantity_type | varchar |
|
|
The quantity type cloned from the associated provider travel distance rate at the time the service plan is saved. @example ‘per_hour’ |
| provider_travel_time_rate_id | int8 |
|
|
The provider travel time rate associated with this service plan. @example 1 |
| provider_travel_time | interval |
|
|
The time applied to the provider travel time rate quantity type. @example 30 minutes |
| provider_travel_time_rate_matches_time_rate | bool |
|
|
The suggested price cloned from the associated provider travel time rate at the time the service plan is saved. @example 1500 |
| provider_travel_time_rate_price_cents | int4 |
|
|
The suggested price cloned from the associated provider travel time rate at the time the service plan is saved. @example 1500 |
| provider_travel_time_rate_price_currency | varchar |
|
|
The provider travel time rate currency code. @example ‘AUD’ |
| provider_travel_time_rate_quantity_type | varchar |
|
|
The quantity type cloned from the associated provider travel time rate at the time the service plan is saved. @example ‘per_hour’ |
| client_transport_rate_id | int8 |
|
|
The client transport rate associated with this service plan. @example 1 |
| client_transport_distance | int4 |
|
|
The distance applied to the client transport rate quantity type. @example 1.5 |
| client_transport_rate_price_cents | int4 |
|
|
The suggested price cloned from the associated client transport rate at the time the service plan is saved. @example 1500 |
| client_transport_rate_price_currency | varchar |
|
|
The client transport rate currency code. @example ‘AUD’ |
| unit_type | varchar |
|
|
The unit type of the service plan @example: ‘hours’ |
| beginning_at_in_company_tz | timestamp |
|
|
|
| ending_at_in_company_tz | timestamp |
|
|
|
| created_at_in_company_tz | timestamp |
|
|
|
| updated_at_in_company_tz | timestamp |
|
|
|
| company_timezone | varchar |
|
|
The company timezone. E.g. |
Indexes
| Constraint Name | Type | Sort | Column(s) |
|---|---|---|---|
| 087042380447efa006fd4843d03f133d | Performance | Asc | provider_travel_time_rate_id |
| 24a58834bbdb0b12f58c0f3e3257f8f5 | Performance | Asc | external_id |
| 265a67e5e5c952de7bb40bbd55885f6e | Performance | Asc | product_id |
| 309b17769c550d11ac40424ea759d750 | Performance | Asc | public_holiday_product_id |
| 7cbb445734fa7a155651e926ecf19cae | Performance | Asc | provider_travel_distance_rate_id |
| a0d9d7b3711713f82d112cbf14fa0bea | Performance | Asc | company_id |
| a660f03e40ed1b1030eb61496bc5eab5 | Performance | Asc | budget_id |
| b0cd8799cd2d7bf50c5cfe7564e53080 | Performance | Asc | client_transport_rate_id |