AgreementService / Client / list_agreement_charges

list_agreement_charges¶

AgreementService.Client.list_agreement_charges(**kwargs)¶

Allows acceptors to view charges and purchase orders that are associated with an agreement. The response includes details about all charges regardless of whether a purchase order is linked to each charge.

Request Syntax

response = client.list_agreement_charges(
    catalog='string',
    agreementId='string',
    agreementType='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

catalog (string) – The catalog in which the charges were created.
agreementId (string) – The unique identifier of the agreement.
agreementType (string) – Filter to retrieve charges of a specific agreement type (for example, PurchaseAgreement).
maxResults (integer) – The maximum number of charges to return in the response.
nextToken (string) – A token to specify where to start pagination.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'revision': 123,
            'agreementId': 'string',
            'agreementType': 'string',
            'purchaseOrderReference': 'string',
            'currencyCode': 'string',
            'amount': 'string',
            'time': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  A list of agreement charges.
  - (dict) –
    
    Represents a charge associated with an agreement, including amount, timing, and purchase order details.
    - id (string) –
      
      The unique identifier of the charge.
    - revision (integer) –
      
      The revision number of the charge.
    - agreementId (string) –
      
      The unique identifier of the agreement that resulted in this charge.
    - agreementType (string) –
      
      The type of agreement that resulted in this charge (for example, PurchaseAgreement).
    - purchaseOrderReference (string) –
      
      The purchase order reference associated with the charge, if any.
    - currencyCode (string) –
      
      The currency code for the charge amount.
    - amount (string) –
      
      The amount of the charge.
    - time (datetime) –
      
      The date and time when the charge will be incurred. This is available only when the charge date is known.
- nextToken (string) –
  
  The token used for pagination. The field is null if there are no more results.

Exceptions

AgreementService.Client.exceptions.ValidationException
AgreementService.Client.exceptions.AccessDeniedException
AgreementService.Client.exceptions.ThrottlingException
AgreementService.Client.exceptions.InternalServerException