accounting

export_account_histories

POST

/api/v2/accounting/export_account_histories

Exports account history entries for the given policy term ids.

Code
Parameters
----------
policy_term_ids : list of str
    List of policy term ids for which account history entries are to be exported. Required.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response containing the exported billing summary.
    ::
        {
            "account_histories": [
                {...}
            ]
        }

export_account_histories › Request Body

policy_term_ids

string[]

export_account_histories › Responses

200

success

boolean

message

string[]

data

object

get_accounting_deliverable

POST

/api/v2/accounting/get_accounting_deliverable

Retrieves all values necessary to generate deliverables related to the account history in a policy term.

Code
Parameters
----------
account_history_id : str
    Account history id from which values are to be filtered.
deliverable_date : str
    Process date of the deliverable in the format YYYY-MM-DD

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response containing queried values for the deliverable.

get_accounting_deliverable › Request Body

account_history_id

string

deliverable_date

string

get_accounting_deliverable › Responses

200

success

boolean

message

string[]

data

object

get_invoices

POST

/api/v2/accounting/get_invoices

Retrieves paginated invoices list related to policy

Code
Parameters
----------
policy_id : str
    Filter payments by policy_id
bill_from_date : date
    Filter invoices with bill date > bill_from_date
bill_to_date : date
    Filter invoices with bill date < bill_to_date
due_from_date : date
    Filter invoices with due date > due_from_date
due_to_date : date
    Filter invoices with due date < due_to_date
sorting_order : str
    Ascending/descending order. Choices {'asc', 'desc'}
page_number : int
    Page number,starting from 1
page_size : int
    Page size, must be >0

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:
    ::
        {
            "due_to_date": "06/06/2017",
            "page_number": 1,
            "bill_to_date": null,
            "invoices": [
              {}
            ],
            "sorting_order": "asc",
            "bill_from_date": null,
            "total_pages": 2,
            "due_from_date": null,
            "page_size": 2,
            "policy_id": "f855df19-ff58-4bc8-92e2-93efa35059d7"
        }

get_invoices › Request Body

Request schema for the api/v2/accounting/get_invoices API.

request-get_invoices

policy_id

string · uuid · required

The unique identifier of the policy to retrieve invoices for.

bill_from_date

string · pattern: ^(0[1-9]|1[0-2])\/(0…

Filter for invoices with a bill date on or after this date. Format: MM/DD/YYYY.

bill_to_date

string · pattern: ^(0[1-9]|1[0-2])\/(0…

Filter for invoices with a bill date on or before this date. Format: MM/DD/YYYY.

due_from_date

string · pattern: ^(0[1-9]|1[0-2])\/(0…

Filter for invoices with a due date on or after this date. Format: MM/DD/YYYY.

due_to_date

string · pattern: ^(0[1-9]|1[0-2])\/(0…

Filter for invoices with a due date on or before this date. Format: MM/DD/YYYY.

sorting_order

string · enum

The sorting order for the invoices, based on their date.

Enum values:

asc

desc

Default: asc

page_number

integer · min: 1

The page number of the result set to retrieve.

Default: 1

page_size

integer · min: 1

The number of invoices to return per page.

Default: 50

get_invoices › Responses

200

Response schema for the api/v2/accounting/get_invoices API.

response-get_invoices

success

boolean · required

Indicates if the API call was successful.

messages

string[] · required

A list of messages, usually empty on success or containing errors on failure.

object · required

POST/api/v2/accounting/get_invoices

curl --request POST \
  --url /api/v2/accounting/get_invoices \
  --header 'Content-Type: application/json' \
  --data '
{
  "policy_id": "00000000-0000-0000-0000-000000000000",
  "bill_from_date": "01/01/2025",
  "bill_to_date": "01/01/2026",
  "due_from_date": "01/01/2025",
  "due_to_date": "01/01/2026",
  "sorting_order": "asc",
  "page_number": 1,
  "page_size": 50
}
'

Example Request Body

{
  "policy_id": "00000000-0000-0000-0000-000000000000",
  "bill_from_date": "01/01/2025",
  "bill_to_date": "01/01/2026",
  "due_from_date": "01/01/2025",
  "due_to_date": "01/01/2026",
  "sorting_order": "asc",
  "page_number": 1,
  "page_size": 50
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "policy_id": "00000000-0000-0000-0000-000000000000",
    "bill_from_date": "01/01/2025",
    "bill_to_date": "01/01/2026",
    "due_from_date": "01/01/2025",
    "due_to_date": "01/01/2026",
    "sorting_order": "asc",
    "page_number": 0,
    "page_size": 0,
    "total_pages": 0,
    "invoices": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "date": "08/29/2025",
        "type": "type",
        "fileKey": "00000000-0000-0000-0000-000000000000",
        "amount": 0,
        "balance": "balance",
        "summary": "summary",
        "icon": "icon",
        "credit": "credit",
        "debit": 0,
        "data": {
          "details": {
            "description": "description",
            "policyStatus": "policyStatus",
            "billDate": "billDate",
            "dueDate": "dueDate",
            "paidInFull": true,
            "invoicePaymentsIds": [
              "00000000-0000-0000-0000-000000000000"
            ],
            "generatedBy": "generatedBy",
            "dateReceived": "dateReceived",
            "dirty": true,
            "showWaive": true,
            "showDelete": true,
            "showEditAndReprint": true,
            "cancelDate": "cancelDate"
          },
          "amount": 0,
          "schedule": {
            "Premium": 0,
            "Custom Fees": 0,
            "Installment Fee": 0
          }
        }
      }
    ]
  }
}

json

application/json

retrieve_outstanding_invoices

POST

/api/v2/accounting/retrieve_outstanding_invoices

Code
Retrieves outstanding invoices, the querying criteria being that the entry in the account_history table
is not paidInFull, transactionDateTime is between transaction_date_time_from and today, and dueDate is not NULL.
You must provide in a transaction_date_time_from.

Parameters
----------
transaction_date_time_from : str, required
    Filter invoices with transaction date > transaction_date_time_from and transaction_date_time < today.
    The date should be in the format YYYY-MM-DD HH:MM:SS

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    Contains the data retrieved from the account_history table or None if none found.
    It has the following form:
    ::
        {
        "outstanding_invoices": [{
            "account_history_id": ,
            "revision_id": ,
            "policy_term_id": ,
            "file_id": ,
            "payment_id": ,
            "waive_id": ,
            "credit_transfer_id": ,
            "debit_transfer_id": ,
            "transaction_date_time": ,
            "transaction_type": ,
            "generated_by": ,
            "description": ,
            "due_date": ,
            "cancel_date": ,
            "day_zero_date": ,
            "back_cancel_date": ,
            "payment_amount": ,
            "debit_premium_fully_billed": ,
            "debit_premium_fully_earned": ,
            "debit_premium_pro_rata": ,
            "debit_custom_fee_fully_billed": ,
            "debit_custom_fee_fully_earned": ,
            "debit_custom_fee_pro_rata": ,
            "debit_system_fee": ,
            "account_balance": ,
            "deleted": ,
            "voided": ,
            "dirty": ,
            "snapshot": ,
            "date_added": ,
            "date_added_micro": ,
            "date_updated": ,
            "date_deleted": ,
            "date_voided": ,
            "cancellation_revision_id": ,
        }

retrieve_outstanding_invoices › Request Body

transaction_date_time_from

string

retrieve_outstanding_invoices › Responses

200

success

boolean

message

string[]

data

object

run_rescind_underwriting_cancellation_pending_logic

POST

/api/v2/accounting/run_rescind_underwriting_cancellation_pending_logic

run_rescind_underwriting_cancellation_pending_logic

run_rescind_underwriting_cancellation_pending_logic › Request Body

revision_id

old_status

date_cursor

run_rescind_underwriting_cancellation_pending_logic › Responses

200

success

boolean

message

string[]

data

object

set_return_premium_to_export

POST

/api/v2/accounting/set_return_premium_to_export

Code
Set a return premium toExport value

set_return_premium_to_export › Request Body

set_return_premium_to_export › Responses

200

success

boolean

message

string[]

data

object

reports additional_interests