deliverables

create_deliverable

POST

/api/v1/deliverables/create_deliverable

Generates the requested deliverable for the requested revision or claim.

Code
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/..."
            }
        }

create_deliverable › Request Body

revision_id

string

deliverable_type

string

go_date

string

reference_type

string

proc_date

string

location_id

string

invoice_id

string

reason

string

claim_number

string

return_premium_id

string

filepath

string

claim_id

string

claim_loss_date

string

delay_print_days

integer

print_state

string

create_deliverable › Responses

200

success

boolean

message

string[]

data

object

POST/api/v1/deliverables/create_deliverable

curl --request POST \
  --url /api/v1/deliverables/create_deliverable \
  --header 'Content-Type: application/json' \
  --data '
{
  "revision_id": "revision_id",
  "deliverable_type": "deliverable_type",
  "go_date": "go_date",
  "reference_type": "reference_type",
  "proc_date": "proc_date",
  "location_id": "location_id",
  "invoice_id": "invoice_id",
  "reason": "reason",
  "claim_number": "claim_number",
  "return_premium_id": "return_premium_id",
  "filepath": "filepath",
  "claim_id": "claim_id",
  "claim_loss_date": "claim_loss_date",
  "delay_print_days": 0,
  "print_state": "print_state"
}
'

Example Request Body

{
  "revision_id": "revision_id",
  "deliverable_type": "deliverable_type",
  "go_date": "go_date",
  "reference_type": "reference_type",
  "proc_date": "proc_date",
  "location_id": "location_id",
  "invoice_id": "invoice_id",
  "reason": "reason",
  "claim_number": "claim_number",
  "return_premium_id": "return_premium_id",
  "filepath": "filepath",
  "claim_id": "claim_id",
  "claim_loss_date": "claim_loss_date",
  "delay_print_days": 0,
  "print_state": "print_state"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

delete_html_template

POST

/api/v2/deliverables/delete_html_template

Deletes an HTML Template by name

Code
Parameters
----------
name : str
    The name to use when referencing the HTMLTemplate.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : none

delete_html_template › Request Body

Request payload for /api/v2/deliverables/delete_html_template

request-delete_html_template

name

string · required

Name of the template to delete.

delete_html_template › Responses

200

Response schema for /api/v2/deliverables/delete_html_template

response-delete_html_template

data

object · required

Empty object

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/deliverables/delete_html_template

curl --request POST \
  --url /api/v2/deliverables/delete_html_template \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {},
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

delete_static_resource

POST

/api/v2/deliverables/delete_static_resource

Deletes a static resource by name

Code
Parameters
----------
name : str, required
    The name to use when referencing the static resource in your Jinja template. (ex. test.png)

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : none

delete_static_resource › Request Body

name

string

delete_static_resource › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/delete_static_resource

curl --request POST \
  --url /api/v2/deliverables/delete_static_resource \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

expire_all_static_resources

POST

/api/v2/deliverables/expire_all_static_resources

Expires all static resources

Code
Parameters
----------

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : none

expire_all_static_resources › Request Body

expire_all_static_resources › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/expire_all_static_resources

curl --request POST \
  --url /api/v2/deliverables/expire_all_static_resources \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

expire_static_resource

POST

/api/v2/deliverables/expire_static_resource

Expires a static resource by name

Code
Parameters
----------
name : str, required
    The name to use when referencing the static resource in your Jinja template. (ex. test.png)

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : none

expire_static_resource › Request Body

name

string

expire_static_resource › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/expire_static_resource

curl --request POST \
  --url /api/v2/deliverables/expire_static_resource \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

finalize_recovery_candidate

POST

/api/v2/deliverables/finalize_recovery_candidate

finalize_recovery_candidate

finalize_recovery_candidate › Request Body

Request payload for /api/v2/deliverables/finalize_recovery_candidate

request-finalize_recovery_candidate

job_id

string · uuid · required

BackgroundJob ID of the completed recovery task.

candidate_id

string · required

Candidate identifier being finalized, e.g. 'file:uuid'.

finalize_recovery_candidate › Responses

200

Response schema for /api/v2/deliverables/finalize_recovery_candidate

response-finalize_recovery_candidate

object · required

Result of the finalization step.

success

boolean · required

Indicates if the request was successful.

required

POST/api/v2/deliverables/finalize_recovery_candidate

curl --request POST \
  --url /api/v2/deliverables/finalize_recovery_candidate \
  --header 'Content-Type: application/json' \
  --data '
{
  "job_id": "00000000-0000-0000-0000-000000000000",
  "candidate_id": "candidate_id"
}
'

Example Request Body

{
  "job_id": "00000000-0000-0000-0000-000000000000",
  "candidate_id": "candidate_id"
}

Example Responses

{
  "data": {
    "candidate_id": "candidate_id",
    "status": "finalized",
    "replacement_file_id": "00000000-0000-0000-0000-000000000000",
    "attachment_url": "attachment_url",
    "message": "message"
  },
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

getDeliverableData

POST

/api/v2/deliverables/getDeliverableData

Get Deliverable Data

Code
Parameters
----------
revision_id : str
date_cursor : str
deliverable_type : str
reason : str
state_id : str
invoice_id : str
return_data : bool
coverage_forms : list

Returns
-------

data: dict
    The data response having the form:
    ::

        custom_fee_names
            cancellation_threshold
            last_invoice
                debit_custom_fee_fully_earned
                date_updated
                waive_id
                debit_custom_fee_fully_billed
                policy_term_id
                id
                debit_premium_fully_billed
                generated_by
                debit_premium_fully_earned
                payment_amount
                day_zero_date
                transaction_date_time
                due_date
                account_balance
                description
                deleted
                debit_custom_fee_pro_rata
                cancel_date
                file_id
                date_added
                back_cancel_date
                payment_id
                debit_premium_pro_rata
                date_added_micro
                date_deleted
                transaction_type
                paid_in_full
                snapshot
                dirty
                debit_system_fee
                revision_id
            submit_bound
            word_replace
                {last_nonpay_cancel_date}
                {billing_schedule}
                {past_due}
                {agency}
                {cancellation_date}
                {insured_properties}
                {agent}
                {payoff_amount}
                {print_description}
                {insured}
                {premium}
                {late_payment_fee}
                {cancellation_reason}
                {premium_diff}
                {policy_status}
                {insured_address}
                {policy_type}
                {agency_phone}
                {adjuster}
                {inception_date}
                {expiration_date}
                {reinstatement_date}
                {app_id}
                {agent_phone}
                {todays_date}
                {insured_phone}
                {due_date}
                {last_payment_date}
                {last_payment_amount}
                {last_nonpay_due_date}
                {policy_number}
                {amount_due}
                {claim_number}
                {return_premium_reason}
                {effective_date}
                {mortgagee}
                {nonrenew_reason}
                {portal_code}
            bill_when
            date
            manual_cancellation
            silence_non_pay
            silence_non_pay_renewal
            underwriting_questions
            auto_pay_schedule
                has_installment_fees
                table
                due
                has_custom_fees
            procdate
            payoff_amount
            last_payment
                debit_custom_fee_fully_earned
                date_updated
                waive_id
                debit_custom_fee_fully_billed
                policy_term_id
                id
                debit_premium_fully_billed
                generated_by
                debit_premium_fully_earned
                payment_amount
                day_zero_date
                transaction_date_time
                due_date
                account_balance
                description
                deleted
                debit_custom_fee_pro_rata
                cancel_date
                file_id
                date_added
                back_cancel_date
                payment_id
                debit_premium_pro_rata
                date_added_micro
                date_deleted
                transaction_type
                paid_in_full
                snapshot
                dirty
                debit_system_fee
                revision_id
            story
            reinsurance_contract_id
            billing
                recur
                first
            contacts
                insured
                additional_interests
                agent
            forms
            index_info
                read_only
                sub_type
                received_meta_data
                print_date
                id
                label
                type
                form_ids
                rev_id
            return_prem_reason
            last_page
            num_dec_footer_lines
            report_type
            report_due_date_minus_x
            dec_options
            revision
                separate_dec_sections
                submit_bound
                line_of_business
                app_id
                inception_date
                policy_name
                renewal_status
                exp_date
                renewal_reason
                committed
                policy_type_id
                is_renewal
                location_id
                id
                policy_type_system_tags
                annual_fee
                policy_term_id
                unsubmitted_policy_change
                commission_rate
                dec_description
                written_fee
                eff_date
                revision_date
                annual_premium
                reinstate
                status
                description
                written_premium
                auto_payment_method_id
                line_id
                cancel_date
                has_write_off
                active
                status_reason
                properties
                first_payment_method_id
                dec_display_options
                items
                policy_number
                policy_term
                commit_date
                revision_state
                underwriting_contact_date
                line_system_tags
                underwriting_contacted
                policy_id
                term_premium_factor
            separate_dec_sections
            header_info
                h-line2
                h-line3
                h-line1
                h-line4
            account_balance
            first_underpaid_debit_exceeding_threshold
            billing_schedule_installments
            primary_carrier
                address_line2
                address_city
                address_line1
                name
                signature
                phone
                address_state
                logo
                id
                address_zip
            return_prem
            prev_rev_comp
            overwrite_stock
            remarks
            report_settings
                forms_agent
                module
                dec_blurb
                location_id
                id
                print_on_initial_dec
                requires_user_input
                dec_signature
                dec_signature_image
                include_mortgagee
                certified_mail
                forms_addt_int
                built_in_html
                include_agent
                include_insured
                include_primary_insured
                show_fixed_dec_sig
                print_on_renewal_dec
                print_on_non_autopay
                include_addt_int
                overwrite_stock
                forms_insured
                dec_footer
                report_id
                forms_mortgagee
                send_dec
                custom_name
            past_due
            billing_schedule_options
            unpaid_debits_to_date
            report_id
            debit_deltas_to_date
            del_reason
            auto_pay_method
            cancel_on_due_date
            current_page
            flow
            card_list
            last_non_pay
            submit_payment
            has_a_payment_vendor
            display_topmost_name_on_dec

getDeliverableData › Request Body

revision_id

string

date_cursor

string

deliverable_type

string

reason

string

state_id

string

invoice_id

string

return_data

boolean

coverage_forms

string[]

getDeliverableData › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/getDeliverableData

curl --request POST \
  --url /api/v2/deliverables/getDeliverableData \
  --header 'Content-Type: application/json' \
  --data '
{
  "revision_id": "revision_id",
  "date_cursor": "date_cursor",
  "deliverable_type": "deliverable_type",
  "reason": "reason",
  "state_id": "state_id",
  "invoice_id": "invoice_id",
  "return_data": true,
  "coverage_forms": [
    "string"
  ]
}
'

Example Request Body

{
  "revision_id": "revision_id",
  "date_cursor": "date_cursor",
  "deliverable_type": "deliverable_type",
  "reason": "reason",
  "state_id": "state_id",
  "invoice_id": "invoice_id",
  "return_data": true,
  "coverage_forms": [
    "string"
  ]
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

get_all_html_templates

POST

/api/v2/deliverables/get_all_html_templates

Gets a list with all HTML Templates

Code
Parameters
----------

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list of dict
    The data response having the form:
    ::
        [{
            'id': 'Some UUID id',
            'name': 'Declaration',
            'html': '<html><body><h1>{{ policy.policy_number }}</h1></body></html>',
            'use_new_html_render': False
            'use_new_pdf_render': False
            'enabled': False
            'date_created': "2015-01-01 00:00:00",
            'date_updated': "2015-01-01 00:00:00",
        }]

get_all_html_templates › Request Body

Request payload for /api/v2/deliverables/get_all_html_templates

request-get_all_html_templates

get_all_html_templates › Responses

200

Response payload for /api/v2/deliverables/get_all_html_templates

response-get_all_html_templates

object[] · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/deliverables/get_all_html_templates

curl --request POST \
  --url /api/v2/deliverables/get_all_html_templates \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

Example Responses

{
  "data": [
    {
      "id": "id",
      "name": "name",
      "html": "html",
      "use_new_html_render": true,
      "use_new_pdf_render": true,
      "enabled": true,
      "date_created": "2024-08-25T15:00:00Z",
      "date_updated": "2024-08-25T15:00:00Z"
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

get_all_static_resources

POST

/api/v2/deliverables/get_all_static_resources

Gets a list with all static resources

Code
Parameters
----------

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list of dict
    The data response having the form:
    ::
        [{
            'id': 'Some UUID id',
            # Name of static resource. Used to reference in Jinja {{ static_resource('name.png') }}
            'name': 'name.png',
            # The URL used to pull in the cached version of the static resource
            'url': 'http://cdn.someurl.com/name.png',
            # Number of seconds until resource auto-expires and is refreshed,
            'expire_in': 50000,
            'date_created': "2015-01-01 00:00:00",
            'date_updated': "2015-01-01 00:00:00",
        }]

get_all_static_resources › Request Body

get_all_static_resources › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/get_all_static_resources

curl --request POST \
  --url /api/v2/deliverables/get_all_static_resources \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

get_attachment

POST

/api/v2/deliverables/get_attachment

Retrieve attachment by id.

Code
Parameters
----------
file_id : str, required
    attachment id

Returns
-------
success : bool
    True if successful, false if not. False when the content could not be
    read: the id matches no file, or the stored file is unreachable.
messages : list of str
    List of human-readable error messages
data : dict containing attachment

get_attachment › Request Body

file_id

string

get_attachment › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/get_attachment

curl --request POST \
  --url /api/v2/deliverables/get_attachment \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_id": "file_id"
}
'

Example Request Body

{
  "file_id": "file_id"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

get_dec

POST

/api/v2/deliverables/get_dec

retrieves deliverable

Code
Parameters
----------
policy_id : str
    Policy ID (UUID)
revision_id : str
    Revision ID (UUID)
reason : str

Returns
-------
data : dict
    list of base64 encoded files
    ::
        {
            'files': []
        }

get_dec › Request Body

policy_id

string

revision_id

string

reason

string

get_dec › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/get_dec

curl --request POST \
  --url /api/v2/deliverables/get_dec \
  --header 'Content-Type: application/json' \
  --data '
{
  "policy_id": "policy_id",
  "revision_id": "revision_id",
  "reason": "reason"
}
'

Example Request Body

{
  "policy_id": "policy_id",
  "revision_id": "revision_id",
  "reason": "reason"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

get_dynamic_fields

POST

/api/v2/deliverables/get_dynamic_fields

Retrieves custom fields for a template and renders any Jinja templates in their default values.

Code
Parameters
----------
deliverable_template_id : str, required
    The ID of the template to retrieve custom fields for.
reference_id : str, optional
    The reference ID to look for jinja templates configuration in the default values,
    and (for a dropdown field) to resolve live dropdown options against. It should be
    a claimId or revisionId.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list
    List of custom fields for the template. Each custom field is a dictionary with the following keys:
    ::
        [
            {
                "id": "UUID",
                "template_id": "UUID",
                "field_type": "text",
                "field_label": "Field Label",
                "field_key": "field_name",
                "default_value": "Default value"
            },
            {
                "id": "UUID",
                "template_id": "UUID",
                "field_type": "dropdown",
                "field_label": "Vehicle",
                "field_key": "selected_vehicle",
                "default_value": None,
                "option_source": "dynamic",
                "options": None,
                "source_key": "vehicles",
                "display_field": "name",
                "resolved_options": [{"value": "<vehicle id>", "label": "2021 Honda Accord"}]
            },
            ...
        ]

get_dynamic_fields › Request Body

Request payload for /api/v2/deliverables/get_dynamic_fields

request-get_dynamic_fields

deliverable_template_id

string · required

id of the template (x_report_location.id) that has the dynamic_field.

reference_id

string | null

Optional claim or revision ID. Used to render Jinja templates in default values and, for a dropdown field, to resolve live options (static list directly, dynamic against this entity's context).

get_dynamic_fields › Responses

200

Response schema for /api/v2/deliverables/get_dynamic_fields

response-get_dynamic_fields

object[] · required

array of dynamic fields objects.

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/deliverables/get_dynamic_fields

curl --request POST \
  --url /api/v2/deliverables/get_dynamic_fields \
  --header 'Content-Type: application/json' \
  --data '
{
  "deliverable_template_id": "deliverable_template_id",
  "reference_id": "reference_id"
}
'

Example Request Body

{
  "deliverable_template_id": "deliverable_template_id",
  "reference_id": "reference_id"
}

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "template_id": "00000000-0000-0000-0000-000000000000",
      "field_type": "field_type",
      "field_key": "field_key",
      "default_value": "default_value",
      "option_source": "option_source",
      "options": [
        "string"
      ],
      "source_key": "source_key",
      "display_field": "display_field",
      "resolved_options": [
        {
          "value": "value",
          "label": "label"
        }
      ]
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

get_edeliverables

POST

/api/v2/deliverables/get_edeliverables

Returns e-deliverable documents that have not yet been sent. Candidacy criteria is having:

Code
- settings > deliverable > specific deliverable > This document may be eDelivered to insureds via BriteApps
- print_state === 'tbd'
- print_date between date_from and date_to
- if unprocessed_only==True then only 'unprocessed' returned; if unprocessed_only==False all states returned

Parameters
----------
date_from : str, required
    from "print_date"(inclusive). Format is mm/dd/yyyy
date_to : str, required
    to "print_date"(inclusive). Format is mm/dd/yyyy
unprocessed_only : bool, optional
    return only unprocessed e-deliverable documents. Defaults to True

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list of dict
    List of deliverables that meet search criteria and can be e-delivered
    ::
        [
            {
                "print_date": "2019-07-01",
                "state": "unprocessed",
                "meta_data": {
                    "policy_term": {
                        "effective_date": "2018-08-19",
                        "expiration_date": "2019-08-19",
                        "id": "2bb7e400-d31c-4612-89fa-dc8d2d8c16a1"
                    },
                    "contact": {
                        "addresses": [
                            {
                                "address_line2": "",
                                "address_city": "Ardmore",
                                "address_line1": "2222 N Mdw DR",
                                "type_label": "",
                                "date_updated": null,
                                "address_country": "USA",
                                "address_county": "Carter",
                                "contact_id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080",
                                "longitude": null,
                                "attention": "",
                                "address_state": "OK",
                                "latitude": null,
                                "type": "Mailing/Billing",
                                "id": "e3ca04ca-d7e9-4319-b151-b71c2ee99da8",
                                "address_zip": "73401"
                            }
                        ],
                        "id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080",
                        "phones": [
                            {
                                "date_updated": null,
                                "phone": "(111) 221-7526",
                                "type": "Home",
                                "id": "05b103d9-9400-41fd-b459-28303ac29564",
                                "contact_id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080"
                            }
                        ],
                        "email_notices": false,
                        "emails": [],
                        "name": "JANET BROWN"
                    },
                    "named_insureds": [
                        {
                            "addresses": [
                                {
                                    "address_line2": "",
                                    "address_city": "Ardmore",
                                    "address_line1": "2222 N Mdw DR",
                                    "type_label": "",
                                    "date_updated": null,
                                    "address_country": "USA",
                                    "address_county": "Carter",
                                    "contact_id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080",
                                    "longitude": null,
                                    "attention": "",
                                    "address_state": "OK",
                                    "latitude": null,
                                    "type": "Mailing/Billing",
                                    "id": "e3ca04ca-d7e9-4319-b151-b71c2ee99da8",
                                    "address_zip": "73401"
                                }
                            ],
                            "id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080",
                            "phones": [
                                {
                                    "date_updated": null,
                                    "phone": "(111) 221-7526",
                                    "type": "Home",
                                    "id": "05b103d9-9400-41fd-b459-28303ac29564",
                                    "contact_id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080"
                                }
                            ],
                            "email_notices": false,
                            "emails": [],
                            "name": "JANE DOE"
                        },
                        {
                            "addresses": [
                                {
                                    "address_line2": "",
                                    "address_city": "Ardmore",
                                    "address_line1": "2222 N MDW DR",
                                    "type_label": "",
                                    "date_updated": null,
                                    "address_country": "USA",
                                    "address_county": "Carter",
                                    "contact_id": "ab3c07a5-1b08-4c87-b32d-f0d93841f0c9",
                                    "longitude": null,
                                    "attention": "",
                                    "address_state": "OK",
                                    "latitude": null,
                                    "type": "Mailing/Billing",
                                    "id": "1cf47ef8-7163-45c5-925b-c4d6e871f83e",
                                    "address_zip": "73401"
                                }
                            ],
                            "id": "ab3c07a5-1b08-4c87-b32d-f0d93841f0c9",
                            "phones": [
                                {
                                    "date_updated": null,
                                    "phone": "(111) 221-7526",
                                    "type": "Home",
                                    "id": "7ca45a3f-988b-48ed-a875-7476034485fd",
                                    "contact_id": "ab3c07a5-1b08-4c87-b32d-f0d93841f0c9"
                                }
                            ],
                            "email_notices": false,
                            "emails": [],
                            "name": "JOHN DOE"
                        }
                    ],
                    "file": {
                        "print_state": "tbd",
                        "title": "06-29-2019 - Installment Billing Statement - JANET BROWN",
                        "date_added": "2019-02-04 15:17:04",
                        "id": "dda9c813-8fbc-4e44-87b7-61278e1eca28",
                        "print_date": "2019-07-01",
                        "label": "Installment Billing Statement"
                    },
                    "policy": {
                        "id": "a26935eb-7466-46af-a656-ccac17388f40",
                        "policy_number": "10-2011-120"
                    },
                    "type": "document",
                    "deliverable_type": {
                        "custom_name": null
                    },
                    "revision": {
                        "revision_date": "2018-08-19",
                        "id": "0c64929f-f8b6-4617-8b25-911aa14faaa7",
                        "policy_status": "Active",
                        "revision_state": "committed"
                    }
                },
                "file_id": "dda9c813-8fbc-4e44-87b7-61278e1eca28",
                "exclude_from_printing_queue": false,
                "edelivery_state": "FAILED",
                "date_added": "2019-05-24 08:39:30",
                "x_file_id": null,
                "id": "014386b3-d74c-4925-8d2c-f744ec5892e3"
            }
        ]

get_edeliverables › Request Body

date_from

string

date_to

string

unprocessed_only

boolean

get_edeliverables › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/get_edeliverables

curl --request POST \
  --url /api/v2/deliverables/get_edeliverables \
  --header 'Content-Type: application/json' \
  --data '
{
  "date_from": "date_from",
  "date_to": "date_to",
  "unprocessed_only": true
}
'

Example Request Body

{
  "date_from": "date_from",
  "date_to": "date_to",
  "unprocessed_only": true
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

get_edeliverables_by_id

POST

/api/v2/deliverables/get_edeliverables_by_id

Returns e-deliverable documents by ids.

Code
Parameters
----------
ids : list, required

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list of dict
    List of deliverables that meet search criteria and can be e-delivered
    ::
        [
            {
                "print_date": "2019-07-01",
                "state": "unprocessed",
                "meta_data": {
                    "policy_term": {
                        "effective_date": "2018-08-19",
                        "expiration_date": "2019-08-19",
                        "id": "2bb7e400-d31c-4612-89fa-dc8d2d8c16a1"
                    },
                    "contact": {
                        "addresses": [
                            {
                                "address_line2": "",
                                "address_city": "Ardmore",
                                "address_line1": "2222 N Mdw DR",
                                "type_label": "",
                                "date_updated": null,
                                "address_country": "USA",
                                "address_county": "Carter",
                                "contact_id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080",
                                "longitude": null,
                                "attention": "",
                                "address_state": "OK",
                                "latitude": null,
                                "type": "Mailing/Billing",
                                "id": "e3ca04ca-d7e9-4319-b151-b71c2ee99da8",
                                "address_zip": "73401"
                            }
                        ],
                        "id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080",
                        "phones": [
                            {
                                "date_updated": null,
                                "phone": "(111) 221-7526",
                                "type": "Home",
                                "id": "05b103d9-9400-41fd-b459-28303ac29564",
                                "contact_id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080"
                            }
                        ],
                        "email_notices": false,
                        "emails": [],
                        "name": "JANET BROWN"
                    },
                    "named_insureds": [
                        {
                            "addresses": [
                                {
                                    "address_line2": "",
                                    "address_city": "Ardmore",
                                    "address_line1": "2222 N Mdw DR",
                                    "type_label": "",
                                    "date_updated": null,
                                    "address_country": "USA",
                                    "address_county": "Carter",
                                    "contact_id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080",
                                    "longitude": null,
                                    "attention": "",
                                    "address_state": "OK",
                                    "latitude": null,
                                    "type": "Mailing/Billing",
                                    "id": "e3ca04ca-d7e9-4319-b151-b71c2ee99da8",
                                    "address_zip": "73401"
                                }
                            ],
                            "id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080",
                            "phones": [
                                {
                                    "date_updated": null,
                                    "phone": "(111) 221-7526",
                                    "type": "Home",
                                    "id": "05b103d9-9400-41fd-b459-28303ac29564",
                                    "contact_id": "c1bfa8a0-4eb2-4f7b-b649-baf8e61eb080"
                                }
                            ],
                            "email_notices": false,
                            "emails": [],
                            "name": "JANE DOE"
                        },
                        {
                            "addresses": [
                                {
                                    "address_line2": "",
                                    "address_city": "Ardmore",
                                    "address_line1": "2222 N MDW DR",
                                    "type_label": "",
                                    "date_updated": null,
                                    "address_country": "USA",
                                    "address_county": "Carter",
                                    "contact_id": "ab3c07a5-1b08-4c87-b32d-f0d93841f0c9",
                                    "longitude": null,
                                    "attention": "",
                                    "address_state": "OK",
                                    "latitude": null,
                                    "type": "Mailing/Billing",
                                    "id": "1cf47ef8-7163-45c5-925b-c4d6e871f83e",
                                    "address_zip": "73401"
                                }
                            ],
                            "id": "ab3c07a5-1b08-4c87-b32d-f0d93841f0c9",
                            "phones": [
                                {
                                    "date_updated": null,
                                    "phone": "(111) 221-7526",
                                    "type": "Home",
                                    "id": "7ca45a3f-988b-48ed-a875-7476034485fd",
                                    "contact_id": "ab3c07a5-1b08-4c87-b32d-f0d93841f0c9"
                                }
                            ],
                            "email_notices": false,
                            "emails": [],
                            "name": "JOHN DOE"
                        }
                    ],
                    "file": {
                        "print_state": "tbd",
                        "title": "06-29-2019 - Installment Billing Statement - JANET BROWN",
                        "date_added": "2019-02-04 15:17:04",
                        "id": "dda9c813-8fbc-4e44-87b7-61278e1eca28",
                        "print_date": "2019-07-01",
                        "label": "Installment Billing Statement"
                    },
                    "policy": {
                        "id": "a26935eb-7466-46af-a656-ccac17388f40",
                        "policy_number": "10-2011-120"
                    },
                    "type": "document",
                    "deliverable_type": {
                        "custom_name": null
                    },
                    "revision": {
                        "revision_date": "2018-08-19",
                        "id": "0c64929f-f8b6-4617-8b25-911aa14faaa7",
                        "policy_status": "Active",
                        "revision_state": "committed"
                    }
                },
                "file_id": "dda9c813-8fbc-4e44-87b7-61278e1eca28",
                "exclude_from_printing_queue": false,
                "edelivery_state": "FAILED",
                "date_added": "2019-05-24 08:39:30",
                "x_file_id": null,
                "id": "014386b3-d74c-4925-8d2c-f744ec5892e3"
            }
        ]

get_edeliverables_by_id › Request Body

ids

string[]

get_edeliverables_by_id › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/get_edeliverables_by_id

curl --request POST \
  --url /api/v2/deliverables/get_edeliverables_by_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "string"
  ]
}
'

Example Request Body

{
  "ids": [
    "string"
  ]
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

get_html_template

POST

/api/v2/deliverables/get_html_template

Gets an HTMLTemplate by name

Code
Parameters
----------
name : str
    The name to use when referencing the HTMLTemplate.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            'id': 'Some UUID id',
            'name': 'Declaration',
            'html': '<html><body><h1>{{ policy.policy_number }}</h1></body></html>',
            'use_new_html_render': False
            'use_new_pdf_render': False
            'enabled': False
            'date_created': "2015-01-01 00:00:00",
            'date_updated': "2015-01-01 00:00:00",
        }

get_html_template › Request Body

Request payload for /api/v2/deliverables/get_html_template

request-get_html_template

name

string · required

Name of the template to retrieve.

get_html_template › Responses

200

Response payload for /api/v2/deliverables/get_html_template

response-get_html_template

object · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/deliverables/get_html_template

curl --request POST \
  --url /api/v2/deliverables/get_html_template \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "html": "html",
    "use_new_html_render": true,
    "use_new_pdf_render": true,
    "enabled": true,
    "date_created": "2024-08-25T15:00:00Z",
    "date_updated": "2024-08-25T15:00:00Z"
  },
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

get_pending_email_count

POST

/api/v2/deliverables/get_pending_email_count

Returns the number of pending emails.

Code
Parameters
----------
from_date : date
to_date : date

Returns
-------
data: dict
    The data response having the form:
    ::
        {
            'pending_email_count': the count (int)
        }

get_pending_email_count › Request Body

from_date

string

to_date

string

get_pending_email_count › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/get_pending_email_count

curl --request POST \
  --url /api/v2/deliverables/get_pending_email_count \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_date": "from_date",
  "to_date": "to_date"
}
'

Example Request Body

{
  "from_date": "from_date",
  "to_date": "to_date"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

get_static_resource

POST

/api/v2/deliverables/get_static_resource

Gets a static resource by name

Code
Parameters
----------
name : str
    The name to use when referencing the static resource in your Jinja template. (ex. test.png)

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            'id': 'Some UUID id',
            # Name of static resource. Used to reference in Jinja {{ static_resource('name.png') }},
            'name': 'name.png',
            # The URL used to pull in the cached version of the static resource,
            'url': 'http://cdn.someurl.com/name.png',
            'expire_in': 50000, # Number of seconds until resource auto-expires and is refreshed,
            'date_created': "2015-01-01 00:00:00",
            'date_updated': "2015-01-01 00:00:00",
        }

get_static_resource › Request Body

name

string

get_static_resource › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/get_static_resource

curl --request POST \
  --url /api/v2/deliverables/get_static_resource \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

index_edelivery_records

POST

/api/v2/deliverables/index_edelivery_records

Launch edelivery documents indexing in given date range It is a slow process so it is better to not pass date ranges bigger than week

Code
Parameters
----------
date_from : str, required
    from "print_date"(inclusive). Format is mm/dd/yyyy
date_to : str, required
    to "print_date"(inclusive). Format is mm/dd/yyyy

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    Deleted entities count

index_edelivery_records › Request Body

date_from

string

date_to

string

index_edelivery_records › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/index_edelivery_records

curl --request POST \
  --url /api/v2/deliverables/index_edelivery_records \
  --header 'Content-Type: application/json' \
  --data '
{
  "date_from": "date_from",
  "date_to": "date_to"
}
'

Example Request Body

{
  "date_from": "date_from",
  "date_to": "date_to"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

list_attachments

POST

/api/v2/deliverables/list_attachments

Retrieves attachments list related to any policy/contact/revision combination.

Code
Parameters
----------
policy_id : str
    Filter attachments by policy_id
revision_id : str
    Filter attachments by revision_id
contact_id : str
    Filter attachments by contact_id

print_date_from : date
    Filter attachments younger print_date_from
print_date_to : date
    Filter attachments older print_date_from
print_state_ne : str
    Filter attachments exclude print_state_ne==print_state
print_state : str
    Filter attachments print_state==print_state
order_by : str
    Order by field


Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            'id': 'attachment_id,
            'title': 'attachment_title',
            'label': 'attachment_title',
            'print_date': '11/11/2011,
            'revision_id': 'some_revision_id,
            'policy_id': 'some_policy_id,
        }

list_attachments › Request Body

policy_id

string

revision_id

string

contact_id

string

print_date_from

string

print_date_to

string

print_state_ne

string

print_state

string

order_by

string

list_attachments › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/list_attachments

curl --request POST \
  --url /api/v2/deliverables/list_attachments \
  --header 'Content-Type: application/json' \
  --data '
{
  "policy_id": "policy_id",
  "revision_id": "revision_id",
  "contact_id": "contact_id",
  "print_date_from": "print_date_from",
  "print_date_to": "print_date_to",
  "print_state_ne": "print_state_ne",
  "print_state": "print_state",
  "order_by": "order_by"
}
'

Example Request Body

{
  "policy_id": "policy_id",
  "revision_id": "revision_id",
  "contact_id": "contact_id",
  "print_date_from": "print_date_from",
  "print_date_to": "print_date_to",
  "print_state_ne": "print_state_ne",
  "print_state": "print_state",
  "order_by": "order_by"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

queue_recovery_candidate

POST

/api/v2/deliverables/queue_recovery_candidate

queue_recovery_candidate

queue_recovery_candidate › Request Body

Request payload for /api/v2/deliverables/queue_recovery_candidate

request-queue_recovery_candidate

candidate_id

string · required

Candidate identifier to queue for recovery, e.g. 'file:uuid' or 'folder:uuid'.

queue_recovery_candidate › Responses

200

Response schema for /api/v2/deliverables/queue_recovery_candidate

response-queue_recovery_candidate

object · required

Result of queuing the recovery task.

success

boolean · required

Indicates if the request was successful.

required

POST/api/v2/deliverables/queue_recovery_candidate

curl --request POST \
  --url /api/v2/deliverables/queue_recovery_candidate \
  --header 'Content-Type: application/json' \
  --data '
{
  "candidate_id": "candidate_id"
}
'

Example Request Body

{
  "candidate_id": "candidate_id"
}

Example Responses

{
  "data": {
    "candidate_id": "candidate_id",
    "job_id": "00000000-0000-0000-0000-000000000000",
    "status": "queued",
    "message": "message"
  },
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

regenerate_combined_billing_statements

POST

/api/v2/deliverables/regenerate_combined_billing_statements

Generate any combined billing covers that were sent out on the specified start_date and end_date range If no end_date is supplied, we work with the respective date range (start_date-1, start_date).

regenerate_combined_billing_statements › Request Body

start_date

end_date

group_billing_number

force_generation

regenerate_combined_billing_statements › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/regenerate_combined_billing_statements

curl --request POST \
  --url /api/v2/deliverables/regenerate_combined_billing_statements \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": {},
  "end_date": {},
  "group_billing_number": {},
  "force_generation": {}
}
'

Example Request Body

{
  "start_date": {},
  "end_date": {},
  "group_billing_number": {},
  "force_generation": {}
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

remove_edelivery_records

POST

/api/v2/deliverables/remove_edelivery_records

Removing e-deliverable documents entities in given date range

Code
Parameters
----------
date_from : str, required
    from "print_date"(inclusive). Format is mm/dd/yyyy
date_to : str, required
    to "print_date"(inclusive). Format is mm/dd/yyyy

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict
    Deleted entities count

remove_edelivery_records › Request Body

date_from

string

date_to

string

remove_edelivery_records › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/remove_edelivery_records

curl --request POST \
  --url /api/v2/deliverables/remove_edelivery_records \
  --header 'Content-Type: application/json' \
  --data '
{
  "date_from": "date_from",
  "date_to": "date_to"
}
'

Example Request Body

{
  "date_from": "date_from",
  "date_to": "date_to"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

retrieve_available_document_options

POST

/api/v2/deliverables/retrieve_available_document_options

Finds all document types configured within a given Business Location that can be generated with "standard" parameters. Excludes billing, return premium, and claim acknolwedgement documents. These specific documents require more detailed processing and arguments, and therefore do not fit into this description.

Code
Parameters
----------
location_id : str
    The UUID of the Business Location. May be omitted if `location_abbr` or `location_name` is provided.
location_abbr : str
    The abbreviation of the Business Location. May be omitted if `location_id` or `location_name` is provided.
location_name : str
    The full name of the Business Location. May be omitted if `location_id` or `location_abbr` is provided.
module : str
    The related module that the documents are intended for. Valid options are "policies" or "claims".
    Defaults to "policies".

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list
    The data response having the form:
    ::
        [
            "Declaration",
            "Policy Application",
            "Quote Summary"
        ]

retrieve_available_document_options › Request Body

location_id

string

location_abbr

string

location_name

string

module

string

retrieve_available_document_options › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/retrieve_available_document_options

curl --request POST \
  --url /api/v2/deliverables/retrieve_available_document_options \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_id": "location_id",
  "location_abbr": "location_abbr",
  "location_name": "location_name",
  "module": "module"
}
'

Example Request Body

{
  "location_id": "location_id",
  "location_abbr": "location_abbr",
  "location_name": "location_name",
  "module": "module"
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

retrieve_files_for_entity

POST

/api/v2/deliverables/retrieve_files_for_entity

Finds all active files for a specific entity, given a reference point. Optionally can retrieve files with a NULL reference object as well (example, Report files). Additional filters can also be applied if desired.

Code
Parameters
----------
reference_id : str
    The UUID of the object reference to which the files are associated.
    If intentionally omitted, `allow_null_reference` is expected,
        or `policy_number`/`claim_number` should be provided.
policy_number : str
    The policy number, if `reference_id` is unknown but the files are tied to a policy.
claim_number : str
    The claim number, if `reference_id` is unknown but the files are tied to a claim.
allow_null_reference : bool
    If the queried files are not tied to a specific entity, pass as True (defaults to False).
    Example: Report result files do not currently have `reference_id` to any given entity.
ascending : bool
    By default, the resulting list will be ordered by `dateAdded`-descending for most recently created first.
    Pass this in as True to show oldest first.
advanced_filters : list
    A list of specific dictionaries that expands filtering to a :makevar:`File` by giving
        explicit comparison operators.
    Must have three keys in the dict to accomplish successful filtering and failing to pass any of
    them will result in the given filter being ignored.
    They are :kbd:`column`, :kbd:`operator`, :kbd:`value`

    :column: The column's value in a File table.
    :operator: The comparison operator, have a look at python's built in
               `operator <https://docs.python.org/2/library/operator.html>`_ package
               The only allowed operators are :kbd:`lt le eq ne ge gt`
    :value: The value being compared to.
    Below is an example of how an advanced filter dictionary looks like:
    ::
        {
            "column": "label",
            "operator": "ne",
            "value": "Form"
        }
Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list
    The data response having the form:
    ::
        [
            {
                "id": "UUID",
                "title": "Declaration - John Smith",
                "label": "Declaration",
                "date_added": "2018-01-01 12:00:00",
                "print_state": "printed",
                "print_date": "2018-02-01",
                "actual_print_date": "2018-02-02",
                "folder_id": "UUID",
                "mime_type": "application/pdf",
                "size": 4096,
                "type": "policies",
                "sub_type": "New Policy"
            }
        ]

retrieve_files_for_entity › Request Body

reference_id

string

policy_number

string

claim_number

string

allow_null_reference

boolean

ascending

boolean

advanced_filters

string[]

Returns

string

-------

string

success

boolean

messages

string[]

data

string[]

retrieve_files_for_entity › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/retrieve_files_for_entity

curl --request POST \
  --url /api/v2/deliverables/retrieve_files_for_entity \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference_id": "reference_id",
  "policy_number": "policy_number",
  "claim_number": "claim_number",
  "allow_null_reference": true,
  "ascending": true,
  "advanced_filters": [
    "string"
  ],
  "Returns": "Returns",
  "-------": "-------",
  "success": true,
  "messages": [
    "string"
  ],
  "data": [
    "string"
  ]
}
'

Example Request Body

{
  "reference_id": "reference_id",
  "policy_number": "policy_number",
  "claim_number": "claim_number",
  "allow_null_reference": true,
  "ascending": true,
  "advanced_filters": [
    "string"
  ],
  "Returns": "Returns",
  "-------": "-------",
  "success": true,
  "messages": [
    "string"
  ],
  "data": [
    "string"
  ]
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

retrieve_invoice_document

POST

/api/v2/deliverables/retrieve_invoice_document

Handles retrieving latest active invoice PDF in base64.

Code
Parameters
----------
invoice_number : str
    `0000a461-1722-4111-8b82-b0cc286306db`
primary_insured : bool
    True if doc returned should be for primary insured.
    - False to just returns latest document generated. For cases where there are multiple
      insureds, the output result (PDF recipient) may not be consistant

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human-readable error messages
data : dict
    Representation of dict result:
    ::
        {
            'success': true,
            'messages': [],
            'content': "the pdf encoded in base64 format",
            'headers': {
                'Content-Length': 9983,
                'Content-type': "application/pdf",
                'Content-Disposition':
                    "inline; filename="09-21-2018 - Installment Billing Statement - Georgie Man.pdf""
            },
            'content_type': "application/pdf"
        }

retrieve_invoice_document › Request Body

invoice_number

string

primary_insured

boolean

retrieve_invoice_document › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/retrieve_invoice_document

curl --request POST \
  --url /api/v2/deliverables/retrieve_invoice_document \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoice_number": "invoice_number",
  "primary_insured": true
}
'

Example Request Body

{
  "invoice_number": "invoice_number",
  "primary_insured": true
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

retrieve_recovery_statuses

POST

/api/v2/deliverables/retrieve_recovery_statuses

retrieve_recovery_statuses

retrieve_recovery_statuses › Request Body

Request payload for /api/v2/deliverables/retrieve_recovery_statuses

request-retrieve_recovery_statuses

job_ids

string[] · required

List of BackgroundJob IDs to retrieve recovery status for.

retrieve_recovery_statuses › Responses

200

Response schema for /api/v2/deliverables/retrieve_recovery_statuses

response-retrieve_recovery_statuses

object[] · required

Status of each requested recovery job.

success

boolean · required

Indicates if the request was successful.

required

POST/api/v2/deliverables/retrieve_recovery_statuses

curl --request POST \
  --url /api/v2/deliverables/retrieve_recovery_statuses \
  --header 'Content-Type: application/json' \
  --data '
{
  "job_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
'

Example Request Body

{
  "job_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Example Responses

{
  "data": [
    {
      "job_id": "00000000-0000-0000-0000-000000000000",
      "candidate_id": "candidate_id",
      "status": "detected",
      "replacement_file_id": "00000000-0000-0000-0000-000000000000",
      "message": "message"
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

save_html_template

POST

/api/v2/deliverables/save_html_template

Saves an HTMLTemplate record to be used as a BriteCore Document Jinja template.

Code
Args:
    name (str): Template name matching the custom_deliverable name
    html (str): HTML string (Jinja template) for rendering
    use_new_html_render (bool): Use new render.py for Jinja template rendering
    use_new_pdf_render (bool): Use new render.py for PDF rendering
    enabled (bool): Whether template is enabled
    show_as_custom_deliverable (bool): Show as custom deliverable option

Returns:
    dict: Response with format:
        {
            'success': bool,
            'messages': list,
            'data': {
                'id': uuid,
                'name': str,
                'html': str,
                'description': str,
                'preview_object': str,
                'use_new_html_render': bool,
                'use_new_pdf_render': bool,
                'enabled': bool,
                'x_report_location_id': uuid,
                'date_created': str,
                'date_updated': str
            }
        }

save_html_template › Request Body

Request payload for /api/v2/deliverables/save_html_template

request-save_html_template

name

string · required

The name to use when referencing the template. Globally unique. If a template with the same name already exists, it will be updated.

html

string · required

The HTML string (Jinja template) to be converted into a deliverable.

use_new_html_render

boolean

Whether or not to use the new render.py to render the Jinja template.

Default: false

use_new_pdf_render

boolean

Whether or not to use the new render.py to render the PDF deliverable.

Default: true

enabled

boolean

Whether the template is enabled or not.

Default: false

show_as_custom_deliverable

boolean

Whether the template should be shown as a custom deliverable in the UI.

Default: false

save_html_template › Responses

200

Response payload for /api/v2/deliverables/save_html_template

response-save_html_template

object · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/deliverables/save_html_template

curl --request POST \
  --url /api/v2/deliverables/save_html_template \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "html": "html",
  "use_new_html_render": false,
  "use_new_pdf_render": true,
  "enabled": false,
  "show_as_custom_deliverable": false
}
'

Example Request Body

{
  "name": "name",
  "html": "html",
  "use_new_html_render": false,
  "use_new_pdf_render": true,
  "enabled": false,
  "show_as_custom_deliverable": false
}

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "html": "html",
    "description": "description",
    "preview_object": "preview_object",
    "use_new_html_render": true,
    "use_new_pdf_render": true,
    "show_as_custom_deliverable": true,
    "enabled": true,
    "x_report_location_id": "x_report_location_id",
    "date_created": "2024-08-25T15:00:00Z",
    "date_updated": "2024-08-25T15:00:00Z"
  },
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

save_static_resource

POST

/api/v2/deliverables/save_static_resource

Saves a static resource to be used in BriteCore Document Jinja templates.

Code
Parameters
----------
name : str
    The name to use when referencing the static resource in your Jinja template. (ex. test.png)
url : str
    The URL of the static resource. This URL must be present at the time of the fetch. Using a CDN is recommended.
expire_in : int
    Number of seconds before the cached version of the resource is expired.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            'id': 'Some UUID id',
            # Name of static resource. Used to reference in Jinja {{ static_resource('name.png') }},
            'name': 'name.png',
            # The URL used to pull in the cached version of the static resource
            'url': 'http://cdn.someurl.com/name.png',
            'expire_in': 50000, # Number of seconds until resource auto-expires and is refreshed,
            'date_created': "2015-01-01 00:00:00",
            'date_updated': "2015-01-01 00:00:00",
        }

save_static_resource › Request Body

name

string

url

string

expire_in

integer

save_static_resource › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/save_static_resource

curl --request POST \
  --url /api/v2/deliverables/save_static_resource \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "url": "url",
  "expire_in": 0
}
'

Example Request Body

{
  "name": "name",
  "url": "url",
  "expire_in": 0
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

search_recovery_candidates

POST

/api/v2/deliverables/search_recovery_candidates

search_recovery_candidates

search_recovery_candidates › Request Body

Request payload for /api/v2/deliverables/search_recovery_candidates

request-search_recovery_candidates

start_date

string · date · required

Start of the print-date range to scan for broken deliverables.

end_date

string · date · required

End of the print-date range to scan for broken deliverables.

include_empty_s3_file_content

boolean · required

Include files whose S3 object has zero bytes.

include_zero_sized_file_record

boolean · required

Include files whose DB size field is 0.

include_mismatched_size_record

boolean · required

Include files where the DB size does not match the S3 content length.

include_empty_folder

boolean · required

Include deliverable folders that contain no child files.

search_recovery_candidates › Responses

200

Response schema for /api/v2/deliverables/search_recovery_candidates

response-search_recovery_candidates

object[] · required

List of broken deliverable candidates matching the search filters.

success

boolean · required

Indicates if the request was successful.

required

POST/api/v2/deliverables/search_recovery_candidates

curl --request POST \
  --url /api/v2/deliverables/search_recovery_candidates \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": "2024-08-25",
  "end_date": "2024-08-25",
  "include_empty_s3_file_content": true,
  "include_zero_sized_file_record": true,
  "include_mismatched_size_record": true,
  "include_empty_folder": true
}
'

Example Request Body

{
  "start_date": "2024-08-25",
  "end_date": "2024-08-25",
  "include_empty_s3_file_content": true,
  "include_zero_sized_file_record": true,
  "include_mismatched_size_record": true,
  "include_empty_folder": true
}

Example Responses

{
  "data": [
    {
      "candidate_id": "candidate_id",
      "candidate_type": "file",
      "original_file_id": "00000000-0000-0000-0000-000000000000",
      "original_folder_id": "00000000-0000-0000-0000-000000000000",
      "reference_id": "00000000-0000-0000-0000-000000000000",
      "reference_type": "reference_type",
      "revision_id": "00000000-0000-0000-0000-000000000000",
      "display_reference": "display_reference",
      "label": "label",
      "title": "title",
      "print_date": "2024-08-25",
      "actual_print_date": "2024-08-25",
      "sub_type": "sub_type",
      "failure_reasons": [
        "empty_s3_file_content"
      ],
      "status": "detected",
      "message": "message",
      "background_job_id": "00000000-0000-0000-0000-000000000000",
      "db_size": 0,
      "s3_content_length": 0
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

set_html_templates_locations

POST

/api/v2/deliverables/set_html_templates_locations

Set the mapping between the html templates and the locations they are used in. Parameters ---------- templates_locations_mapping : dict { "templates": [{ "id": "template_id", "name": "template_name", "location_ids": ["location1", "location2", ...], }, ... ] } Returns ------- success : bool True if successful, False if not messages : list of str List of human-readable error messages

set_html_templates_locations › Request Body

Request schema for /api/v2/deliverables/set_html_templates_locations

request-set_html_templates_locations

object · required

success

boolean · required

Indicates if the request was successful

required

set_html_templates_locations › Responses

200

Response schema for /api/v2/deliverables/set_html_templates_locations

response-set_html_templates_locations

object · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/deliverables/set_html_templates_locations

curl --request POST \
  --url /api/v2/deliverables/set_html_templates_locations \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "templates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "location_ids": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    ]
  },
  "success": true,
  "messages": [
    "string"
  ]
}
'

Example Request Body

{
  "data": {
    "templates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "location_ids": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    ]
  },
  "success": true,
  "messages": [
    "string"
  ]
}

Example Responses

{
  "data": {
    "templates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "location_ids": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    ]
  },
  "success": true,
  "messages": [
    "string"
  ]
}

application/json

update_edelivery_records

POST

/api/v2/deliverables/update_edelivery_records

Update edelivery_documents

Code
Parameters
----------
records : dict of dicts
    records need to be updated. Format is
    ::
        {
            # UUID of e-deliverable_document entity
            "ef763124-8b7f-4016-ac54-7d07e4adfe70": {
                # desired state. One of unprocessed/pending/processed. Flags internal state of e-delivery
                "state": "pending"
            },
            "ef763124-8b7f-4016-ac54-7d07e4adfe71": {  # UUID of e-deliverable_document entity
                "state": "processed",                  # desired state. One of unprocessed/pending/processed
                # if set to true - document will be excluded from printing queue (except certifieds)
                "exclude_from_printing_queue": True
            },
            "ef763124-8b7f-4016-ac54-7d07e4adfe72": {  # UUID of e-deliverable_document entity
                "state": "processed",                  # desired state. One of unprocessed/pending/processed
                # if set to true - document will be excluded from printing queue (except certifieds)
                "exclude_from_printing_queue": False,
                # reflects state of e-delivery. Required to inform BC users about E-DElivery state of document
                "edelivery_state": "FAILED"
            },
            "ef763124-8b7f-4016-ac54-7d07e4adfe73": {  # UUID of e-deliverable_document entity
                "state": "processed",                  # desired state. One of unprocessed/pending/processed
                # if set to true - document will be excluded from printing queue (except certifieds)
                "exclude_from_printing_queue": False,
                # reflects state of e-delivery. Required to inform BC users about E-DElivery state of document
                "edelivery_state": "NOTIFIED",
                # if set to true - document will be excluded from printing queue (certifieds)
                "exclude_certified_from_printing_queue": False
            }
        }

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict
    Dict with update results (true or false)
    ::
        {
            'ef763124-8b7f-4016-ac54-7d07e4adfe70': True,
            'ef763124-8b7f-4016-ac54-7d07e4adfe71': False
        }

update_edelivery_records › Request Body

records

object

update_edelivery_records › Responses

200

success

boolean

message

string[]

data

object

POST/api/v2/deliverables/update_edelivery_records

curl --request POST \
  --url /api/v2/deliverables/update_edelivery_records \
  --header 'Content-Type: application/json' \
  --data '{
  "records": {}
}'

Example Request Body

{
  "records": {}
}

Example Responses

{
  "success": true,
  "message": [
    "string"
  ],
  "data": {}
}

application/json

custom_ui notes