---
title: "GET /usage/files"
method: GET
path: "/usage/files"
tags: ["Usage Reporting"]
---

# GET /usage/files

`GET /usage/files`

UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.

## Query parameters

- `limit` integer
- `offset` integer
- `contract.id` string
- `contract.name` string
- `created.at` string
- `distribution_contract_id` string
- `environment` 'test' | 'preview' | 'production'
- `external_id` string
- `id` string
- `marketplace.id` string
- `marketplace.name` string
- `marketplace_id` string
- `name` string
- `product.id` string
- `product.name` string
- `product_id` string
- `provider.id` string
- `provider.name` string
- `provider_id` string
- `schema` 'tr' | 'pr' | 'qt' | 'cr'
- `status` 'draft' | 'uploading' | 'uploaded' | 'invalid' | 'processing' | 'ready' | 'rejected' | 'pending' | 'accepted' | 'closed' | 'deleted'
- `vendor.id` string
- `vendor.name` string
- `vendor_id` string

## Headers

- `Content-Range` ContentRange — unresolved $ref

## Response `200`

- UsageUsageFileList[]
  - `id` string
  - `name` string, nullable
  - `external_id` string, required
  - `status` 'draft' | 'uploading' | 'uploaded' | 'invalid' | 'processing' | 'ready' | 'rejected' | 'pending' | 'accepted' | 'closed' | 'deleted'
  - `vendor` UsageReferenceAccount, required
    - `id` string, required
    - `name` string, nullable
    - `icon` string, nullable
  - `provider` UsageReferenceAccount, required
    - `id` string, required
    - `name` string, nullable
    - `icon` string, nullable
  - `environment` 'test' | 'preview' | 'production'
  - `marketplace` UsageReferenceMarketplace, required
    - `id` string, required
    - `name` string, nullable
    - `icon` string, nullable
  - `contract` UsageReferenceContract, required
    - `id` string, required
    - `name` string, nullable
  - `product` UsageProducts
    - `id` string, nullable
    - `name` string, nullable
    - `icon` string, nullable
  - `error_detail` string, nullable
  - `description` string, nullable
  - `acceptance_note` string, nullable
  - `rejection_note` string, nullable
  - `schema` 'tr' | 'pr' | 'qt' | 'cr'
  - `currency` string, nullable
  - `period` object
    - `from` string, date
    - `to` string, date
  - `stats` object
    - `uploaded` integer
    - `validated` integer
    - `pending` integer
    - `accepted` integer
    - `closed` integer
    - `billed` integer
  - `events` object
    - `created` UsageUsageEvents
      - `at` string, date-time, required
      - `by` UsageReferenceUser
        - `id` string, required
        - `name` string, required
    - `uploaded` UsageUsageEvents
      - `at` string, date-time, required
      - `by` UsageReferenceUser
        - `id` string, required
        - `name` string, required
    - `submitted` UsageUsageEvents
      - `at` string, date-time, required
      - `by` UsageReferenceUser
        - `id` string, required
        - `name` string, required
    - `accepted` UsageUsageEvents
      - `at` string, date-time, required
      - `by` UsageReferenceUser
        - `id` string, required
        - `name` string, required
    - `closed` UsageUsageEvents
      - `at` string, date-time, required
      - `by` UsageReferenceUser
        - `id` string, required
        - `name` string, required
    - `rejected` UsageUsageEvents
      - `at` string, date-time, required
      - `by` UsageReferenceUser
        - `id` string, required
        - `name` string, required
    - `deleted` UsageUsageEvents
      - `at` string, date-time, required
      - `by` UsageReferenceUser
        - `id` string, required
        - `name` string, required

## Other responses

- `400`

---

[API](https://skmtc.dev/cloudblue/apis/cloudblue-connect-api.md) · [All operations](https://skmtc.dev/cloudblue/apis/cloudblue-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cloudblue/cloudblue-connect-api/revisions/0421d2a97c52/schema)