list_invoice_summaries ¶

def list_invoice_summaries(
    self,
    selector: "capo_invoicing.types.invoice_summaries_selector.InvoiceSummariesSelector",
    *,
    config_overrides: Optional[InvoicingClientConfig] = None,
    filter: Optional[
        "capo_invoicing.types.invoice_summaries_filter.InvoiceSummariesFilter"
    ] = None,
    next_token: Optional[
        "capo_invoicing.types.next_token_string.NextTokenString"
    ] = None,
    max_results: Optional[
        "capo_invoicing.types.invoice_summaries_max_results.InvoiceSummariesMaxResults"
    ] = None,
) -> "capo_invoicing.types.list_invoice_summaries_response.ListInvoiceSummariesResponse":
    """<p>Retrieves your invoice details programmatically, without line item details.</p>

    Args:
        selector: <p>The option to retrieve details for a specific invoice by providing its unique ID. Alternatively, access information for all invoices linked to the account by providing an account ID.</p>
        filter: <p>Filters you can use to customize your invoice summary.</p>
        next_token: <p>The token for the next set of results. (You received this token from a previous call.)</p>
        max_results: <p>The maximum number of invoice summaries a paginated response can contain.</p>

    Raises:
        capo_invoicing.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_invoicing.errors.internal_server_exception.InternalServerException: <p>The processing request failed because of an unknown error, exception, or failure. </p>
        capo_invoicing.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found. </p>
        capo_invoicing.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_invoicing.errors.validation_exception.ValidationException: <p> The input fails to satisfy the constraints specified by an Amazon Web Services service. </p>
        capo_invoicing.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        ListInvoiceSummaries with InvoiceId as selector

        >>> client.list_invoice_summaries(selector={'ResourceType': 'INVOICE_ID', 'Value': '1111111111'})
        ListInvoiceSummaries with AccountId as selector and billing period

        >>> client.list_invoice_summaries(selector={'ResourceType': 'ACCOUNT_ID', 'Value': '111111111111'}, filter={'BillingPeriod': {'Month': 1, 'Year': 2025}})
        ListInvoiceSummaries with AccountId as selector and time interval

        >>> client.list_invoice_summaries(selector={'ResourceType': 'ACCOUNT_ID', 'Value': '111111111111'}, filter={'TimeInterval': {'StartDate': 1590997407, 'EndDate': 1592639007}})
        ListInvoiceSummaries filtered by ReceiverRole

        >>> client.list_invoice_summaries(selector={'ResourceType': 'ACCOUNT_ID', 'Value': '111111111111'}, filter={'TimeInterval': {'StartDate': 1748736000, 'EndDate': 1751328000}, 'ReceiverRole': 'SELLER'})
        ListInvoiceSummaries with AccountId as selector and a billing period and max results

        >>> client.list_invoice_summaries(selector={'ResourceType': 'ACCOUNT_ID', 'Value': '111111111111'}, filter={'BillingPeriod': {'Month': 1, 'Year': 2025}}, max_results=1)
        ListInvoiceSummaries with AccountId as selector and a billing period and next token

        >>> client.list_invoice_summaries(selector={'ResourceType': 'ACCOUNT_ID', 'Value': '111111111111'}, filter={'BillingPeriod': {'Month': 1, 'Year': 2025}}, next_token='abcde12345')
    """

    def _handler(
        req: "OperationRequest[capo_invoicing.types.list_invoice_summaries_request.ListInvoiceSummariesRequest]",
    ) -> OperationResponse[
        "capo_invoicing.types.list_invoice_summaries_response.ListInvoiceSummariesResponse"
    ]:
        import capo_invoicing._operations.invoicing.list_invoice_summaries

        output, http_response = (
            capo_invoicing._operations.invoicing.list_invoice_summaries.list_invoice_summaries(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListInvoiceSummaries")
    )
    input_: capo_invoicing.types.list_invoice_summaries_request.ListInvoiceSummariesRequest = {
        "selector": selector
    }
    if filter is not None:
        input_["filter"] = filter
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output