Gets the invoices.

GET /v1/Invoices

Returns a list of invoices. The invoices are returned ordered by the "Timestamp" property and by the boolean value sent in the ascendingOrder parameter. The ascending order might be true or false.

Headers

  • X-Tenant string Required

    This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.

  • Authorization string Required

    JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

    Default value is Bearer eyJ0eXAiO....

  • X-Correlation-Id string(UUID)

    This header is optional and by setting it you can correlate the audit logs made by this request.

Query parameters

  • providerInstanceId string(uuid) Required

    The provider instance id.

  • invoiceType string Required

    The invoice type. Possible values: onetime, usage, license and dailyratedusage.

  • pageNumber integer(int32) Required

    A cursor for pagination across multiple pages of results. The default value is 1.

  • pageSize integer(int32) Required

    The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.

  • ascendingOrder boolean

    If set to true [ascending order].

  • resellerId string(uuid)

    The id of a specific reseller. If you are a CSP you can set this to filter by reseller, otherwise don't send a value.

  • customerId string(uuid)

    The id of a specific customer. If you are a CSP or a reseller you can set this to filter by customer, otherwise don't send a value.

Responses

  • • 200

    The request completed with success and returns the invoices.

    Hide response attributes Show response attributes object
    • items array[object] | null

      View model that represents a invoice.

      Hide items attributes Show items attributes object
      • id string(uuid)

        The id of the invoice in CloudCockpit.

      • providerInstanceId string(uuid)

        The id of the provider instance where the invoice was issued.

      • providerInstanceName string | null

        The name of the provider instance where the invoice was issued.

      • currency string | null

        The invoice billing currency.

      • subtotal number(double)

        The sum of the subtotal of line items of the invoice.

      • type string | null

        The invoice type. Possible values: onetime, usage, license and dailyratedusage.

      • invoiceDate string(date-time)

        The date and time of when the invoice was issued.

      • invoiceProviderId string | null

        The id of the invoice in the provider's side.

      • invoiceLineItemsFile object

        The model that represents the status and location of a file that contains the line items of a given invoice.

        Hide invoiceLineItemsFile attributes Show invoiceLineItemsFile attributes
        • status string | null

          The status of the file that contains the line items of the invoice. Possible values are: Queued, Processing, Available, Failed.

        • location string | null

          The absolute URL of the location of file of the line items of the invoice.

        • lastUpdate string(date-time)

          The timestamp of the last update of the invoice line items file.

        • fileFormat string | null

          The file format culture used to generate the file.

        • Additional properties are NOT allowed
      • status object

        The possible values that an Invoice can go through: Processing, Completed, Failed.

        Hide status attributes Show status attributes
      • Additional properties are NOT allowed
    • paginationParameters object

      A model that is used to encapsulate the parameters needed to perform pagination queries.

      Hide paginationParameters attributes Show paginationParameters attributes
    • totalPages integer(int32)

      The total number of pages available for the specified parameters and page size.

    • totalCount integer(int32)

      The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.

    • hasPreviousPage boolean

      Indicates if there is a previous page.

    • hasNextPage boolean

      Indicates if there is a next page.

    • continuationToken string | null

      The token to continue to retrieve the paginated items.

    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • items array[object] | null

      View model that represents a invoice.

      Hide items attributes Show items attributes object
      • id string(uuid)

        The id of the invoice in CloudCockpit.

      • providerInstanceId string(uuid)

        The id of the provider instance where the invoice was issued.

      • providerInstanceName string | null

        The name of the provider instance where the invoice was issued.

      • currency string | null

        The invoice billing currency.

      • subtotal number(double)

        The sum of the subtotal of line items of the invoice.

      • type string | null

        The invoice type. Possible values: onetime, usage, license and dailyratedusage.

      • invoiceDate string(date-time)

        The date and time of when the invoice was issued.

      • invoiceProviderId string | null

        The id of the invoice in the provider's side.

      • invoiceLineItemsFile object

        The model that represents the status and location of a file that contains the line items of a given invoice.

        Hide invoiceLineItemsFile attributes Show invoiceLineItemsFile attributes
        • status string | null

          The status of the file that contains the line items of the invoice. Possible values are: Queued, Processing, Available, Failed.

        • location string | null

          The absolute URL of the location of file of the line items of the invoice.

        • lastUpdate string(date-time)

          The timestamp of the last update of the invoice line items file.

        • fileFormat string | null

          The file format culture used to generate the file.

        • Additional properties are NOT allowed
      • status object

        The possible values that an Invoice can go through: Processing, Completed, Failed.

        Hide status attributes Show status attributes
      • Additional properties are NOT allowed
    • paginationParameters object

      A model that is used to encapsulate the parameters needed to perform pagination queries.

      Hide paginationParameters attributes Show paginationParameters attributes
    • totalPages integer(int32)

      The total number of pages available for the specified parameters and page size.

    • totalCount integer(int32)

      The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.

    • hasPreviousPage boolean

      Indicates if there is a previous page.

    • hasNextPage boolean

      Indicates if there is a next page.

    • continuationToken string | null

      The token to continue to retrieve the paginated items.

    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • items array[object] | null

      View model that represents a invoice.

      Hide items attributes Show items attributes object
      • id string(uuid)

        The id of the invoice in CloudCockpit.

      • providerInstanceId string(uuid)

        The id of the provider instance where the invoice was issued.

      • providerInstanceName string | null

        The name of the provider instance where the invoice was issued.

      • currency string | null

        The invoice billing currency.

      • subtotal number(double)

        The sum of the subtotal of line items of the invoice.

      • type string | null

        The invoice type. Possible values: onetime, usage, license and dailyratedusage.

      • invoiceDate string(date-time)

        The date and time of when the invoice was issued.

      • invoiceProviderId string | null

        The id of the invoice in the provider's side.

      • invoiceLineItemsFile object

        The model that represents the status and location of a file that contains the line items of a given invoice.

        Hide invoiceLineItemsFile attributes Show invoiceLineItemsFile attributes
        • status string | null

          The status of the file that contains the line items of the invoice. Possible values are: Queued, Processing, Available, Failed.

        • location string | null

          The absolute URL of the location of file of the line items of the invoice.

        • lastUpdate string(date-time)

          The timestamp of the last update of the invoice line items file.

        • fileFormat string | null

          The file format culture used to generate the file.

        • Additional properties are NOT allowed
      • status object

        The possible values that an Invoice can go through: Processing, Completed, Failed.

        Hide status attributes Show status attributes
      • Additional properties are NOT allowed
    • paginationParameters object

      A model that is used to encapsulate the parameters needed to perform pagination queries.

      Hide paginationParameters attributes Show paginationParameters attributes
    • totalPages integer(int32)

      The total number of pages available for the specified parameters and page size.

    • totalCount integer(int32)

      The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.

    • hasPreviousPage boolean

      Indicates if there is a previous page.

    • hasNextPage boolean

      Indicates if there is a next page.

    • continuationToken string | null

      The token to continue to retrieve the paginated items.

    • Additional properties are NOT allowed
  • • 400

    There is an error in the parameters sent in the request.

    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
  • • 401

    Please use a valid authorization token.

  • • 403

    You don't have enough permissions to access this information.

  • • 500

    A server error has happened during the request. Please try again later or contact support.

    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
GET /v1/Invoices 
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Invoices?providerInstanceId=string&invoiceType=string&pageNumber=42&pageSize=42 \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200) 
{
  "items": [
    {
      "id": "a393f55e-8249-47a5-b11f-80c8dc7905c9",
      "providerInstanceId": "a393f55e-8249-47a5-b11f-80c8dc7905c9",
      "providerInstanceName": "Microsoft Tier 1",
      "currency": "EUR",
      "subtotal": 123,
      "type": "license",
      "invoiceDate": "2023-03-03 18:06:57.5533333",
      "invoiceProviderId": "G017942997",
      "invoiceLineItemsFile": {
        "status": "Queued",
        "location": "string",
        "lastUpdate": "2024-05-04T09:42:00+00:00",
        "fileFormat": "string"
      },
      "status": {
        "name": "string"
      }
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}
Response examples (200) 
{
  "items": [
    {
      "id": "a393f55e-8249-47a5-b11f-80c8dc7905c9",
      "providerInstanceId": "a393f55e-8249-47a5-b11f-80c8dc7905c9",
      "providerInstanceName": "Microsoft Tier 1",
      "currency": "EUR",
      "subtotal": 123,
      "type": "license",
      "invoiceDate": "2023-03-03 18:06:57.5533333",
      "invoiceProviderId": "G017942997",
      "invoiceLineItemsFile": {
        "status": "Queued",
        "location": "string",
        "lastUpdate": "2024-05-04T09:42:00+00:00",
        "fileFormat": "string"
      },
      "status": {
        "name": "string"
      }
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}
Response examples (400) 
{
  "statusCode": 400,
  "type": "ValidationException",
  "description": "Validation failed: \n -- PageSize: The page size must be between 1 and 2000 Severity: Error",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (400) 
{
  "statusCode": 400,
  "type": "ValidationException",
  "description": "Validation failed: \n -- PageSize: The page size must be between 1 and 2000 Severity: Error",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (500) 
{
  "statusCode": 500,
  "type": "NullReferenceException",
  "description": "An error happened processing your request. Please contact support.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (500) 
{
  "statusCode": 500,
  "type": "NullReferenceException",
  "description": "An error happened processing your request. Please contact support.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}