> ## 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 Raw Scorecard Entries

> Retrieve a paginated list of raw_scorecard_entries. 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/raw_scorecard_entries?filter[provider]=active

# Multiple values (implicit IN)
GET /api/v4/raw_scorecard_entries?filter[provider]=draft,pending

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

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

# Multiple filters (AND)
GET /api/v4/raw_scorecard_entries?filter[provider]=active&filter[milestones_total][gte]=1000000
```

### Available Attributes

| Attribute | Type | Operators | Permitted Values |
|-----------|------|-----------|------------------|
| all_distinct_reviews_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| all_reviews_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| bids_total_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| ccy | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| created_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| days_late_total | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| dimension | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| external_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| invoices_approved | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| max_ended_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| milestones_approved | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| milestones_committed | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| milestones_completed | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| milestones_on_budget_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| milestones_on_time_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| milestones_total | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| milestones_total_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| projects_budget_total | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| projects_budgetable_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| projects_completed | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| projects_in_progress | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| projects_on_budget_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| projects_on_time_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| projects_original_budget_total | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| projects_won_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| provider | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| rating | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| rating_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| recommended_reviews_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| supplier_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| supplier_reviews_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| universe_overall_rating_total | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| updated_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| variation_orders_accepted_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |

### OR Conditions

Use `or[group]` to combine filter groups with OR logic. Filters within a group are ANDed:
```
# Simple OR
GET /api/v4/raw_scorecard_entries?or[1][provider]=pending&or[2][provider]=active

# Complex OR (provider=pending AND milestones_total>=1000000) OR (provider=active)
GET /api/v4/raw_scorecard_entries?or[1][provider]=pending&or[1][milestones_total][gte]=1000000&or[2][provider]=active
```

## Sorting

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

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

# Combined with filters
GET /api/v4/raw_scorecard_entries?filter[provider]=active&sort[created_at]=desc
```



## OpenAPI

````yaml /api-reference/v4/openapi.json get /raw_scorecard_entries
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:
  /raw_scorecard_entries:
    get:
      tags:
        - Raw Scorecard Entries
      summary: List Raw Scorecard Entries
      description: >-
        Retrieve a paginated list of raw_scorecard_entries. 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/raw_scorecard_entries?filter[provider]=active


        # Multiple values (implicit IN)

        GET /api/v4/raw_scorecard_entries?filter[provider]=draft,pending


        # With explicit operator

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


        # Range query

        GET
        /api/v4/raw_scorecard_entries?filter[milestones_total][between]=1000000,5000000


        # Multiple filters (AND)

        GET
        /api/v4/raw_scorecard_entries?filter[provider]=active&filter[milestones_total][gte]=1000000

        ```


        ### Available Attributes


        | Attribute | Type | Operators | Permitted Values |

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        | rating | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`,
        `lte`, `between` | - |

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

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

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

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

        | universe_overall_rating_total | decimal | `eq`, `not_eq`, `in`,
        `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |

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

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


        ### OR Conditions


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

        ```

        # Simple OR

        GET
        /api/v4/raw_scorecard_entries?or[1][provider]=pending&or[2][provider]=active


        # Complex OR (provider=pending AND milestones_total>=1000000) OR
        (provider=active)

        GET
        /api/v4/raw_scorecard_entries?or[1][provider]=pending&or[1][milestones_total][gte]=1000000&or[2][provider]=active

        ```


        ## Sorting


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

        ```

        # Ascending (implicit)

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


        # Descending

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


        # Combined with filters

        GET
        /api/v4/raw_scorecard_entries?filter[provider]=active&sort[created_at]=desc

        ```
      operationId: getRawScorecardEntries
      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): all_distinct_reviews_count, all_reviews_count,
            bids_total_count, days_late_total, external_id, id,
            milestones_completed, milestones_on_budget_count,
            milestones_on_time_count, milestones_total_count,
            projects_budgetable_count, projects_completed, projects_in_progress,
            projects_on_budget_count, projects_on_time_count,
            projects_won_count, rating_count, recommended_reviews_count,
            supplier_id, supplier_reviews_count, variation_orders_accepted_count

            **datetime** (operators: eq, not_eq, gt, gte, lt, lte, between):
            created_at, max_ended_at, updated_at

            **money** (operators: eq, not_eq, in, not_in, gt, gte, lt, lte,
            between): invoices_approved, milestones_approved,
            milestones_committed, milestones_total, projects_budget_total,
            projects_original_budget_total

            **decimal** (operators: eq, not_eq, in, not_in, gt, gte, lt, lte,
            between): rating, universe_overall_rating_total

            **string** (operators: eq, not_eq, in, not_in, like, not_like): ccy,
            dimension, provider


            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:
                provider: active
            multiple_values:
              summary: Multiple values (implicit IN)
              value:
                provider: draft,pending
            with_operator:
              summary: With explicit operator
              value:
                created_at:
                  gte: '2024-01-01'
            range:
              summary: Range query
              value:
                milestones_total:
                  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':
                  provider: pending
                '2':
                  provider: active
            complex_or:
              summary: Complex OR with AND within groups
              value:
                '1':
                  provider: pending
                  milestones_total:
                    gte: '1000000'
                '2':
                  provider: active
        - 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**: all_distinct_reviews_count,
            all_reviews_count, bids_total_count, ccy, created_at,
            days_late_total, dimension, external_id, id, invoices_approved,
            max_ended_at, milestones_approved, milestones_committed,
            milestones_completed, milestones_on_budget_count,
            milestones_on_time_count, milestones_total, milestones_total_count,
            projects_budget_total, projects_budgetable_count,
            projects_completed, projects_in_progress, projects_on_budget_count,
            projects_on_time_count, projects_original_budget_total,
            projects_won_count, provider, rating, rating_count,
            recommended_reviews_count, supplier_id, supplier_reviews_count,
            universe_overall_rating_total, updated_at,
            variation_orders_accepted_count


            **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 raw_scorecard_entries
          content:
            application/json:
              schema:
                type: object
                properties:
                  raw_scorecard_entries:
                    type: array
                    items:
                      $ref: '#/components/schemas/RawScorecardEntry'
              examples:
                success:
                  summary: Successful response with raw_scorecard_entries
                  value:
                    raw_scorecard_entries:
                      - id: 101
                        supplier_id: 501
                        supplier_external_id: 501
                        provider: Example provider
                        dimension: Example dimension
                        ccy: GBP
                        external_id: EXT-1001
                        bids_total_count: 101
                        milestones_completed: 101
                        milestones_total_count: 101
                        milestones_on_time_count: 101
                        milestones_on_budget_count: 101
                        milestones_total_cents: 101
                        milestones_approved_cents: 101
                        milestones_committed_cents: 101
                        max_ended_at: '2024-01-16T10:30:00+00:00'
                        days_late_total: 101
                        variation_orders_accepted_count: 101
                        invoices_approved_cents: 101
                        rating: '1500.00'
                        rating_count: 101
                        universe_overall_rating_total: '1500.00'
                        supplier_reviews_count: 101
                        all_reviews_count: 101
                        all_distinct_reviews_count: 101
                        recommended_reviews_count: 101
                        created_at: '2024-01-16T10:30:00+00:00'
                        updated_at: '2024-01-16T10:30:00+00:00'
                        projects_completed: null
                        projects_in_progress: null
                        projects_won_count: null
                        projects_budgetable_count: null
                        projects_on_time_count: null
                        projects_on_budget_count: null
                        projects_budget_total_cents: null
                        projects_original_budget_total_cents: null
                      - id: 102
                        supplier_id: 502
                        supplier_external_id: 502
                        provider: Example provider
                        dimension: Example dimension
                        ccy: GBP
                        external_id: EXT-1002
                        bids_total_count: 102
                        milestones_completed: 102
                        milestones_total_count: 102
                        milestones_on_time_count: 102
                        milestones_on_budget_count: 102
                        milestones_total_cents: 102
                        milestones_approved_cents: 102
                        milestones_committed_cents: 102
                        max_ended_at: '2024-01-17T10:30:00+00:00'
                        days_late_total: 102
                        variation_orders_accepted_count: 102
                        invoices_approved_cents: 102
                        rating: '1500.00'
                        rating_count: 102
                        universe_overall_rating_total: '1500.00'
                        supplier_reviews_count: 102
                        all_reviews_count: 102
                        all_distinct_reviews_count: 102
                        recommended_reviews_count: 102
                        created_at: '2024-01-17T10:30:00+00:00'
                        updated_at: '2024-01-17T10:30:00+00:00'
                        projects_completed: null
                        projects_in_progress: null
                        projects_won_count: null
                        projects_budgetable_count: null
                        projects_on_time_count: null
                        projects_on_budget_count: null
                        projects_budget_total_cents: null
                        projects_original_budget_total_cents: null
                empty:
                  summary: Empty result set
                  value:
                    raw_scorecard_entries: []
                filtered:
                  summary: Filtered results
                  description: Results after applying filters
                  value:
                    raw_scorecard_entries:
                      - id: 101
                        supplier_id: 501
                        supplier_external_id: 501
                        provider: Example provider
                        dimension: Example dimension
                        ccy: GBP
                        external_id: EXT-1001
                        bids_total_count: 101
                        milestones_completed: 101
                        milestones_total_count: 101
                        milestones_on_time_count: 101
                        milestones_on_budget_count: 101
                        milestones_total_cents: 101
                        milestones_approved_cents: 101
                        milestones_committed_cents: 101
                        max_ended_at: '2024-01-16T10:30:00+00:00'
                        days_late_total: 101
                        variation_orders_accepted_count: 101
                        invoices_approved_cents: 101
                        rating: '1500.00'
                        rating_count: 101
                        universe_overall_rating_total: '1500.00'
                        supplier_reviews_count: 101
                        all_reviews_count: 101
                        all_distinct_reviews_count: 101
                        recommended_reviews_count: 101
                        created_at: '2024-01-16T10:30:00+00:00'
                        updated_at: '2024-01-16T10:30:00+00:00'
                        projects_completed: null
                        projects_in_progress: null
                        projects_won_count: null
                        projects_budgetable_count: null
                        projects_on_time_count: null
                        projects_on_budget_count: null
                        projects_budget_total_cents: null
                        projects_original_budget_total_cents: null
        '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: raw_scorecard_entries: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:
            - raw_scorecard_entries:read
          tenantId: []
components:
  schemas:
    RawScorecardEntry:
      type: object
      properties:
        id:
          type: integer
        supplier_id:
          type: integer
        supplier_external_id:
          type: integer
          example: 456
        provider:
          type: string
        dimension:
          type: string
        ccy:
          type: string
        external_id:
          type: integer
        bids_total_count:
          type: integer
        milestones_completed:
          type: integer
        milestones_total_count:
          type: integer
        milestones_on_time_count:
          type: integer
        milestones_on_budget_count:
          type: integer
        milestones_total_cents:
          type: integer
          example: 123
        milestones_approved_cents:
          type: integer
          example: 123
        milestones_committed_cents:
          type: integer
          example: 123
        max_ended_at:
          type: string
        days_late_total:
          type: integer
        variation_orders_accepted_count:
          type: integer
        invoices_approved_cents:
          type: integer
          example: 123
        rating:
          type: string
        rating_count:
          type: integer
        universe_overall_rating_total:
          type: string
        supplier_reviews_count:
          type: integer
        all_reviews_count:
          type: integer
        all_distinct_reviews_count:
          type: integer
        recommended_reviews_count:
          type: integer
        created_at:
          type: string
        updated_at:
          type: string
        projects_completed:
          type: integer
        projects_in_progress:
          type: integer
        projects_won_count:
          type: integer
        projects_budgetable_count:
          type: integer
        projects_on_time_count:
          type: integer
        projects_on_budget_count:
          type: integer
        projects_budget_total_cents:
          type: string
        projects_original_budget_total_cents:
          type: string
    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
  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.

````