openapi: 3.2.0
info:
  description: Use the Usage Proxy API to list Oracle Support Rewards, view related detailed usage information, and manage users who redeem rewards. For more information, see [Oracle Support Rewards Overview](/iaas/Content/Billing/Concepts/supportrewardsoverview.htm).
  title: Usage Proxy Invoice Summary API
  version: '20190111'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/923c4c9e7faf08854042f276c1ca058bf5c0d7901ddbf9c52717a1816a0e8d82.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Usage Proxy API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/923c4c9e7faf08854042f276c1ca058bf5c0d7901ddbf9c52717a1816a0e8d82.yaml
    what: the harvested document for Usage Proxy API
servers:
- url: https://127.0.0.1/20190111
tags:
- name: invoiceSummary
paths:
  /invoice:
    get:
      description: 'Collection API that returns a list of invoices according to the given filters.

        '
      operationId: ListInvoices
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/ARCustomerTransactionIdQueryParam'
      - $ref: '#/components/parameters/InvoicingDateFromQueryParam'
      - $ref: '#/components/parameters/InvoicingDateToQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/InvoicingRequestFieldsQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Successful operation. Returns a list of invoices according to the provided parameters.

            '
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/InvoiceSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of Invoices
      tags:
      - invoiceSummary
  /invoiceLineComputedUsages:
    get:
      description: 'Collection API that returns a list of invoiced computed usages for the given invoice line ID.

        '
      operationId: ListInvoicelineComputedUsages
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/InvoiceLineIdQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ComputedUsagesSortByQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/InvoicingRequestFieldsQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Successful operation. Returns a list of computed usages under the given invoice line.

            '
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/InvoicelineComputedUsageSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of Invoiced Computed Usages
      tags:
      - invoiceSummary
components:
  schemas:
    InvoicingUser:
      description: 'User.

        '
      properties:
        email:
          description: 'Email.

            '
          format: email
          type: string
        firstName:
          description: 'First name.

            '
          type: string
        lastName:
          description: 'Last name.

            '
          type: string
        name:
          description: 'Name.

            '
          type: string
        tcaContactId:
          description: 'TCA (Trading Community Architecture) contact ID.

            '
          format: int64
          type: integer
        tcaCustAccntSiteId:
          description: 'TCA customer account site ID.

            '
          format: int64
          type: integer
        tcaPartyId:
          description: 'TCA party ID.

            '
          format: int64
          type: integer
        userName:
          description: 'User name.

            '
          type: string
      type: object
    InvoicingProduct:
      description: 'Product description.

        '
      properties:
        billingCategory:
          description: 'Metered service billing category.

            '
          example: Metered Subscription Commitment
          type: string
        name:
          description: 'Product name.

            '
          type: string
        partNumber:
          description: 'Product part number.

            '
          type: string
        productCategory:
          description: 'Product category.

            '
          example: CLOUDPAAS
          type: string
        ucmRateCardPartType:
          description: 'Rate card part type of product.

            '
          example: Free Pricing Tier - Consumption
          type: string
        unitOfMeasure:
          description: 'Unit of measure.

            '
          type: string
      required:
      - partNumber
      - name
      - unitOfMeasure
      - ucmRateCardPartType
      type: object
    InvoicingLocation:
      description: 'Address location.

        '
      properties:
        address1:
          description: 'Address first line.

            '
          type: string
        address2:
          description: 'Address second line.

            '
          type: string
        city:
          description: 'City.

            '
          type: string
        country:
          description: 'Country.

            '
          type: string
        postalCode:
          description: 'Postal code.

            '
          type: string
        region:
          description: 'Region.

            '
          type: string
        tcaLocationId:
          description: 'TCA (Trading Community Architecture) location identifier.

            '
          format: int64
          type: integer
      type: object
    Error:
      description: Error object model.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
      type: object
    InvoiceLineSummary:
      description: 'Invoice line.

        '
      properties:
        arInvoiceNumber:
          description: 'Accounts receivable invoice number for invoice line.

            '
          example: '8173868'
          type: string
        dataCenter:
          description: 'Data center attribute.

            '
          example: US001
          type: string
        id:
          description: 'SPM (Subscription Plan Management) invoice line internal identifier.

            '
          type: string
        product:
          $ref: '#/components/schemas/InvoicingProduct'
        timeEnd:
          description: 'Usage end time.

            '
          format: date-time
          type: string
        timeStart:
          description: 'Usage start time.

            '
          format: date-time
          type: string
      required:
      - id
      - product
      - timeStart
      - timeEnd
      - dataCenter
      type: object
    InvoicingBusinessPartner:
      description: 'Business partner.

        '
      properties:
        customerChainType:
          description: 'Customer chain type.

            '
          type: string
        isChainCustomer:
          description: 'Specifies whether or not the business partner is a chain customer.

            '
          type: boolean
        isPublicSector:
          description: 'Specifies whether or not the business partner is part of the public sector.

            '
          type: boolean
        name:
          description: 'Commercial name, also referred to as customer name.

            '
          type: string
        namePhonetic:
          description: 'Phonetic name.

            '
          type: string
        tcaCustomerAccountId:
          description: 'TCA customer account ID.

            '
          format: int64
          type: integer
        tcaCustomerAccountNumber:
          description: 'TCA (Trading Community Architecture) customer account number.

            '
          type: string
        tcaPartyId:
          description: 'TCA party ID.

            '
          format: int64
          type: integer
        tcaPartyNumber:
          description: 'TCA party number.

            '
          type: string
      type: object
    InvoiceSummary:
      description: 'Invoice details.

        '
      properties:
        arInvoices:
          description: 'Accounts receivable invoice numbers, comma-separated under one invoice.

            '
          example: 8173868,8173869
          type: string
        billToAddress:
          $ref: '#/components/schemas/InvoicingAddress'
        billToContact:
          $ref: '#/components/schemas/InvoicingUser'
        billToCustomer:
          $ref: '#/components/schemas/InvoicingBusinessPartner'
        createdBy:
          description: 'User that executed the SPM invoice process.

            '
          example: user@oracle.com
          type: string
        currency:
          $ref: '#/components/schemas/InvoicingCurrency'
        invoiceLines:
          description: 'Invoice lines under a particular invoice.

            '
          items:
            $ref: '#/components/schemas/InvoiceLineSummary'
          type: array
        organization:
          $ref: '#/components/schemas/InvoicingOrganization'
        paymentMethod:
          description: 'Payment method.

            '
          example: Credit Card
          type: string
        paymentTerm:
          $ref: '#/components/schemas/InvoicingPaymentTerm'
        receiptMethod:
          description: 'Receipt method of payment mode.

            '
          example: GB Credit Card
          type: string
        spmInvoiceNumber:
          description: 'SPM (Subscription Plan Management) document number is a functional identifier for invoicing in SPM.

            '
          example: '1792351'
          type: string
        status:
          description: 'Document status in SPM, which depicts the current invoice state.

            '
          example: Complete
          type: string
        subscriptionNumber:
          description: 'Invoice associated subscription plan number.

            '
          example: '10738384'
          type: string
        timeCreated:
          description: 'SPM invocie creation date.

            '
          format: date-time
          type: string
        timeInvoiceDate:
          description: 'Invoice date.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'SPM invoice updated date.

            '
          format: date-time
          type: string
        type:
          description: 'Document type in SPM, such as SPM Invoice, SPM Credit Memo, and so on.

            '
          example: SPM Credit Memo
          type: string
        updatedBy:
          description: 'User that updated the SPM invoice.

            '
          example: user@oracle.com
          type: string
      required:
      - spmInvoiceNumber
      - paymentMethod
      - billToCustomer
      - billToContact
      - billToAddress
      - paymentTerm
      - currency
      - organization
      - type
      - status
      - subscriptionNumber
      - timeInvoiceDate
      type: object
    InvoicingPaymentTerm:
      description: 'Payment term details.

        '
      properties:
        createdBy:
          description: 'User that created the payment term.

            '
          example: user@oracle.com
          type: string
        description:
          description: 'Payment term description.

            '
          example: GB_30 NET
          type: string
        isActive:
          description: 'Payment term active parameter.

            '
          example: true
          type: boolean
        name:
          description: 'Payment term name.

            '
          example: GB_30 NET
          type: string
        timeCreated:
          description: 'Payment term last update date.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Payment term last update date.

            '
          format: date-time
          type: string
        updatedBy:
          description: 'User that updated the payment term.

            '
          example: user@oracle.com
          type: string
        value:
          description: 'Payment term value.

            '
          example: '4177178'
          type: string
      required:
      - name
      type: object
    InvoicelineComputedUsageSummary:
      description: 'Computed usage summary object.

        '
      properties:
        cost:
          description: 'Sum of usage/service billing line net amount.

            '
          example: 10
          format: double
          type: number
        costRounded:
          description: 'Computed rounded line amount.

            '
          format: double
          type: number
        netUnitPrice:
          description: 'Net unit price for the product in consideration, price actual.

            '
          format: double
          type: number
        parentProduct:
          $ref: '#/components/schemas/InvoicingProduct'
        product:
          $ref: '#/components/schemas/InvoicingProduct'
        quantity:
          description: 'Total quantity that was used for computation.

            '
          format: double
          type: number
        timeMeteredOn:
          description: 'Metered service date.

            '
          format: date-time
          type: string
        type:
          description: 'Usage compute type in SPM (Subscription Plan Management).

            '
          enum:
          - PROMOTION
          - DO_NOT_BILL
          - USAGE
          - COMMIT
          - OVERAGE
          - PAY_AS_YOU_GO
          - MONTHLY_MINIMUM
          - DELAYED_USAGE_INVOICE_TIMING
          - DELAYED_USAGE_COMMITMENT_EXP
          - ON_ACCOUNT_CREDIT
          - SERVICE_CREDIT
          type: string
      required:
      - parentProduct
      - quantity
      - netUnitPrice
      - timeMeteredOn
      - type
      - costRounded
      type: object
    InvoicingCurrency:
      description: 'Currency details.

        '
      properties:
        isoCode:
          description: 'Currency code.

            '
          example: USD
          type: string
        name:
          description: 'Currency name.

            '
          example: US Dollar
          type: string
        stdPrecision:
          description: 'Standard precision of the currency.

            '
          example: 2
          format: int64
          type: integer
      required:
      - isoCode
      type: object
    InvoicingOrganization:
      description: 'Organization details.

        '
      properties:
        name:
          description: 'Organization name.

            '
          example: Oracle India Private Limited
          type: string
        number:
          description: 'Organization ID.

            '
          example: 1080544
          format: double
          type: number
      required:
      - name
      - number
      type: object
    InvoicingAddress:
      description: 'Address.

        '
      properties:
        billSiteUseId:
          description: 'Bill to site use ID.

            '
          format: int64
          type: integer
        isBillTo:
          description: 'Identify as the customer''s billing address.

            '
          type: boolean
        isShipTo:
          description: 'Identify as the customer''s shipping address.

            '
          type: boolean
        location:
          $ref: '#/components/schemas/InvoicingLocation'
        name:
          description: 'Address name identifier.

            '
          type: string
        phone:
          description: 'Phone.

            '
          type: string
        service2SiteUseId:
          description: 'Service to site use ID.

            '
          format: int64
          type: integer
        tcaCustAcctSiteId:
          description: 'TCA (Trading Community Architecture) customer account site ID.

            '
          format: int64
          type: integer
        tcaPartySiteNumber:
          description: 'Party site number.

            '
          type: string
      type: object
  parameters:
    PaginationTokenQueryParam:
      description: 'The value of the ''opc-next-page'' response header from the previous "List" call.

        '
      in: query
      name: page
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 512
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. You can provide one sort order (''sortOrder'').

        '
      in: query
      name: sortBy
      required: false
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - ORDERNUMBER
        - TIMEINVOICING
    InvoiceLineIdQueryParam:
      description: 'Invoice line identifier - Primary Key SPM (Subscription Plan Management).

        '
      in: query
      name: invoiceLineId
      required: true
      x-default-description: 'null'
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The OCID of the root compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ComputedUsagesSortByQueryParam:
      description: 'The field to sort by invoiced computed usages. You can provide one sort order (`sortOrder`).

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - timeCreated
        - meteredOnDate
        default: timeCreated
    PaginationLimitQueryParam:
      description: 'The maximum number of items to return in a paginated "List" call. Default: (`50`)


        Example: ''500''

        '
      in: query
      name: limit
      required: false
      x-default-description: 500
      schema:
        type: integer
        maximum: 1000
        minimum: 1
    InvoicingDateToQueryParam:
      description: 'Final date to filter invoice data in SPM (Subscription Plan Management).

        '
      in: query
      name: timeTo
      required: false
      x-default-description: 'null'
      schema:
        type: string
        format: date-time
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (''ASC'') or descending (''DESC'').

        '
      in: query
      name: sortOrder
      required: false
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    OpcRequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      required: false
      x-default-description: 'null'
      schema:
        type: string
    InvoicingRequestFieldsQueryParam:
      description: "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return only the information \n(fields) required by the client. This parameter controls which fields to\nreturn.\n"
      in: query
      name: fields
      required: false
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
        default: []
    InvoicingDateFromQueryParam:
      description: 'Initial date to filter invoice data in SPM (Subscription Plan Management).

        '
      in: query
      name: timeFrom
      required: false
      x-default-description: 'null'
      schema:
        type: string
        format: date-time
    ARCustomerTransactionIdQueryParam:
      description: Accounts receivable unique identifier for an invoice.
      in: query
      name: arCustomerTransactionId
      required: true
      x-default-description: 'null'
      schema:
        type: string
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If

            you need to contact Oracle about a particular request,

            please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
x-oracle-package: com.oracle.pic.usage