AgreementService / Client / exceptions / ValidationException

ValidationException¶

class AgreementService.Client.exceptions.ValidationException¶

The input fails to satisfy the constraints specified by the service.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)

response¶

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'requestId': 'string',
    'message': 'string',
    'reason': 'MISSING_BILLING_ADJUSTMENTS'|'BILLING_ADJUSTMENTS_LIMIT_EXCEEDED'|'MISSING_INVOICE_ID'|'INVALID_ADJUSTMENT_AMOUNT'|'MISSING_ADJUSTMENT_AMOUNT'|'INVALID_REASON_CODE'|'MISSING_REASON_CODE'|'MISSING_DESCRIPTION'|'INVALID_INVOICE_ADJUSTMENT_PERIOD'|'INVALID_CURRENCY_CODE'|'MISSING_CURRENCY_CODE'|'EXCEEDED_MAXIMUM_ADJUSTMENT_AMOUNT'|'MISSING_BILLING_ADJUSTMENT_REQUEST_ENTRY'|'MULTIPLE_AGREEMENT_IDS'|'INVALID_AGREEMENT_CANCELLATION_REQUEST_ID'|'MISSING_AGREEMENT_CANCELLATION_REQUEST_ID'|'MISSING_REASON'|'INVALID_REASON'|'INVALID_STATUS'|'INVALID_AGREEMENT_ID'|'MISSING_AGREEMENT_ID'|'INVALID_CATALOG'|'INVALID_FILTERS'|'INVALID_FILTER_NAME'|'MISSING_FILTER_NAME'|'INVALID_FILTER_VALUES'|'MISSING_FILTER_VALUES'|'INVALID_SORT_BY'|'INVALID_SORT_ORDER'|'INVALID_NEXT_TOKEN'|'INVALID_MAX_RESULTS'|'INVALID_TERM_ID'|'MISSING_TERM_ID'|'MISSING_NAME'|'INVALID_NAME'|'INVALID_DESCRIPTION'|'MISSING_CHARGE_AMOUNT'|'INVALID_CHARGE_AMOUNT'|'MISSING_PAYMENT_REQUEST_ID'|'INVALID_PAYMENT_REQUEST_ID'|'MISSING_PARTY_TYPE'|'INVALID_PARTY_TYPE'|'UNSUPPORTED_FILTERS'|'INVALID_CLIENT_TOKEN'|'INVALID_INTENT'|'MISSING_INTENT'|'INVALID_SOURCE_AGREEMENT_IDENTIFIER'|'MISSING_SOURCE_AGREEMENT_IDENTIFIER'|'INVALID_AGREEMENT_PROPOSAL_IDENTIFIER'|'MISSING_AGREEMENT_PROPOSAL_IDENTIFIER'|'INVALID_REQUESTED_TERMS'|'MISSING_REQUESTED_TERMS'|'INVALID_REQUESTED_TERM_ID'|'MISSING_REQUESTED_TERM_ID'|'INVALID_REQUESTED_TERM_CONFIGURATION'|'MISSING_REQUESTED_TERM_CONFIGURATION'|'INVALID_AGREEMENT_REQUEST_ID'|'MISSING_AGREEMENT_REQUEST_ID'|'INVALID_PURCHASE_ORDERS'|'MISSING_PURCHASE_ORDERS'|'INVALID_CHARGE_ID'|'MISSING_CHARGE_ID'|'INVALID_CHARGE_REVISION'|'MISSING_CHARGE_REVISION'|'INVALID_AGREEMENT_TYPE'|'INVALID_PURCHASE_ORDER_REFERENCE'|'INACTIVE_AGREEMENT'|'SUPERSEDED_AGREEMENT_PROPOSAL'|'EXPIRED_AGREEMENT_PROPOSAL'|'MISSING_MANDATORY_TERMS'|'INCOMPATIBLE_TERMS'|'MISSING_USAGE_AGREEMENT'|'INVALID_INCREMENTAL_CHARGE'|'MISSING_ACCOUNT_ADDRESS'|'UNSUPPORTED_ACTION'|'INVALID_REJECTION_REASON'|'INVALID_PAYMENT_REQUEST_STATUS'|'OTHER'|'DUPLICATE_CHARGES'|'UNSUPPORTED_ACCOUNT_PLAN'|'DUPLICATE_AGREEMENT_IN_ORGANIZATION'|'MISSING_PURCHASE_ORDER_REFERENCE',
    'fields': [
        {
            'name': 'string',
            'message': 'string'
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) –

The input fails to satisfy the constraints specified by the service.
- requestId (string) –
  
  The unique identifier associated with the error.
- message (string) –
  
  Description of the error.
- reason (string) –
  
  The reason associated with the error.
- fields (list) –
  
  The fields associated with the error.
  - (dict) –
    
    The input fails to satisfy the constraints specified by the service.
    - name (string) –
      
      The name of the field associated with the error.
    - message (string) –
      
      See applicable actions.
- Error (dict) – Normalized access to common exception attributes.
  - Code (string) – An identifier specifying the exception type.
  - Message (string) – A descriptive message explaining why the exception occured.