api.v2.return_premium module

api.v2.return_premium.exportReturnPremium(returnPremiumId=None)[source]

Given a valid return premium id, apply a checknumber, create a note on the corresponding policy, and return a json dict containing the values listed in getRPStatus.

Parameters:returnPremiumId (str) – A return premium id to export.
Returns:
  • success (bool) – True if completely successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (dict) – A dictionary containing the following:
    {
    'checkNumber': int,
    'returnPremiumId': UUID,
    'export_status': bool
    }