> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zivio.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Milestones

> Retrieve a paginated list of milestones. Use filters to narrow results.

## Filtering

Use the `filter[<attribute>]` parameter to filter results. Multiple filters are combined with AND logic.

### Basic Examples
```
# Equality (implicit)
GET /api/v4/milestones?filter[status]=open

# Multiple values (implicit IN)
GET /api/v4/milestones?filter[status]=open,approved

# With explicit operator
GET /api/v4/milestones?filter[created_at][gte]=2024-01-01

# Range query
GET /api/v4/milestones?filter[rate][between]=1000000,5000000

# Multiple filters (AND)
GET /api/v4/milestones?filter[status]=open&filter[rate][gte]=1000000
```

### Available Attributes

| Attribute | Type | Operators | Permitted Values |
|-----------|------|-----------|------------------|
| active | boolean | `eq` | `true`, `false` |
| approved_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| approved_by_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| client_suggested | boolean | `eq`, `not_eq` | - |
| close_project | boolean | `eq`, `not_eq` | - |
| comments | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| created_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| delivered_on | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| details | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| due_on | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| final_claim | boolean | `eq`, `not_eq` | `true`, `false` |
| id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| interim_valuation_date | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| level_1_approved_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| level_1_approved_by_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| mandatory | boolean | `eq`, `not_eq` | - |
| notes | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| original_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| original_rate | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| overdue | boolean | `eq` | `true`, `false` |
| project_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| purchase_order_line_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| rate | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| rate_ccy | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| rejected_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| rejected_by_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| status | string | `eq`, `not_eq`, `in`, `not_in` | `open`, `submitted`, `approved`, `rejected`, `change_requested`, `on_hold`, `draft`, `cancelled`, `level_1_approved`, `closed` |
| submitted_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| tiered_markup_fee | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| title | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| updated_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |

### Custom Fields

This resource supports custom field filtering using `cf[key]` syntax:
```
# Equality
GET /api/v4/milestones?cf[priority]=high

# With operator
GET /api/v4/milestones?cf[department][in]=engineering,design

# Check existence
GET /api/v4/milestones?cf[priority][exists]=

# Negation
GET /api/v4/milestones?cf[priority][not_eq]=low
```

### OR Conditions

Use `or[group]` to combine filter groups with OR logic. Filters within a group are ANDed:
```
# Simple OR
GET /api/v4/milestones?or[1][status]=submitted&or[2][status]=open

# Complex OR (status=submitted AND rate>=1000000) OR (status=open)
GET /api/v4/milestones?or[1][status]=submitted&or[1][rate][gte]=1000000&or[2][status]=open
```

## Sorting

Use `sort[<attribute>]` to order results. Default direction is ascending.
```
# Ascending (implicit)
GET /api/v4/milestones?sort[created_at]=

# Descending
GET /api/v4/milestones?sort[created_at]=desc

# Combined with filters
GET /api/v4/milestones?filter[status]=open&sort[created_at]=desc
```



## OpenAPI

````yaml /api-reference/v4/openapi.json get /milestones
openapi: 3.1.0
info:
  title: API V4
  version: '4'
  description: >-
    OAuth 2.0 secured API. Obtain an access token using client credentials to
    access protected endpoints. The regional endpoints listed below serve every
    Zivio organisation, so each request — including the token request — must
    carry a `zivio-tenant-id` header identifying yours. Requests without it are
    rejected with a 404 before any token is checked.
  contact:
    name: API Support
    email: support@zivio.com
servers:
  - url: https://api.zivio.net/api/v4
    description: Global API Router
  - url: https://api.eu.zivio.net/api/v4
    description: EU Data Region
  - url: https://api.uk.zivio.net/api/v4
    description: UK Data Region
  - url: https://api.us.zivio.net/api/v4
    description: US Data Region
security:
  - oauth2: []
    tenantId: []
paths:
  /milestones:
    get:
      tags:
        - Milestones
      summary: List Milestones
      description: >-
        Retrieve a paginated list of milestones. Use filters to narrow results.


        ## Filtering


        Use the `filter[<attribute>]` parameter to filter results. Multiple
        filters are combined with AND logic.


        ### Basic Examples

        ```

        # Equality (implicit)

        GET /api/v4/milestones?filter[status]=open


        # Multiple values (implicit IN)

        GET /api/v4/milestones?filter[status]=open,approved


        # With explicit operator

        GET /api/v4/milestones?filter[created_at][gte]=2024-01-01


        # Range query

        GET /api/v4/milestones?filter[rate][between]=1000000,5000000


        # Multiple filters (AND)

        GET /api/v4/milestones?filter[status]=open&filter[rate][gte]=1000000

        ```


        ### Available Attributes


        | Attribute | Type | Operators | Permitted Values |

        |-----------|------|-----------|------------------|

        | active | boolean | `eq` | `true`, `false` |

        | approved_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |

        | approved_by_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`,
        `gte`, `lt`, `lte`, `between` | - |

        | client_suggested | boolean | `eq`, `not_eq` | - |

        | close_project | boolean | `eq`, `not_eq` | - |

        | comments | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`
        | - |

        | created_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |

        | delivered_on | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |

        | details | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`
        | - |

        | due_on | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |

        | final_claim | boolean | `eq`, `not_eq` | `true`, `false` |

        | id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`,
        `lte`, `between` | - |

        | interim_valuation_date | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`,
        `lte`, `between` | - |

        | level_1_approved_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`,
        `lte`, `between` | - |

        | level_1_approved_by_id | integer | `eq`, `not_eq`, `in`, `not_in`,
        `gt`, `gte`, `lt`, `lte`, `between` | - |

        | mandatory | boolean | `eq`, `not_eq` | - |

        | notes | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` |
        - |

        | original_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`,
        `lt`, `lte`, `between` | - |

        | original_rate | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`,
        `lt`, `lte`, `between` | - |

        | overdue | boolean | `eq` | `true`, `false` |

        | project_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`,
        `lt`, `lte`, `between` | - |

        | purchase_order_line_id | integer | `eq`, `not_eq`, `in`, `not_in`,
        `gt`, `gte`, `lt`, `lte`, `between` | - |

        | rate | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`,
        `lte`, `between` | - |

        | rate_ccy | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`
        | - |

        | rejected_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |

        | rejected_by_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`,
        `gte`, `lt`, `lte`, `between` | - |

        | status | string | `eq`, `not_eq`, `in`, `not_in` | `open`,
        `submitted`, `approved`, `rejected`, `change_requested`, `on_hold`,
        `draft`, `cancelled`, `level_1_approved`, `closed` |

        | submitted_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |

        | tiered_markup_fee | money | `eq`, `not_eq`, `in`, `not_in`, `gt`,
        `gte`, `lt`, `lte`, `between` | - |

        | title | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` |
        - |

        | updated_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |


        ### Custom Fields


        This resource supports custom field filtering using `cf[key]` syntax:

        ```

        # Equality

        GET /api/v4/milestones?cf[priority]=high


        # With operator

        GET /api/v4/milestones?cf[department][in]=engineering,design


        # Check existence

        GET /api/v4/milestones?cf[priority][exists]=


        # Negation

        GET /api/v4/milestones?cf[priority][not_eq]=low

        ```


        ### OR Conditions


        Use `or[group]` to combine filter groups with OR logic. Filters within a
        group are ANDed:

        ```

        # Simple OR

        GET /api/v4/milestones?or[1][status]=submitted&or[2][status]=open


        # Complex OR (status=submitted AND rate>=1000000) OR (status=open)

        GET
        /api/v4/milestones?or[1][status]=submitted&or[1][rate][gte]=1000000&or[2][status]=open

        ```


        ## Sorting


        Use `sort[<attribute>]` to order results. Default direction is
        ascending.

        ```

        # Ascending (implicit)

        GET /api/v4/milestones?sort[created_at]=


        # Descending

        GET /api/v4/milestones?sort[created_at]=desc


        # Combined with filters

        GET /api/v4/milestones?filter[status]=open&sort[created_at]=desc

        ```
      operationId: getMilestones
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          description: Page number for pagination
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
            maximum: 100
          description: Number of results per page (max 100)
        - name: filter[<attribute>]
          in: query
          style: deepObject
          explode: true
          schema:
            type: object
          description: >-
            Filterable attributes:


            **integer** (operators: eq, not_eq, in, not_in, gt, gte, lt, lte,
            between): approved_by_id, id, level_1_approved_by_id, original_id,
            project_id, purchase_order_line_id, rejected_by_id

            **datetime** (operators: eq, not_eq, gt, gte, lt, lte, between):
            approved_at, created_at, delivered_on, due_on,
            interim_valuation_date, level_1_approved_at, rejected_at,
            submitted_at, updated_at

            **string** (operators: eq, not_eq, in, not_in, like, not_like):
            comments, details, notes, rate_ccy, status (one of: open = open and
            not yet submitted to client; submitted = submitted to client;
            approved = fully approved. final state.; rejected = rejected by
            client; change_requested = change requested by client; on_hold = on
            hold. not currently active.; draft = saved by supplier, not yet
            submitted to client; cancelled = cancelled by client;
            level_1_approved = passed first-level approval, awaiting final
            approval; closed = closed by client), title

            **money** (operators: eq, not_eq, in, not_in, gt, gte, lt, lte,
            between): original_rate, rate, tiered_markup_fee

            **boolean** (operators: eq, not_eq): active (one of: true = in
            flight — status open, submitted, rejected, change_requested or
            level_1_approved; false = finalised or not in flight — status
            approved, cancelled, closed, draft or on_hold), client_suggested,
            close_project, final_claim (one of: true = supplier declared this
            the final claim; the milestone is settled at the claimed amount
            (which may be less than the original) with no remainder; false =
            interim claim; the unclaimed remainder was split off into a new
            milestone), mandatory, overdue (one of: true = active milestone
            (open, submitted, rejected, change_requested or level_1_approved)
            whose due date has passed; false = not overdue — either not active,
            or due on/after today)


            Note: money values are in minor currency units (e.g. pence for GBP).
            Use 1000000 for £10,000.00.


            Note: `like` is a case-insensitive substring match — pass the bare
            term (filter[title][like]=redesign). Do not add % wildcards; they
            are not needed.
          examples:
            equality:
              summary: Simple equality
              value:
                status: open
            multiple_values:
              summary: Multiple values (implicit IN)
              value:
                status: open,approved
            with_operator:
              summary: With explicit operator
              value:
                created_at:
                  gte: '2024-01-01'
            range:
              summary: Range query
              value:
                rate:
                  between: 1000000,5000000
        - name: or[group]
          in: query
          style: deepObject
          explode: true
          schema:
            type: object
          description: >-
            OR condition groups. Filters within a group are ANDed; groups are
            ORed.


            **Syntax**: `or[group_key][<attribute>]=value` or
            `or[group_key][<attribute>][operator]=value`


            **Examples**:

            - Simple OR: `or[1][state]=draft&or[2][state]=pending`

            - Complex:
            `or[1][state]=draft&or[1][budget][gte]=50000&or[2][state]=closed`

            - With custom fields:
            `or[1][cf][priority]=high&or[2][state]=pending`


            Group keys can be any string (1, 2, a, b, etc.) - they just need to
            be unique.
          examples:
            simple_or:
              summary: Simple OR
              value:
                '1':
                  status: submitted
                '2':
                  status: open
            complex_or:
              summary: Complex OR with AND within groups
              value:
                '1':
                  status: submitted
                  rate:
                    gte: '1000000'
                '2':
                  status: open
        - name: cf[key]
          in: query
          style: deepObject
          explode: true
          schema:
            type: object
          description: >-
            Custom field filters using concise syntax.


            **Syntax**:

            - Equality: `cf[key]=value`

            - With operator: `cf[key][operator]=value`


            **Operators**: eq (default), not_eq, in, not_in, contains,
            not_contains, exists, not_exists


            **Examples**:

            - `cf[priority]=high` - exact match

            - `cf[department][in]=eng,design` - matches any

            - `cf[priority][not_eq]=low` - not equal

            - `cf[notes][contains]=urgent` - contains text

            - `cf[legacy_field][exists]=` - field exists (value ignored)

            - `cf[deprecated][not_exists]=` - field does not exist
          examples:
            equality:
              summary: Simple equality
              value:
                priority: high
            with_operator:
              summary: With IN operator
              value:
                department:
                  in: eng,design
            exists:
              summary: Check existence
              value:
                priority:
                  exists: ''
        - name: or[group][cf][key]
          in: query
          style: deepObject
          explode: true
          schema:
            type: object
          description: >-
            Custom field filters within OR condition groups.


            **Syntax**: `or[group][cf][key]=value` or
            `or[group][cf][key][operator]=value`


            **Example**: `or[1][cf][priority]=high&or[2][state]=pending`
        - name: sort[<attribute>]
          in: query
          style: deepObject
          explode: true
          schema:
            type: object
          description: >-
            Sort results by attribute. Direction defaults to ascending.


            **Syntax**: `sort[<attribute>]=` (ascending) or
            `sort[<attribute>]=desc` (descending)


            **Sortable attributes**: active, approved_at, approved_by_id,
            client_suggested, close_project, comments, created_at, delivered_on,
            details, due_on, final_claim, id, interim_valuation_date,
            level_1_approved_at, level_1_approved_by_id, mandatory, notes,
            original_id, original_rate, overdue, project_id,
            purchase_order_line_id, rate, rate_ccy, rejected_at, rejected_by_id,
            status, submitted_at, tiered_markup_fee, title, updated_at


            **Examples**:

            - Ascending: `sort[created_at]=` or `sort[created_at]=asc`

            - Descending: `sort[created_at]=desc`
          examples:
            ascending:
              summary: Ascending (implicit)
              value:
                created_at: ''
            descending:
              summary: Descending
              value:
                created_at: desc
      responses:
        '200':
          description: List of milestones
          content:
            application/json:
              schema:
                type: object
                properties:
                  milestones:
                    type: array
                    items:
                      $ref: '#/components/schemas/Milestone'
              examples:
                success:
                  summary: Successful response with milestones
                  value:
                    milestones:
                      - id: 101
                        title: Website Redesign Project
                        status: submitted
                        client_suggested: false
                        close_project: false
                        comments: Additional information and context for this record.
                        details: Additional information and context for this record.
                        due_on: '2024-01-16'
                        project_summary: >-
                          Website Redesign Project - Complete redesign of
                          corporate website with modern UX
                        mandatory: false
                        notes: Additional information and context for this record.
                        original_id: 501
                        original_rate:
                          cents: 150000
                          currency: GBP
                        purchase_order_line_id: 501
                        rate:
                          cents: 150000
                          currency: GBP
                        submitted_at: '2024-01-16T10:30:00+00:00'
                        interim_valuation_date: '2024-01-16T10:30:00+00:00'
                        tiered_markup_fee:
                          cents: 150000
                          currency: GBP
                        children:
                          - 201
                          - 202
                        parents:
                          - 201
                          - 202
                        custom_fields:
                          department: Engineering
                          priority: high
                          cost_code: CC-001
                        created_at: '2024-01-16T10:30:00+00:00'
                        updated_at: '2024-01-16T10:30:00+00:00'
                        project_id: 501
                        final_claim: 'false'
                        delivered_on: '2024-01-16'
                        approved_by:
                          id: 101
                          first_name: Demo
                          last_name: User
                          email: user1@example.com
                          org_id: 501
                          org_name: Acme Corporation
                        rejected_by:
                          id: 101
                          first_name: Demo
                          last_name: User
                          email: user1@example.com
                          org_id: 501
                          org_name: Acme Corporation
                        level_1_approved_by:
                          id: 101
                          first_name: Demo
                          last_name: User
                          email: user1@example.com
                          org_id: 501
                          org_name: Acme Corporation
                      - id: 102
                        title: Mobile App Development
                        status: approved
                        client_suggested: false
                        close_project: false
                        comments: Additional information and context for this record.
                        details: Additional information and context for this record.
                        due_on: '2024-01-17'
                        project_summary: >-
                          Website Redesign Project - Complete redesign of
                          corporate website with modern UX
                        mandatory: false
                        notes: Additional information and context for this record.
                        original_id: 502
                        original_rate:
                          cents: 300000
                          currency: GBP
                        purchase_order_line_id: 502
                        rate:
                          cents: 300000
                          currency: GBP
                        submitted_at: '2024-01-17T10:30:00+00:00'
                        interim_valuation_date: '2024-01-17T10:30:00+00:00'
                        tiered_markup_fee:
                          cents: 300000
                          currency: GBP
                        children:
                          - 202
                          - 203
                        parents:
                          - 202
                          - 203
                        custom_fields:
                          department: Engineering
                          priority: high
                          cost_code: CC-001
                        created_at: '2024-01-17T10:30:00+00:00'
                        updated_at: '2024-01-17T10:30:00+00:00'
                        project_id: 502
                        final_claim: 'true'
                        delivered_on: '2024-01-17'
                        approved_by:
                          id: 102
                          first_name: Jane
                          last_name: Smith
                          email: user2@example.com
                          org_id: 502
                          org_name: Global Services Ltd
                        rejected_by:
                          id: 102
                          first_name: Jane
                          last_name: Smith
                          email: user2@example.com
                          org_id: 502
                          org_name: Global Services Ltd
                        level_1_approved_by:
                          id: 102
                          first_name: Jane
                          last_name: Smith
                          email: user2@example.com
                          org_id: 502
                          org_name: Global Services Ltd
                empty:
                  summary: Empty result set
                  value:
                    milestones: []
                filtered:
                  summary: Filtered results
                  description: Results after applying filters
                  value:
                    milestones:
                      - id: 101
                        title: Website Redesign Project
                        status: submitted
                        client_suggested: false
                        close_project: false
                        comments: Additional information and context for this record.
                        details: Additional information and context for this record.
                        due_on: '2024-01-16'
                        project_summary: >-
                          Website Redesign Project - Complete redesign of
                          corporate website with modern UX
                        mandatory: false
                        notes: Additional information and context for this record.
                        original_id: 501
                        original_rate:
                          cents: 150000
                          currency: GBP
                        purchase_order_line_id: 501
                        rate:
                          cents: 150000
                          currency: GBP
                        submitted_at: '2024-01-16T10:30:00+00:00'
                        interim_valuation_date: '2024-01-16T10:30:00+00:00'
                        tiered_markup_fee:
                          cents: 150000
                          currency: GBP
                        children:
                          - 201
                          - 202
                        parents:
                          - 201
                          - 202
                        custom_fields:
                          department: Engineering
                          priority: high
                          cost_code: CC-001
                        created_at: '2024-01-16T10:30:00+00:00'
                        updated_at: '2024-01-16T10:30:00+00:00'
                        project_id: 501
                        final_claim: 'false'
                        delivered_on: '2024-01-16'
                        approved_by:
                          id: 101
                          first_name: Demo
                          last_name: User
                          email: user1@example.com
                          org_id: 501
                          org_name: Acme Corporation
                        rejected_by:
                          id: 101
                          first_name: Demo
                          last_name: User
                          email: user1@example.com
                          org_id: 501
                          org_name: Acme Corporation
                        level_1_approved_by:
                          id: 101
                          first_name: Demo
                          last_name: User
                          email: user1@example.com
                          org_id: 501
                          org_name: Acme Corporation
        '401':
          description: >-
            Unauthorized - the access token is missing, expired, revoked or
            malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_token
                error_description: >-
                  The access token provided is expired, revoked, malformed, or
                  invalid for other reasons
        '403':
          description: Forbidden - insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: insufficient_scope
                error_description: >-
                  The request requires higher privileges than provided by the
                  access token
                required_scope: milestones:read
                provided_scopes:
                  - welcome:read
        '422':
          description: Invalid filter or sort parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalid_attribute:
                  summary: Unknown filter attribute
                  value:
                    error: 'Invalid filter attribute: unknown_field'
                invalid_operator:
                  summary: Invalid operator for type
                  value:
                    error: Operator 'like' is not valid for integer type
                invalid_value:
                  summary: Invalid value format
                  value:
                    error: 'Invalid date format for created_at: not-a-date'
                invalid_sort_attribute:
                  summary: Unknown sort attribute
                  value:
                    error: 'Invalid sort attribute: unknown_field'
                invalid_sort_direction:
                  summary: Invalid sort direction
                  value:
                    error: Invalid sort direction 'random'. Must be 'asc' or 'desc'
      security:
        - oauth2:
            - milestones:read
          tenantId: []
components:
  schemas:
    Milestone:
      type: object
      properties:
        id:
          type: integer
        title:
          type: string
        status:
          type: string
          enum:
            - open
            - submitted
            - approved
            - rejected
            - change_requested
            - on_hold
            - draft
            - cancelled
            - level_1_approved
            - closed
          example: open
        client_suggested:
          type: boolean
          example: true
        close_project:
          type: boolean
          example: true
        comments:
          type: string
        details:
          type: string
        due_on:
          type: string
        project_summary:
          type: string
        mandatory:
          type: boolean
          example: true
        notes:
          type: string
        original_id:
          type: integer
        original_rate:
          $ref: '#/components/schemas/Money'
        purchase_order_line_id:
          type: integer
        rate:
          $ref: '#/components/schemas/Money'
        submitted_at:
          type: string
        interim_valuation_date:
          type: string
        tiered_markup_fee:
          $ref: '#/components/schemas/Money'
        children:
          type: array
          items:
            type: integer
          description: Array of IDs
        parents:
          type: array
          items:
            type: integer
          description: Array of IDs
        custom_fields:
          type: object
          additionalProperties:
            type: string
          description: Key-value pairs of custom field data
        created_at:
          type: string
        updated_at:
          type: string
        project_id:
          type: integer
        final_claim:
          type: boolean
          example: true
        delivered_on:
          type: string
        approved_by:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedUser'
            - type: 'null'
        rejected_by:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedUser'
            - type: 'null'
        level_1_approved_by:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedUser'
            - type: 'null'
    Error:
      type: object
      description: Error envelope returned by every non-2xx V4 response
      properties:
        error:
          type: string
          example: insufficient_scope
        error_description:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
        required_scope:
          type: string
          example: projects:read
        provided_scopes:
          type: array
          items:
            type: string
    Money:
      type: object
      properties:
        cents:
          type: integer
          example: 150000
        currency:
          type: string
          example: GBP
    EmbeddedUser:
      type: object
      properties:
        id:
          type: integer
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        org_id:
          type: integer
        org_name:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth 2.0 client credentials. The access token from POST /oauth/token is
        sent as a bearer token. Request only the scopes you need.
      flows:
        clientCredentials:
          tokenUrl: https://api.zivio.net/api/v4/oauth/token
          scopes:
            bank_accounts:read: Read bank account details on suppliers and the org.
            catalogs:read: Read catalog items.
            cost_centers:read: Read cost center records.
            eoi_responses:read: Read responses to expressions of interest.
            eois:read: Read expressions of interest.
            offers:read: Read offers for projects.
            org_units:read: Read your organization unit hierarchy.
            org_users:read: Read members of your organization.
            resources:read: Read resource (worker) records.
            sales_invoices:read: Read invoices issued to clients.
            sales_milestones:read: Read milestones on sales engagements.
            skill_categories:read: Read the skill category taxonomy.
            skill_taxonomies:read: Read skill taxonomy structure.
            skills:read: Read individual skills.
            supplier_documents:read: Read documents uploaded by suppliers.
            supplier_lists:read: Read curated lists of suppliers.
            supplier_users:read: Read users belonging to supplier organizations.
            tax_types:read: Read configured tax types.
            users:read: Read user profiles.
            variation_orders:read: Read variation orders on projects.
            welcome:read: 'Required: confirms your identity to the application.'
            bid_evaluations:read: >-
              Read evaluation scorecards for bids, including criterion scores
              and quality, cost and total scores.
            bid_evaluations:write: >-
              Score bids against a project's quality criteria and override
              calculated cost scores.
            bids:read: Read bids submitted on projects.
            bids:write: >-
              Shortlist, select, eliminate and reinstate bids submitted on
              projects.
            invoices:read: Read invoices on projects.
            invoices:write: Create and update invoices.
            notes:read: Read notes on projects and EOIs.
            notes:write: Create and update notes on projects and EOIs.
            project_approvals:read: Read project approval workflows.
            project_approvals:write: Create and update project approval workflows.
            project_conversations:read: Read messages exchanged with suppliers on a project.
            project_conversations:write: Send messages to suppliers on a project.
            project_invitations:read: Read supplier invitations on projects.
            project_invitations:write: Invite suppliers to bid on projects.
            project_questions:read: Read supplier clarification questions on projects.
            project_questions:write: Answer and approve supplier clarification questions.
            projects:read: Read projects.
            projects:write: Create and update projects.
            milestones:read: Read milestones on projects.
            milestones:write: Create and update milestones.
            orgs:read: Read organization records.
            orgs:write: Create and update organization records.
            purchase_orders:read: Read purchase orders.
            purchase_orders:write: Create and update purchase orders.
            reviews:read: Read reviews left on suppliers.
            reviews:write: Create and update reviews.
            suppliers:read: Read supplier profiles.
            suppliers:write: Create and update supplier profiles.
            raw_scorecard_entries:write: Create and update raw scorecard entries.
            raw_scorecard_entries:read: Read raw scorecard entries.
            tasks:read: >-
              Read the acting user's task queue, including outstanding approvals
              and items to review.
            tasks:write: Complete and dismiss tasks in the acting user's task queue.
            act_as_user: >-
              Make requests as another user within the token holder's delegation
              boundary.
    tenantId:
      type: apiKey
      name: zivio-tenant-id
      in: header
      description: >-
        Your Zivio organisation identifier. The regional API endpoints serve
        every Zivio organisation, so each request must identify yours.

````