Amazon Billing And Cost Management Billing And Cost Management Invoice Unit API

openapi: 3.1.0
info:
  title: AWS Cost Explorer Service Invoice Unit API
  version: '2017-10-25'
  description: Generated from AWS's published Smithy model for AWS Cost Explorer Service. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://invoicing.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateInvoiceUnit:
    post:
      operationId: CreateInvoiceUnit
      summary: Create Invoice Unit
      description: This creates a new invoice unit with the provided definition.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateInvoiceUnitResponse'
              example:
                InvoiceUnitArn: arn:aws:invoicing::000000000000:invoice-unit/12345678
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Invoicing.CreateInvoiceUnit
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateInvoiceUnitRequest'
            example:
              Name: Example Invoice Unit
              InvoiceReceiver: '111111111111'
              Description: Example Invoice Unit Description
              TaxInheritanceDisabled: false
              Rule:
                LinkedAccounts:
                - '222222222222'
              ResourceTags:
              - Key: TagKey
                Value: TagValue
              ClientToken: e362c68e-4e74-48d7-9228-0bc5aa447b42
      tags:
      - Invoice Unit
  /#DeleteInvoiceUnit:
    post:
      operationId: DeleteInvoiceUnit
      summary: Delete Invoice Unit
      description: This deletes an invoice unit with the provided invoice unit ARN.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteInvoiceUnitResponse'
              example:
                InvoiceUnitArn: arn:aws:invoicing::000000000000:invoice-unit/12345678
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Invoicing.DeleteInvoiceUnit
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteInvoiceUnitRequest'
            example:
              InvoiceUnitArn: arn:aws:invoicing::000000000000:invoice-unit/12345678
              ClientToken: e362c68e-4e74-48d7-9228-0bc5aa447b44
      tags:
      - Invoice Unit
  /#GetInvoiceUnit:
    post:
      operationId: GetInvoiceUnit
      summary: Get Invoice Unit
      description: This retrieves the invoice unit definition.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetInvoiceUnitResponse'
              example:
                InvoiceReceiver: '111111111111'
                InvoiceUnitArn: arn:aws:invoicing::000000000000:invoice-unit/12345678
                LastModified: 1733788800
                Name: Example Invoice Unit A
                Description: Description changed on 1733788800
                Rule:
                  LinkedAccounts:
                  - '222222222222'
                TaxInheritanceDisabled: false
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Invoicing.GetInvoiceUnit
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetInvoiceUnitRequest'
            example:
              InvoiceUnitArn: arn:aws:invoicing::000000000000:invoice-unit/12345678
      tags:
      - Invoice Unit
  /#ListInvoiceUnits:
    post:
      operationId: ListInvoiceUnits
      summary: List Invoice Units
      description: This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListInvoiceUnitsResponse'
              example:
                InvoiceUnits:
                - InvoiceReceiver: '111111111111'
                  InvoiceUnitArn: arn:aws:invoicing::000000000000:invoice-unit/12345678
                  LastModified: 1733788800
                  Name: Example Invoice Unit A
                  Description: Description changed on 1733788800
                  Rule:
                    LinkedAccounts:
                    - '222222222222'
                  TaxInheritanceDisabled: false
                - InvoiceReceiver: '333333333333'
                  InvoiceUnitArn: arn:aws:invoicing::000000000000:invoice-unit/87654321
                  LastModified: 1733788800
                  Name: Example Invoice Unit B
                  Description: Description changed on 1733788800
                  Rule:
                    LinkedAccounts:
                    - '333333333333'
                  TaxInheritanceDisabled: true
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Invoicing.ListInvoiceUnits
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListInvoiceUnitsRequest'
            example: {}
      tags:
      - Invoice Unit
  /#UpdateInvoiceUnit:
    post:
      operationId: UpdateInvoiceUnit
      summary: Update Invoice Unit
      description: You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest
        configuration at the end of the month.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateInvoiceUnitResponse'
              example:
                InvoiceUnitArn: arn:aws:invoicing::000000000000:invoice-unit/12345678
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvoicingValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Invoicing.UpdateInvoiceUnit
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateInvoiceUnitRequest'
            example:
              InvoiceUnitArn: arn:aws:invoicing::000000000000:invoice-unit/12345678
              Description: Updated IU description
              TaxInheritanceDisabled: false
              Rule:
                LinkedAccounts:
                - '111111111111'
                - '222222222222'
              ClientToken: e362c68e-4e74-48d7-9228-0bc5aa447b42
      tags:
      - Invoice Unit
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: invoicing
  schemas:
    CreateInvoiceUnitRequest:
      type: object
      properties:
        Name:
          type: string
          description: The unique name of the invoice unit that is shown on the generated invoice. This can't be changed once
            it is set. To change this name, you must delete the invoice unit recreate.
        InvoiceReceiver:
          type: string
          description: The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated
            for that invoice unit will be sent to this account ID.
        Description:
          type: string
          description: The invoice unit's description. This can be changed at a later time.
        TaxInheritanceDisabled:
          type: boolean
          description: Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
        Rule:
          $ref: '#/components/schemas/InvoiceUnitRule'
        ResourceTags:
          type: array
          items:
            $ref: '#/components/schemas/InvoicingResourceTag'
          description: The tag structure that contains a tag key and value.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request.
      required:
      - Name
      - InvoiceReceiver
      - Rule
    CreateInvoiceUnitResponse:
      type: object
      properties:
        InvoiceUnitArn:
          type: string
          description: The ARN to identify an invoice unit. This information can't be modified or deleted.
    DeleteInvoiceUnitRequest:
      type: object
      properties:
        InvoiceUnitArn:
          type: string
          description: The ARN to identify an invoice unit. This information can't be modified or deleted.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request.
      required:
      - InvoiceUnitArn
    DeleteInvoiceUnitResponse:
      type: object
      properties:
        InvoiceUnitArn:
          type: string
          description: The ARN to identify an invoice unit. This information can't be modified or deleted.
    Filters:
      type: object
      properties:
        Names:
          type: array
          items:
            type: string
          description: An optional input to the list API. You can specify a list of invoice unit names inside filters to return
            invoice units that match only the specified invoice unit names. If multiple names are provided, the result is
            an OR condition (match any) of the specified invoice unit names.
        InvoiceReceivers:
          type: array
          items:
            type: string
          description: You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that
            match only the specified accounts. If multiple accounts are provided, the result is an OR condition (match any)
            of the specified accounts. This filter only matches the specified accounts on the invoice receivers of the invoice
            units.
        Accounts:
          type: array
          items:
            type: string
          description: You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that
            match only the specified accounts. If multiple accounts are provided, the result is an OR condition (match any)
            of the specified accounts. The specified account IDs are matched with either the receiver or the linked accounts
            in the rules.
        BillSourceAccounts:
          type: array
          items:
            type: string
          description: A list of Amazon Web Services account IDs used to filter invoice units. These are payer accounts from
            other Organizations that have delegated their billing responsibility to the receiver account through the billing
            transfer feature.
    GetInvoiceUnitRequest:
      type: object
      properties:
        InvoiceUnitArn:
          type: string
          description: The ARN to identify an invoice unit. This information can't be modified or deleted.
        AsOf:
          type: string
          format: date-time
          description: The state of an invoice unit at a specified time. You can see legacy invoice units that are currently
            deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the
            current time.
      required:
      - InvoiceUnitArn
    GetInvoiceUnitResponse:
      type: object
      properties:
        InvoiceUnitArn:
          type: string
          description: The ARN to identify an invoice unit. This information can't be modified or deleted.
        InvoiceReceiver:
          type: string
          description: The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated
            for that invoice unit will be sent to this account ID.
        Name:
          type: string
          description: The unique name of the invoice unit that is shown on the generated invoice.
        Description:
          type: string
          description: The assigned description for an invoice unit.
        TaxInheritanceDisabled:
          type: boolean
          description: Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
        Rule:
          $ref: '#/components/schemas/InvoiceUnitRule'
        LastModified:
          type: string
          format: date-time
          description: The most recent date the invoice unit response was updated.
    InvoiceUnit:
      type: object
      properties:
        InvoiceUnitArn:
          type: string
          description: ARN to identify an invoice unit. This information can't be modified or deleted.
        InvoiceReceiver:
          type: string
          description: The account that receives invoices related to the invoice unit.
        Name:
          type: string
          description: A unique name that is distinctive within your Amazon Web Services.
        Description:
          type: string
          description: The assigned description for an invoice unit. This information can't be modified or deleted.
        TaxInheritanceDisabled:
          type: boolean
          description: Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
        Rule:
          $ref: '#/components/schemas/InvoiceUnitRule'
        LastModified:
          type: string
          format: date-time
          description: The last time the invoice unit was updated. This is important to determine the version of invoice unit
            configuration used to create the invoices. Any invoice created after this modified time will use this invoice
            unit configuration.
    InvoiceUnitRule:
      type: object
      properties:
        LinkedAccounts:
          type: array
          items:
            type: string
          description: The list of LINKED_ACCOUNT IDs where charges are included within the invoice unit.
        BillSourceAccounts:
          type: array
          items:
            type: string
          description: A list of Amazon Web Services account IDs that have delegated their billing responsibility to the receiver
            account through transfer billing. Unlike linked accounts, these bill source accounts can be payer accounts from
            other organizations that have authorized billing transfer to this account.
    InvoicingAccessDeniedException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: You don't have sufficient access to perform this action.
    InvoicingInternalServerException:
      type: object
      properties:
        retryAfterSeconds:
          type: integer
          description: The processing request failed because of an unknown error, exception, or failure.
        message:
          type: string
    InvoicingResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The resource could not be found.
    InvoicingResourceTag:
      type: object
      properties:
        Key:
          type: string
          description: The object key of your of your resource tag.
        Value:
          type: string
          description: The specific value of the resource tag.
      required:
      - Key
      - Value
    InvoicingThrottlingException:
      type: object
      properties:
        message:
          type: string
    InvoicingValidationException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: You don't have sufficient access to perform this action.
        reason:
          type: string
          enum:
          - nonMemberPresent
          - maxAccountsExceeded
          - maxInvoiceUnitsExceeded
          - duplicateInvoiceUnit
          - mutualExclusionError
          - accountMembershipError
          - taxSettingsError
          - expiredNextToken
          - invalidNextToken
          - invalidInput
          - fieldValidationFailed
          - cannotParse
          - unknownOperation
          - other
          description: You don't have sufficient access to perform this action.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/InvoicingValidationExceptionField'
          description: The input fails to satisfy the constraints specified by an Amazon Web Services service.
    InvoicingValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The input fails to satisfy the constraints specified by an Amazon Web Services service.
        message:
          type: string
          description: The input fails to satisfy the constraints specified by an Amazon Web Services service.
      required:
      - name
      - message
    ListInvoiceUnitsRequest:
      type: object
      properties:
        Filters:
          $ref: '#/components/schemas/Filters'
        NextToken:
          type: string
          description: The next token used to indicate where the returned list should start from.
        MaxResults:
          type: integer
          description: The maximum number of invoice units that can be returned.
        AsOf:
          type: string
          format: date-time
          description: The state of an invoice unit at a specified time. You can see legacy invoice units that are currently
            deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the
            current time.
    ListInvoiceUnitsResponse:
      type: object
      properties:
        InvoiceUnits:
          type: array
          items:
            $ref: '#/components/schemas/InvoiceUnit'
          description: An invoice unit is a set of mutually exclusive accounts that correspond to your business entity.
        NextToken:
          type: string
          description: The next token used to indicate where the returned list should start from.
    UpdateInvoiceUnitRequest:
      type: object
      properties:
        InvoiceUnitArn:
          type: string
          description: The ARN to identify an invoice unit. This information can't be modified or deleted.
        Description:
          type: string
          description: The assigned description for an invoice unit. This information can't be modified or deleted.
        TaxInheritanceDisabled:
          type: boolean
          description: Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
        Rule:
          $ref: '#/components/schemas/InvoiceUnitRule'
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request.
      required:
      - InvoiceUnitArn
    UpdateInvoiceUnitResponse:
      type: object
      properties:
        InvoiceUnitArn:
          type: string
          description: The ARN to identify an invoice unit. This information can't be modified or deleted.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/invoicing/service/2024-12-01/invoicing-2024-12-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)