AgreementService / Paginator / ListAgreementInvoiceLineItems

ListAgreementInvoiceLineItems

class AgreementService.Paginator.ListAgreementInvoiceLineItems

paginator = client.get_paginator('list_agreement_invoice_line_items')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgreementService.Client.list_agreement_invoice_line_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agreementId='string',
    groupBy='INVOICE_ID',
    invoiceId='string',
    invoiceType='INVOICE'|'CREDIT_MEMO',
    invoiceBillingPeriod={
        'month': 123,
        'year': 123
    },
    beforeIssuedTime=datetime(2015, 1, 1),
    afterIssuedTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• agreementId (string) –

  [REQUIRED]

  The unique identifier of the agreement.

• groupBy (string) –

  [REQUIRED]

  Specifies a grouping strategy for line items. Currently supports INVOICE_ID.

• invoiceId (string) – An optional filter to retrieve invoice information for a specific invoice.

• invoiceType (string) – An optional filter for the type of invoice. Valid values are INVOICE and CREDIT_MEMO.

• invoiceBillingPeriod (dict) –

  An optional filter for the billing period associated with the invoice.

  • month (integer) – [REQUIRED]

    The billing period month. Valid range: 1-12.

  • year (integer) – [REQUIRED]

    The billing period year.

• beforeIssuedTime (datetime) – An optional filter for invoices issued before the specified timestamp.

• afterIssuedTime (datetime) – An optional filter for invoices issued after the specified timestamp.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'agreementInvoiceLineItemGroupSummaries': [
        {
            'agreementId': 'string',
            'invoiceId': 'string',
            'pricingCurrencyAmount': {
                'amount': 'string',
                'maxAdjustmentAmount': 'string',
                'currencyCode': 'string'
            },
            'invoiceBillingPeriod': {
                'month': 123,
                'year': 123
            },
            'issuedTime': datetime(2015, 1, 1),
            'invoiceType': 'INVOICE'|'CREDIT_MEMO',
            'invoicingEntity': {
                'legalName': 'string',
                'branchName': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • agreementInvoiceLineItemGroupSummaries (list) –

    A list of grouped billing data objects.

    • (dict) –

      A summary of grouped billing data for an agreement invoice line item.

      • agreementId (string) –

        The unique identifier of the agreement.

      • invoiceId (string) –

        The identifier of the invoice for this group.

      • pricingCurrencyAmount (dict) –

        Monetary amounts for this invoice group.

        • amount (string) –

          The monetary amount before tax.

        • maxAdjustmentAmount (string) –

          The maximum refundable amount as a string representation of a decimal number.

        • currencyCode (string) –

          The 3-letter ISO 4217 currency code (e.g., USD, EUR, JPY).

      • invoiceBillingPeriod (dict) –

        The billing period associated with this group.

        • month (integer) –

          The billing period month. Valid range: 1-12.

        • year (integer) –

          The billing period year.

      • issuedTime (datetime) –

        The timestamp when the invoice containing this group was created.

      • invoiceType (string) –

        The type of invoice. Valid values are INVOICE and CREDIT_MEMO.

      • invoicingEntity (dict) –

        The entity that issues the invoice.

        • legalName (string) –

          Legal name of the entity issuing the invoice.

        • branchName (string) –

          The branch where the issuing entity is operating from.

  • NextToken (string) –

    A token to resume pagination.