Headers

• X-Tenant string Required

  The domain used to access the portal.

• 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

  text/plain

  text/plain application/json text/json

  The request completed with success and returns the invoices.

  Hide response attributes Show response attributes object

  • items array[object] | null

    The items for this page.

    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.

      Additional properties are NOT allowed.

      Hide invoiceLineItemsFile attributes Show invoiceLineItemsFile attributes object

      • 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.

    • status object

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

      Additional properties are NOT allowed.

      Hide status attribute Show status attribute object

      • name string | null

        The name of the enumeration.

  • paginationParameters object

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

    Additional properties are NOT allowed.

    Hide paginationParameters attributes Show paginationParameters attributes object

    • pageNumber integer(int32)

      Indicates the number of the current page.

    • pageSize integer(int32)

      The number of items that should be returned at most per page.

  • 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.

  Hide response attributes Show response attributes object

  • items array[object] | null

    The items for this page.

    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.

      Additional properties are NOT allowed.

      Hide invoiceLineItemsFile attributes Show invoiceLineItemsFile attributes object

      • 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.

    • status object

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

      Additional properties are NOT allowed.

      Hide status attribute Show status attribute object

      • name string | null

        The name of the enumeration.

  • paginationParameters object

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

    Additional properties are NOT allowed.

    Hide paginationParameters attributes Show paginationParameters attributes object

    • pageNumber integer(int32)

      Indicates the number of the current page.

    • pageSize integer(int32)

      The number of items that should be returned at most per page.

  • 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.

  Hide response attributes Show response attributes object

  • items array[object] | null

    The items for this page.

    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.

      Additional properties are NOT allowed.

      Hide invoiceLineItemsFile attributes Show invoiceLineItemsFile attributes object

      • 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.

    • status object

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

      Additional properties are NOT allowed.

      Hide status attribute Show status attribute object

      • name string | null

        The name of the enumeration.

  • paginationParameters object

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

    Additional properties are NOT allowed.

    Hide paginationParameters attributes Show paginationParameters attributes object

    • pageNumber integer(int32)

      Indicates the number of the current page.

    • pageSize integer(int32)

      The number of items that should be returned at most per page.

  • 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.

• 400

  text/plain

  text/plain application/json text/json

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

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

• 401

  Please use a valid authorization token.

• 403

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

• 500

  text/plain

  text/plain application/json text/json

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

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.

  Hide response attributes Show response attributes object

  • statusCode integer(int32)

    The HTTP status code that represents a specific error scenario.

  • type string | null

    The type of error that occurred.

  • description string | null

    Describes the error scenario that occurred.

  • correlationId string | null

    The correlationId of the request that originated the error.