api.v2.claims module

api.v2.claims.export_claim_payments(payments=None, assign_check_date=False)[source]

Exports claim payments and optionally assigns a check number to them. The optional check number can be manually or automatically assigned.

In case any payment in the request is not exported there are two possible individual payment response detail messages: #. payment not found #. payment already exported

Parameters:
  • payments (list) –

    List of dictionaries containing the following data representation. :: [

    {
    ‘id’: string (uuid), ClaimTransaction.id ‘check_number’: int/string, check number (int), ‘auto_assign’, or None

    ]

  • assign_check_date (bool) – If true, assign today’s date to all payments.
Returns:

  • success (bool) – True if all exports were successful, false if not

  • messages (list of str) – List of human-readable error messages

  • data (dict) – List of dictionaries containing the following data representation. ::
    [
    {

    ‘id’: string (uuid), ClaimTransaction.id, ‘check_date’: date string, i.e. 2017-01-31, ‘check_number’: int, The number if one was assigned, or None if not, ‘status’: string, ‘success’ if succesfully exported, or ‘error’ if not, ‘detail’: string, error message or None

    ]

api.v2.claims.get_claim(claim_id=None)[source]

Retrieve claim by id.

Parameters:claim_id (str) – claim id
Returns:
  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (dict containing claim)
api.v2.claims.get_claim_payments(include_exported=False, include_voided=False, classification_types=None)[source]

Get a list of claims payments, including each payment’s classification name as classification_type as well as selected payee names and addresses.

Parameters:
  • include_exported (bool (Defaults to False)) – Set to True to include exported payments.
  • include_voided (bool (Defaults to False)) – Set to True to include voided payments.
  • classification_types (list (Optional)) – A list strings. Each string is the name of a claims payment classification to filter the results by. Defaults to all payment classifications (including null).
Returns:

  • success (bool) – True if successful, false if not

  • messages (list of str) – List of human-readable error messages

  • data (list) – A list of claim payment dicts having the form:

    [
        {
            'id': str,
            'address': {
                "type": str,
                "type_label": str or null,
                "attention": str or null,
                "address_line1": str,
                "address_line2": str or null,
                "address_city": str,
                "address_county": str,
                "address_state": str,
                "address_country": str,
                "address_zip": str
            }, # or null
            'amount': float,
            'check_date': str or null,
            'check_display': str or null,
            'check_number': int or null,
            'claim_id': str,
            'claim_number': str,
            'date_updated': str,
            'deductible': int,
            'description': str or null,
            'exported': bool,
            'classification_type': str or null,
            'payment_method_id': str,
            'type': 'payment',
            'historical': bool,
            'item_amounts': [
                {
                    'legalPaid': str (Decimal),
                    'claimItemId': str,
                    'lineItemName': str,
                    'lossPaid': str (Decimal),
                    'adjustingPaid': str (Decimal)
                },
                ...
            ],
            'memo': str or null,
            'policy_number': str,
            'recovery_category': str or null,
            'reinsurance_contract_contact_id': str or null,
            'selected_payees': [
                {
                    'name': str,
                    'addresses': [
                        {
                            "type": str,
                            "type_label": str or null,
                            "attention": str or null,
                            "address_line1": str,
                            "address_line2": str or null,
                            "address_city": str,
                            "address_county": str,
                            "address_state": str,
                            "address_country": str,
                            "address_zip": str
                        },
                        ...
                    ],  # or []
                ...
            ],  # or []
            'transaction_date': str,
            'voided': bool,
            'voided_date': str or null,