api.v1.deliverables module

api.v1.deliverables.create_deliverable(json_dict={})[source]

Generates the requested deliverable for the requested revision or claim.

Parameters:
  • revision_id (uuid) – Required. The database identifier of the revision for which a deliverable should be generated
  • deliverable_type (str) – Required. The name of the deliverable that should be generated
  • go_date (str) – Effective date for the deliverable (bill date, print date, etc.)
  • reference_type (str) – Either ‘policies’ or ‘claims’, depending on the type of deliverable being requested
  • proc_date (str) – Date that will be recorded as the generation date of the deliverable
  • location_id (uuid) – Specifies the business location whose version of the requested deliverable should be generated (were multiple copies of like-named deliverables to exist). Can differ from the specified revision’s location at the caller’s own risk. If not specified, will be inferred to be the location of the specified revision
  • invoice_id (uuid) – For deliverables that utilize a “last invoice” for content population, serves as an override to render off a known invoice’s data
  • reason (str) – Reason for generating a deliverable. Can have an impact on print date, based on deliverable type
  • claim_number (str) – Number of the claim that should be used for populating the content of the requested deliverable
  • return_premium_id (uuid) – For deliverables that utilize a “return premium” for content population, serves as an override to render off a known return premium’s data
  • filepath (str) – Filepath under which the new deliverable should be stored
  • claim_id (uuid) – Database identifier of the claim that should be used for populating the content of the requested deliverable
  • claim_loss_date (str) – For deliverables that utilize a “loss date” for content population, serves as that value
  • delay_print_days (int) – Number of days that the print date should be delayed from its typical assignment
  • print_state (str) – Print state to be given to the deliverable
Returns:

  • success (bool) – Whether or not the deliverable was generated

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

  • data (dict) – An object of the following format, pointing to the location of the folder containing the generated deliverable.

    {
        "deliverable_url": {
            "url": "uploads/...",
            "path": "/srv/www/britecore/uploads/..."
        }
    }