Skip to main content

List job order categories

GET 
/api/job-order-categories

Required permissions:

  • settings.company: allows view of company job order categories.

Here the dedicated support page.

Request​

Query Parameters

    limit integer

    Possible values: <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items updated on a date.

    Example: 2024-01-01T20:00:00%2B02:00

    deleted string

    Possible values: [exclude, include, only]

    Default value: exclude

    Filter items by deletion status.

    Examples:

    Exclude soft-deleted records.

    Example: exclude

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of job order categories set for the company.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    name stringrequired

    Possible values: <= 50 characters

    The job order category name

    color stringrequired

    Possible values: <= 50 characters

    The job order category RGB color

    is_chargeable booleanrequired

    Whether the job order category is chargeable

    is_allocation_request_required booleanrequired

    Whether plannings on projects with this job order category must be approved

    is_planning_allowed_to_everybody booleanrequired

    Whether everybody can plan projects with this job order category, regardless of their permissions

    is_planning_unlimited booleanrequired

    Whether projects with this job order category have unlimited planning

    hours_type string

    The type of hours worked on projects with this job order category

    is_program_required booleanrequired

    Whether projects with this job order category must be in a program

    is_budget_invoice_driven booleanrequired

    Whether projects with this job order category use invoice-driven budget

    is_capex booleanrequired

    Whether projects with this job order category are capex

    external_costs_type stringrequired

    Possible values: [on-goods-sold, before-contribution-margin, on-g-and-a, on-marketing]

    The type of external costs for projects with this job order category

    is_won_lost_feedback_required booleanrequired

    Whether projects with this job order category track won/lost feedback

    is_opportunity_status_tracking_enabled booleanrequired

    Whether projects with this job order category track opportunity status

    is_timesheet_automatic booleanrequired

    Whether projects with this job order category use automatic timesheets

    is_external_drive_canvas_enabled booleanrequired

    Whether projects with this job order category use external drive canvas

    project_status_mode stringrequired

    Possible values: [automatic, percentage, remaining-days]

    The project status mode for projects with this job order category

    is_project_review_required booleanrequired

    Whether projects with this job order category require a review after being archived

    project_review_value_threshold integer

    The minimum project value in K to require a review after being archived

    job_order_category_group_id integerrequired

    The ID of the job order category group

    job_order_template_id integer

    The ID of the job order template

    deleted_at date-time

    The date and time when the resource was deleted

  • ]

Loading...