Topics on this page

Update exposure reserves, process exposure payouts, and set/submit recovery reserves

BriteClaims comprises different configurable pieces of data. From the first notice of loss (FNOL) to final payment and settlement, an insurer can choose which pieces of data they want to collect at different points in the claims process.

The BriteClaims Financial Modal is the backbone of the claims system, tying coverages coming from BriteLines and BritePolicies to reserve and transaction codes that make up claim and exposure accounting details. BriteClaims’s primary job is to manage the restoration or compensation of claimants for their losses/injuries by making payments within the limits and parameters of their policy.

To set up the claims system for use, tables must be configured that associate an insurer to their lines of business (for example, personal auto, home, farm, commercial auto), coverages, reserve categories, and transaction codes/payment categories.

Once an FNOL is submitted, you can add coverages. Coverages come from the policy and are used to cover, or transfer, the risk of loss/injury of the insured to the insurance company. Therefore, coverage refers to the amount an insurer is willing to pay claimants for a loss/injury for specific perils or causes of the claim. When you add coverage to an exposure on a claim for a loss, you’re selecting from the policy the covered risk or liability that the claim is being filed against.

An exposure is the combination of a claimant (first- or third-party claimant), risk (loss or injury), and coverage (from the policy being claimed against) that will govern the financial limits of the exposure. The exposure is the connecting point between the policy coverage and the claims accounting configuration of the BriteClaims Financial Modal.

Each line of business and risk type will have coverages associated with them. Each coverage can have a unique combination of reserve categories and associated transaction codes. Reserves are monetary amounts or budgets set aside from which payments are made on the claim. When they are entered, they are essentially an estimate of what the claim will cost. It’s important that adjusters set reserves as accurately as possible. Reserves are considered a liability for the insurance carrier and factor into the company’s financial obligations even if not yet used. No claim payment can be made unless there are sufficient reserves to back the transaction. When payments are made, they will erode the reserve. Reserves can’t be below $0.00

BriteClaims also tracks recovery reserves (expected recoveries) and recoveries (received). A recovery receipt is a monetary amount that is received and applied back to the claim file, reducing the amount of the loss. Some of the reasons a claim adjuster may pursue and manage recoveries may include overpayment, salvaging damaged assets, subrogating against a liable party, recording a recovery from a reinsurer, etc.

The accounting/finance team typically processes the payments in a batch process. This process aggregates payment transactions, validates their eligibility for payment, and can group them by payment method and then submit payments into a batch. This batch data can then be exported for consumption by third-party check issuance systems, EFT/ACH, or other payment methods.

From a business standpoint, processed payments are official financial transactions recorded on the claim. The payment process involves:

  • Supervisor accesses payment processing to view payments that are eligible for processing.
  • Supervisor filters payments based on a variety of data including due date and payment method.
  • Supervisor submits payments into a batch queue.
  • Batched payments can be exported to external system/service for issuance (checks) or remittance (EFT/ACH).
  • Check number, check issued date, and check cleared date can be received back from external systems.

This tutorial will guide you through updating exposure reserves, processing payouts, and setting/submitting recoveries. The following steps will be covered:

  1. Retrieve a list of claims
  2. Retrieve exposures on the claim
  3. Retrieve standard reserve categories
  4. Retrieve the sum of reserve amounts and payment amount for all reserve categories
  5. Retrieve a list of possible payees on the claim
  6. Retrieve the payment methods
  7. Retrieve payment types
  8. Retrieve pay codes, reserve amounts, and other payment information
  9. Submit a payment
  10. Retrieve a list of payments that aren’t processed
  11. Process the payments
  12. Retrieve a list of recovery reserve categories
  13. Retrieve for sum of reserve amounts and recovery amount for all reserve categories
  14. Set recovery reserve
  15. Submit recovery

First, we will cover some key concepts related to claims and the claims status workflow to explain actions are allowed for each claim status.

Key concepts

  • Adjuster: We have two adjuster concepts:
    • Primary adjuster: Responsible for overall claim file
    • Exposure adjuster: Responsible for an exposure on a claim

By default, If the primary adjuster is assigned when an exposure is created, the exposure level adjuster is defaulted to be the same as the primary adjuster. The claims supervisor will then change the exposure level assignment as needed.

  • Adjusting reserve: An estimate of the cost to the claims department to manage a claim. The adjusting reserve makes up a portion of the loss adjustment expenses (LAE) and can include costs such as the fees and expenses of adjusters and settling agents.
  • Claimant: An involved party with an exposure on a claim requesting compensation from the insurance company by virtue of the insured’s insurance policy to repair, restore, or replace property or heal an injury. Claimants can include the insured (first party) or non-insureds (third-party claimants). During FNOL, parties are identified and entered into the system as either involved or non-involved. Once an involved party files a claim, they become a claimant.
    • Involved party: A party that may have been injured or received damage to property as a result of an incident/occurrence. Involved parties are potential claimants. For Personal Auto, involved parties include owners of vehicles or property, drivers and passengers of vehicles, pedestrians. Non-involved parties can include witnesses, etc.
  • Coverage: The name of the specific type of insurance placed on a risk if it’s damaged/injured by certain perils, including the maximum financial benefit to be paid to the claimant to repair/restore, replace, or heal the risk.
  • Coverage limit: The maximum financial amount that the insurer will pay on the coverage based on the policy contract.
  • Exposure: The combination of a claimant, risk, and coverage that has emerged as a result of a claim. An exposure is the level of the claim file where reserves are set based on coverage limits and payments are made against the coverage. Exposure may also be referred to as suffix or feature.
  • Legal reserve: An estimate of the defense and cost containment fees for the claim, which often includes litigation related fees. The legal reserve makes up a portion of the LAE and can include costs such as surveillance expenses and fixed amounts for medical cost containment expenses.
  • Loss/Injury: The details of loss, such as the make and VIN model of a vehicle or the specific injury of a claimant.
  • Loss adjustment expense (LAE): The cost of investigating and adjusting losses. LAEs don’t need to be allocated to a particular claim. If they are allocated to a particular claim, they are called allocated loss adjustment expenses (ALAE); otherwise, they are unallocated loss adjustment expenses (ULAE).
  • Loss reserve: An estimate of the cost of the loss, not yet paid. The loss reserve includes repair costs of the damaged property and medical costs for injuries related to the loss.
  • Payment: The total of the loss payments made to date for a coverage; the sum of all processed payments, identified by financial transaction type and code. The code will be linked to a reserve category.
  • Recovery reserve: The anticipated amount that will be recovered and will offset the amount of the loss. Recoveries can occur due to reinsurance, subrogation, or salvage. It constitutes the sum of all approved recovery reserve transactions, identified by financial transaction type and code.
    • Recovered: The sum of all recovery transactions, identified by financial transaction type and code.
  • Reinsurance recovery: Occurs when a portion of an insurer’s claim losses are recovered from reinsurance companies. Based on the policy, if an insurance company loss retention is up to $1 million, if losses exceed $1 million, any amount over $1 million paid by the insurer is reimbursable by the reinsurance company.
  • Reserve: The available loss reserve amount for this coverage; the sum of all approved reserve transactions minus the payments.
  • Risk: The item listed on the insurance policy for which insurance has been purchased (vehicle, building, house, equipment, business, personal injury). Third-party property or people can also be considered a risk.
  • Status: The state of the exposure file on the claim. Options include New, Open, Closed, and Reopened.
  • Salvage recovery: Occurs when money is recovered from the sale of undamaged parts from a loss. When a loss occurs, it’s possible that not all property is destroyed. For example, if there is a house fire that damages part of the property, but not all of it, the parts that remain undamaged can be sold.
  • Subrogation recovery: Occurs when the insurer recovers costs associated to the loss from a third party. When a loss occurs, there are times when a third party is at fault and has fiduciary responsibility. For example, if a house fire is caused by a faulty toaster, the toaster manufacturer may be at fault and potentially holds fiduciary responsibility.
  • Total incurred: The sum of reserves and payments.
  • Net incurred: The sum of reserves and payments, minus recovered.

Claims status workflow

BriteClaims is highly configurable. Figure 1 illustrates a sampe workflow and Table 1 identifies claims statuses, transitions, and avaialble actions.

Figure 1: Sample workflow showing claim statuses.

 

Table 1: Claim statuses, transitions, and available actions.

Claim StatusDescription and possible actionsPossible transitions
NewWhen a claim is first submitted through the FNOL, it enters investigation. The adjuster has a specific time period based on line of business and jurisdiction to accept or deny the claim. At this point, the financials aren't active. The user can:
• Manage parties.
• Manage vehicles and third-party property damage.
• Add notes.
• Add attachments, including electronic files and document templates.
• Send outbound email messages from the claim file.
New to Open
New to Closed

To change from New to Closed, you must provide a reason. Reasons include:
• Record only
• Void/Opened in error
OpenWhen the adjuster completes the coverage investigation and wants to set up exposures so reserves and payments can be made against the claim, the status is changed from New to Open. When the claim status is Open, the user can:
• Add an exposure to the claim (combining of the claimant, risk/injury, and coverage).
• Set reserves.
• Make a payment against an exposure.
• Manage parties.
• Manage vehicles and third-party property damage.
• Add notes.
• Add attachments, including electronic files and document templates.
• Send outbound messages from the claim file.
Open to Closed

To transition from Open to Closed, you must close all Open exposures. When closing an exposure, the system will prompt the user to select a closed reason of Without Pay or Record Only. A status of Closed With Pay is automatically selected if payments have been made on the claim.
ClosedWhen a claim is closed, there can be no activities against the claim except clearing a check, if relevant.Closed to Reopen

You must provide a Reopen reason. Reasons include:
• Closed by mistake
• Additional payments
ReopenThe only option provided for a claim in Closed status is Reopen. If you reopen a claim, you can take the same actions as for a claim in Open status. However, a client may opt to restrict permissions of certain roles from doing certain actions. For example, the system may be configured to allow a claim assistant to edit the loss date when claim is in Open status, but prevents the claim assistant from doing the same regarding Reopen status.Reopen to Closed

To transition to Reopen to Close, you must close all Open exposures.

Update exposure reserves, process payouts, and set/submit recoveries using BriteClaims APIs

Step 1: Get a security token

You will need to request anID and Secret to use OAuth 2.0.

For more information, refer to How do I get started?

Note: Blocks of code are hidden by default to make the page more navigable. Select View code and Hide code to view or hide these sections as needed.

Step 2: Retrieve list of claims

Use the claims_search endpoint (/claims/search/) to generate an existing set of claims.

Sample request

View code
curl --location --request GET '<client url./api/claims/search/?page=1&page_size=5' \
--header 'Authorization: <enter your access token here'

Sample response

View code
{

"results": [
{
"id": "8f35371c-5cf2-44c0-a65a-3c5cb3196fca",
"number": "C-107-2020",
"status": {
"id": "b78c7fdb-8820-45d4-9bd6-78011e8ee485",
"name": "open",
"label": "Open",
"type": "system",
"meta": {}
},
"reporter_id": "cec5f075-57ee-4de2-9259-d4faebaa4614",
"primary_insured": {
"party_id": "b831e5a1-81a8-4a4e-b72e-f8b7b3683a7f",
"contact": {
"id": "93bc6a59-4932-4752-a3e7-4788365544de",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Joe Insured",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [
{
"id": "7b715784-ddeb-11e9-8a34-2a2ae2dbcce4",
"zip": "12345",
"city": "Schenectady",
"type": "Mailing/Billing",
"line1": "456 Low St",
"line2": "",
"state": "NY",
"county": "Schenectady",
"country": "USA",
"full_address": "Schenectady, NY, 12345"
}
],
"primary_email": {
"id": "c3468365-ed68-4a0c-ba98-b1b800116bd5",
"type": "Home",
"email": "faker89154@gmail.com"
},
"primary_phone": {
"id": "33fea6ef-0220-4545-9c52-4b15dc2d7e65",
"type": "Home",
"phone": "(712) 447-5281"
},
"primary_address": {
"id": "0751608a-abf1-480b-92cc-9895cdad5c16",
"zip": "02210",
"city": "Boston",
"type": "Mailing/Billing",
"line1": "123 High St",
"line2": "",
"state": "MA",
"county": "Suffolk",
"country": "USA",
"full_address": "Boston, MA, 02210"
}
}
},
"primary_adjuster": {
"id": "5b7fadd9-a1c5-4422-887a-45c5ea2aebdd",
"active": true,
"start_date": "2020-08-13T17:52:47.508546Z",
"end_date": null,
"claim_user": {
"id": "22f398c8-a4b8-4bce-a960-ea3546790866",
"name": "Test person",
"username": "test123@britecore.com",
"address": "",
"email": "test123@britecore.com",
"phone": ""
}
},
"complexity": {
"id": "7dbfc881-7a76-4fe8-aee9-d49642171dfe",
"label": "Medium",
"name": "medium"
},
"reported_method": "e25a1352-2958-46c7-b11c-ee39740f401e",
"reported_date": "2020-08-13T17:46:48.776870Z",
"policy_id": "6b99c436-ddfa-4d73-bb77-023e8f118821",
"policy_revision_id": "254f6724-8271-422b-9f2a-48fe4f4b0a1f",
"policy_number": "P-49-2019",
"external_data": {
"policy": {
"data": {
"id": "6b99c436-ddfa-4d73-bb77-023e8f118821",
"number": "P-49-2019"
}
},
"policy_type": {
"data": {
"id": "ce84d72f-5a19-4f40-b8d3-4593df72cfa4",
"name": "PA",
"label": "Personal Auto"
}
},
"policy_revision": {
"data": {
"id": "254f6724-8271-422b-9f2a-48fe4f4b0a1f",
"agent": {
"contact": {
"id": "5bd48c61-9801-4329-afda-2e0ee04fe7cb",
"dbs": null,
"dob": null,
"ssn": null,
"name": "BriteCore Writing Co",
"type": "organization",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": {
"id": "b81845bd-dd81-4f5b-81b5-733bbf16f691",
"type": "Work",
"email": "faker81862@gmail.com"
},
"primary_phone": {
"id": "ed1b2c5d-afa7-4899-a2a6-913f25f567d1",
"type": "Work",
"phone": "(676) 586-0564"
},
"primary_address": {
"id": "1e908f0d-ea26-470e-9d89-7b17349bae20",
"zip": "02145",
"city": "Somerville",
"type": "Mailing/Billing",
"line1": "100 Main St",
"line2": "",
"state": "MA",
"county": "Middlesex",
"country": "USA",
"full_address": "Somerville, MA, 02145"
}
}
},
"risks": [
{
"id": "89ebe775-5c30-476b-b3f4-fc39b6cf1782",
"name": "2012 Ford Edge",
"risks": [],
"fields": {
"vin": "1GNGC26RXXJ407648",
"make": "Ford",
"year": "2012",
"color": "Black",
"model": "Edge",
"license_plate": "AHS 2503",
"license_state": "NY"
},
"coverages": [
{
"id": "5d8b85cc-64d7-4467-9255-a4b02f80fe58",
"name": "private_passenger_auto_medical_expense",
"label": "Medical Expense (Stackable in Virginia up to four vehicles)",
"limits": [
{
"id": "e01ded55-e0b7-46e0-a725-854c5853276d",
"name": "per_occurrence",
"type": "per_occurrence",
"label": "Per occurrence",
"value": 1000
}
],
"policy_risk": {
"id": "89ebe775-5c30-476b-b3f4-fc39b6cf1782",
"name": "2012 Ford Edge",
"fields": {
"vin": "1GNGC26RXXJ407648",
"make": "Ford",
"year": "2012",
"color": "Black",
"model": "Edge",
"license_plate": "AHS 2503",
"license_state": "NY"
},
"parent_risk_id": "912551aa-1bcc-491f-aea2-f911b77d8f31",
"policy_risk_type": {
"id": "d5ef7392-c877-4da5-b0af-cde3f55296f4",
"name": "privatePassengerAutos",
"label": "Privatepassengerautos"
}
},
"deductible_amount": 0
},
{
"id": "c5666939-e945-4d80-9419-c334f7fc274f",
"name": "private_passenger_auto_underinsured_motorist_bodily_injury_coverage",
"label": "Underinsured Motorist Bodily Injury Coverage",
"limits": [
{
"id": "28130f9b-0fd3-44e5-b3f2-42588b58bed9",
"name": "per_occurrence",
"type": "per_occurrence",
"label": "Per occurrence",
"value": 1000
}
],
"policy_risk": {
"id": "89ebe775-5c30-476b-b3f4-fc39b6cf1782",
"name": "2012 Ford Edge",
"fields": {
"vin": "1GNGC26RXXJ407648",
"make": "Ford",
"year": "2012",
"color": "Black",
"model": "Edge",
"license_plate": "AHS 2503",
"license_state": "NY"
},
"parent_risk_id": "912551aa-1bcc-491f-aea2-f911b77d8f31",
"policy_risk_type": {
"id": "d5ef7392-c877-4da5-b0af-cde3f55296f4",
"name": "privatePassengerAutos",
"label": "Privatepassengerautos"
}
},
"deductible_amount": 0
},
{
"id": "e34b6523-a416-4c8a-a039-04bf450a37ac",
"name": "private_passenger_auto_uninsured_motorist_bodily_injury",
"label": "Uninsured Motorist Bodily Injury",
"limits": [
{
"id": "cb2e61ed-57e8-4a40-b7cd-f654c8092fb0",
"name": "per_occurrence",
"type": "per_occurrence",
"label": "Per occurrence",
"value": 1000
}
],
"policy_risk": {
"id": "89ebe775-5c30-476b-b3f4-fc39b6cf1782",
"name": "2012 Ford Edge",
"fields": {
"vin": "1GNGC26RXXJ407648",
"make": "Ford",
"year": "2012",
"color": "Black",
"model": "Edge",
"license_plate": "AHS 2503",
"license_state": "NY"
},
"parent_risk_id": "912551aa-1bcc-491f-aea2-f911b77d8f31",
"policy_risk_type": {
"id": "d5ef7392-c877-4da5-b0af-cde3f55296f4",
"name": "privatePassengerAutos",
"label": "Privatepassengerautos"
}
},
"deductible_amount": 0
},

Step 3: Retrieve a list of exposures on the claim

To retrieve exposures on a claim, use the endpoint claims_exposures_list (/claims/exposures/) and pass the claim id. The possible exposure status on each claim are:

  • Open
  • Closed
  • Void
  • Reopen

You can’t add a reserve or payment to an exposure in Closed or Void status. To get a list of exposures in Open/Reopen status, add the parameter query ?status=open,reopen.

Sample request

View code
curl --location --request GET '/api/claims/02d6fabb-b415-4f2a-bea5-f51ebf11e040/exposures/?status=reopen&status=open%20'

Sample response

View code

{

"count": 2,

"next": null,

"previous": null,

"results": [

{

"id": "2d717d77-f162-41a8-931d-85784aa714a9",

"number": "C-75-2020-E001",

"coverage": {

"id": "d5ce8145-07a7-44ae-9650-5ed495866f0f",

"name": "pip_michigan",

"label": "PIP - Michigan",

"description": null,

"perils": [],

"item": {

"id": "92b502c6-265f-4750-bf62-07296ecf8dc6",

"external_name": "",

"item_type": {

"name": "both",

"label": "Both"

},

"risk_type": null,

"coverage_type": {

"id": "f618051d-ece6-45ab-88b5-24b4566c9197",

"name": "bodily_injury_liability",

"label": "Bodily injury liability"

},

"coverage_group": {

"id": "2a883a5e-72a3-4ec9-8042-6b721cdee171",

"name": "injury",

"label": "Injury"

},

"limits": []

},

"reason_for_manual_coverage": "1",

"is_manual": true,

"limits": [

{

"id": "46840631-ddc4-40c4-aafa-228b28a19330",

"coverage": "d5ce8145-07a7-44ae-9650-5ed495866f0f",

"name": "per_occurrence",

"label": "Per occurrence",

"value": 200000.0,

"type": "per_occurrence"

},

{

"id": "b154551c-6a39-4514-acd2-7e28b840c146",

"coverage": "d5ce8145-07a7-44ae-9650-5ed495866f0f",

"name": "per_person",

"label": "Per person",

"value": 3000.0,

"type": "per_person"

}

],

"deductible_amount": 500.0,

"endorsements": []

},

"coverage_id": "d5ce8145-07a7-44ae-9650-5ed495866f0f",

"claimant": {

"id": "2b692ae4-2a9d-42bb-9224-1552b4d565ca",

"number": "C-75-2020-P01",

"contact": {

"id": "07890f82-a3cb-47e2-8fd1-12df4a920618",

"dba": "",

"dbs": null,

"dob": "1980-02-13 00:00:00",

"ssn": "",

"name": "Mike Gerber",

"type": "individual",

"emails": [],

"phones": [],

"fein_tax": null,

"position": null,

"addresses": [],

"primary_email": {

"id": "9e3bc74f-9339-4e44-92f7-9f347535b097",

"type": "Home",

"email": "mike_gerber19@gmail.com"

},

"primary_phone": {

"id": "ce559dc9-fc91-4b42-ab9c-91926716769b",

"type": "Cell",

"phone": "+13607854434"

},

"primary_address": {

"id": "8ca7fd3e-199e-4b15-9c70-f6e161ebf403",

"zip": "33333",

"city": "Fort Lauderdale",

"type": "Mailing",

"line1": "401 Marlins Way",

"line2": "",

"state": "FL",

"county": "Broward",

"country": "USA"

},

"is_approved_vendor": false

},

"display_number": "P01",

"party_id": "a468d561-0917-4ca9-b40e-e98eee500f67",

"injury_id": "7a949939-81ec-4559-b09b-1b8ea7d22a26"

},

"status": {

"id": "e3491b4a-b75d-11e8-96f8-529269fb1459",

"name": "open",

"label": "Open",

"type": "system",

"meta": {}

},

"adjuster": null,

"adjuster_id": null,

"display_number": "E001",

"accounting": {

"reserve_amount": 0.0,

"payments_amount": 0.0,

"total_incurred_amount": 0,

"recovered_amount": 0,

"net_incurred_amount": 0,

"coverage_limit": "--"

},

"status_change_reason": "",

"risks": [],

"description": null,

"is_injury": true,

"deductible_override_amount": null,

"deductible_override_reason": null,

"folder_id": "c3e28e75-0e8a-448a-bd1e-3b695740fc9c",

"full_deductible_applied": false,

"deductible_applied_transactions_str": "Paid on Transaction(s): ",

"is_deletable": true,

"labels": []

},

{

"id": "fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48",

"number": "C-75-2020-E002",

"coverage": {

"id": "253b5ad8-6ab3-4be6-a1a3-20e17e6525a1",

"name": "private_passenger_auto_bodily_injury_liability",

"label": "Bodily Injury",

"description": null,

"perils": [],

"item": {

"id": "c2512cb0-8be8-44ed-8745-d409a39633c2",

"external_name": "bodily_injury",

"item_type": {

"name": "third",

"label": "3rd Party"

},

"risk_type": {

"id": "86e2d246-293e-412e-acc0-9976e36846a0",

"name": "private_passenger_auto",

"label": "Private Passenger Auto",

"name_template": "{{year}} {{make}} {{model}}",

"sub_name_template": "{{vin}}",

"external_name": "privatePassengerAutos",

"attributes": [

{

"type": "attribute",

"id": "5"

},

{

"type": "attribute",

"id": "6"

},

{

"type": "attribute",

"id": "22"

},

{

"type": "attribute",

"id": "19"

},

{

"type": "attribute",

"id": "20"

},

{

"type": "attribute",

"id": "4"

},

{

"type": "attribute",

"id": "18"

}

],

"damage_type": {

"type": "damage-type",

"id": "d79688d3-5363-46e3-94ce-81ed72628dd7"

},

"risk_type_group": {

"type": "risk-type-group",

"id": "436fd274-ab63-4687-8539-f17c86c0eadf"

}

},

"coverage_type": {

"id": "66abf7b0-cddc-4dce-9dfe-8c7881bc3d75",

"name": "bodily_injury",

"label": "Bodily Injury"

},

"coverage_group": {

"id": "2a883a5e-72a3-4ec9-8042-6b721cdee171",

"name": "injury",

"label": "Injury"

},

"limits": [

{

"id": "14a6ef48-819a-4028-aaec-035579d47303",

"type": "per_occurrence",

"name": "per_occurrence",

"label": "Per occurrence"

}

]

},

"reason_for_manual_coverage": null,

"is_manual": false,

"limits": [

{

"id": "f8f90ecf-0d14-4c3a-8764-2bf467384512",

"coverage": "253b5ad8-6ab3-4be6-a1a3-20e17e6525a1",

"name": "per_occurrence",

"label": "Per occurrence",

"value": 300000.0,

"type": "per_occurrence"

}

],

"deductible_amount": 0.0,

"endorsements": []

},

"coverage_id": "253b5ad8-6ab3-4be6-a1a3-20e17e6525a1",

"claimant": {

"id": "2b692ae4-2a9d-42bb-9224-1552b4d565ca",

"number": "C-75-2020-P01",

"contact": {

"id": "07890f82-a3cb-47e2-8fd1-12df4a920618",

"dba": "",

"dbs": null,

"dob": "1980-02-13 00:00:00",

"ssn": "",

"name": "Mike Gerber",

"type": "individual",

"emails": [],

"phones": [],

"fein_tax": null,

"position": null,

"addresses": [],

"primary_email": {

"id": "9e3bc74f-9339-4e44-92f7-9f347535b097",

"type": "Home",

"email": "mike_gerber19@gmail.com"

},

"primary_phone": {

"id": "ce559dc9-fc91-4b42-ab9c-91926716769b",

"type": "Cell",

"phone": "+13607854434"

},

"primary_address": {

"id": "8ca7fd3e-199e-4b15-9c70-f6e161ebf403",

"zip": "33333",

"city": "Fort Lauderdale",

"type": "Mailing",

"line1": "401 Marlins Way",

"line2": "",

"state": "FL",

"county": "Broward",

"country": "USA"

},

"is_approved_vendor": false

},

"display_number": "P01",

"party_id": "a468d561-0917-4ca9-b40e-e98eee500f67",

"injury_id": "7a949939-81ec-4559-b09b-1b8ea7d22a26"

},

"status": {

"id": "e3491b4a-b75d-11e8-96f8-529269fb1459",

"name": "open",

"label": "Open",

"type": "system",

"meta": {}

},

"adjuster": null,

"adjuster_id": null,

"display_number": "E002",

"accounting": {

"reserve_amount": 1701.0,

"payments_amount": 300.0,

"total_incurred_amount": 0,

"recovered_amount": 0,

"net_incurred_amount": 0,

"coverage_limit": "--"

},

"status_change_reason": "",

"risks": [],

"description": null,

"is_injury": true,

"deductible_override_amount": null,

"deductible_override_reason": null,

"folder_id": "67aa2d3e-208e-4a0b-a580-8adc1cef5b2e",

"full_deductible_applied": false,

"deductible_applied_transactions_str": "Paid on Transaction(s): ",

"is_deletable": false,

"labels": []

}

]

}

Step 4: Retrieve standard reserve categories

To retrieve a list of reserve categories, use claims_exposures_reserve-categories_list (/claims/exposures/{exposure_id}/reserve-categories/), passing the exposure id from step 3.

Sample response

View code
curl --location --request GET '/api/claims/exposures/fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48/reserve-categories/?recovery=false'

Sample response

View code
{

"count": 3,

"next": null,

"previous": null,

"results": [

{

"id": "31761083-b23a-424f-ae43-be6a68812e61",

"name": "bodily_injury",

"label": "Bodily Injury",

"children": [],

"reserve_category_type": {

"id": "80962f03-fa2e-4aeb-8767-7691394f9dc2",

"name": "loss",

"label": "Loss"

},

"pay_codes": [

{

"id": "8cf10c81-e817-4dac-9a39-609ffb63c0d3",

"name": "Bodily Injury",

"label": "Bodily Injury"

}

],

"recovery": false

},

{

"id": "ce3964c4-e3a1-4208-a007-0e13442863a8",

"name": "adjuster",

"label": "Adjuster",

"children": [],

"reserve_category_type": {

"id": "da0299a8-5e1d-4fa2-8306-0188f36c2219",

"name": "expense",

"label": "Expense"

},

"pay_codes": [

{

"id": "c7ac530f-f8bd-4f97-9884-de0f33e04ea6",

"name": "adjuster",

"label": "Adjuster"

},

{

"id": "3970b487-0ebf-4245-9b11-452da1679e0a",

"name": "expert_fee",

"label": "Expert Fee"

},

{

"id": "15c3d355-e0f5-424a-b7be-80216b712ba5",

"name": "other",

"label": "Other"

},

{

"id": "cef8b42e-c902-4f5b-86f8-739c622fb2d5",

"name": "police_fire_report_fees",

"label": "Police-Fire Report Fees"

}

],

"recovery": false

},

{

"id": "c15e205b-273c-4292-8b35-10e40fd3885a",

"name": "legal",

"label": "Legal",

"children": [],

"reserve_category_type": {

"id": "da0299a8-5e1d-4fa2-8306-0188f36c2219",

"name": "expense",

"label": "Expense"

},

"pay_codes": [

{

"id": "95481c38-9334-4fca-bedf-137d4dbca445",

"name": "arbitration_fees",

"label": "Arbitration Fees"

},

{

"id": "52bcfca4-2129-4f0e-a0ad-9ee2d4e7891a",

"name": "attorney_fees",

"label": "Attorney Fees"

},

{

"id": "7996be29-f348-4f4d-94ae-06c217685a56",

"name": "attorney_travel",

"label": "Attorney Travel"

},

{

"id": "20edef51-c04c-4973-893f-cabe2f578389",

"name": "court_reporter",

"label": "Court Reporter"

},

{

"id": "977d259f-b145-4dde-92d2-78b4466eab8f",

"name": "expert_fees",

"label": "Expert Fees"

},

{

"id": "a59e62ef-5e5e-40c1-8e19-afb5c17ca740",

"name": "mediation_fees",

"label": "Mediation Fees"

},

{

"id": "166241ef-31dd-4c1e-a49e-2d8affebb9ed",

"name": "misc_fees",

"label": "Misc. Fees"

},

{

"id": "15c3d355-e0f5-424a-b7be-80216b712ba5",

"name": "other",

"label": "Other"

}

],

"recovery": false

}

]

}

Step 5: Retrieve the sum of reserve amounts and payment amount for all reserve categories

Use the claims_exposures_accounting_summary endpoint (/claims/exposures/{exposure_id}/accounting/summary/) to receive the sum of reserve amounts and payment amount for all reserve categories. Under reserve_categories, you will see the reserve amount and payment amount that is set for each reserve category. exposure_id from step 3 is required.

Sample request

View code
curl --location --request GET '/api/claims/exposures/fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48/accounting/summary/'

Sample response

View code
{

"count": 2,

"next": null,

"previous": null,

"results": [

{

"id": "80962f03-fa2e-4aeb-8767-7691394f9dc2",

"name": "loss",

"label": "Loss",

"reserve_amount": 1000.0,

"payments_amount": 0.0,

"total_incurred_amount": 1000.0,

"total_recovery_amount": 0.0,

"net_incurred_amount": 1000.0,

"coverage_limit": "--",

"reserve_categories": [

{

"id": "31761083-b23a-424f-ae43-be6a68812e61",

"name": "bodily_injury",

"label": "Bodily Injury",

"children": null,

"reserve_category_type": {

"id": "80962f03-fa2e-4aeb-8767-7691394f9dc2",

"name": "loss",

"label": "Loss"

},

"pay_codes": [

{

"id": "8cf10c81-e817-4dac-9a39-609ffb63c0d3",

"name": "Bodily Injury",

"label": "Bodily Injury"

}

],

"reserve_amount": 1000.0,

"payments_amount": 0.0,

"total_incurred_amount": 1000.0,

"net_incurred_amount": 0.0,

"coverage_limit": "--"

}

]

},

{

"id": "da0299a8-5e1d-4fa2-8306-0188f36c2219",

"name": "expense",

"label": "Expense",

"reserve_amount": 700.0,

"payments_amount": 300.0,

"total_incurred_amount": 1000.0,

"total_recovery_amount": 0.0,

"net_incurred_amount": 1000.0,

"coverage_limit": "--",

"reserve_categories": [

{

"id": "ce3964c4-e3a1-4208-a007-0e13442863a8",

"name": "adjuster",

"label": "Adjuster",

"children": null,

"reserve_category_type": {

"id": "da0299a8-5e1d-4fa2-8306-0188f36c2219",

"name": "expense",

"label": "Expense"

},

"pay_codes": [

{

"id": "c7ac530f-f8bd-4f97-9884-de0f33e04ea6",

"name": "adjuster",

"label": "Adjuster"

},

{

"id": "3970b487-0ebf-4245-9b11-452da1679e0a",

"name": "expert_fee",

"label": "Expert Fee"

},

{

"id": "15c3d355-e0f5-424a-b7be-80216b712ba5",

"name": "other",

"label": "Other"

},

{

"id": "cef8b42e-c902-4f5b-86f8-739c622fb2d5",

"name": "police_fire_report_fees",

"label": "Police-Fire Report Fees"

}

],

"reserve_amount": 700.0,

"payments_amount": 300.0,

"total_incurred_amount": 1000.0,

"net_incurred_amount": 0.0,

"coverage_limit": "--"

},

{

"id": "c15e205b-273c-4292-8b35-10e40fd3885a",

"name": "legal",

"label": "Legal",

"children": null,

"reserve_category_type": {

"id": "da0299a8-5e1d-4fa2-8306-0188f36c2219",

"name": "expense",

"label": "Expense"

},

"pay_codes": [

{

"id": "95481c38-9334-4fca-bedf-137d4dbca445",

"name": "arbitration_fees",

"label": "Arbitration Fees"

},

{

"id": "52bcfca4-2129-4f0e-a0ad-9ee2d4e7891a",

"name": "attorney_fees",

"label": "Attorney Fees"

},

{

"id": "7996be29-f348-4f4d-94ae-06c217685a56",

"name": "attorney_travel",

"label": "Attorney Travel"

},

{

"id": "20edef51-c04c-4973-893f-cabe2f578389",

"name": "court_reporter",

"label": "Court Reporter"

},

{

"id": "977d259f-b145-4dde-92d2-78b4466eab8f",

"name": "expert_fees",

"label": "Expert Fees"

},

{

"id": "a59e62ef-5e5e-40c1-8e19-afb5c17ca740",

"name": "mediation_fees",

"label": "Mediation Fees"

},

{

"id": "166241ef-31dd-4c1e-a49e-2d8affebb9ed",

"name": "misc_fees",

"label": "Misc. Fees"

},

{

"id": "15c3d355-e0f5-424a-b7be-80216b712ba5",

"name": "other",

"label": "Other"

}

],

"reserve_amount": 0.0,

"payments_amount": 0.0,

"total_incurred_amount": 0.0,

"net_incurred_amount": 0.0,

"coverage_limit": "--"

}

]

}

]

}

Step 6: Retrieve a list of possible payees on the claim

The claims_exposures_feasible_payees endpoint (/claims/exposures/{exposure_id}/feasible-payees/) to retrieve a list of possible payees on the claim. The exposure_id is a required parameter.

Sample request

View code
curl --location --request GET '/api/claims/exposures/fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48/feasible-payees

Sample response

View code
{

"count": 4,

"next": null,

"previous": null,

"results": [

{

"id": "f687c617-8d10-4f66-a6a3-8bb1cdc30422",

"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",

"contact": {

"id": "5bd48c61-9801-4329-afda-2e0ee04fe7cb",

"dbs": null,

"dob": "",

"dba": "Doing Business As",

"ssn": null,

"name": "BriteCore Writing Co",

"type": "organization",

"fein_tax": null,

"position": null,

"addresses": [

{

"id": "1e908f0d-ea26-470e-9d89-7b17349bae20",

"zip": "02145",

"city": "Somerville",

"type": "Mailing/Billing",

"line1": "100 Main St",

"line2": "",

"state": "MA",

"county": "Middlesex",

"country": "USA"

},

{

"id": "240df6aa-6716-46ed-8429-b5ed0c4ef035",

"zip": "02145",

"city": "Somerville",

"type": "Mailing/Billing",

"line1": "100 Main St",

"line2": "",

"state": "MA",

"county": "Middlesex",

"country": "USA"

},

{

"id": "385b08cb-16e6-43bb-81df-240c813c8ca8",

"zip": "02145",

"city": "Somerville",

"type": "Mailing/Billing",

"line1": "100 Main St",

"line2": "",

"state": "MA",

"county": "Middlesex",

"country": "USA"

},

{

"id": "a32739b0-c3d4-45c7-99b6-ba35bd3dc19a",

"zip": "02145",

"city": "Somerville",

"type": "Mailing/Billing",

"line1": "100 Main St",

"line2": "",

"state": "MA",

"county": "Middlesex",

"country": "USA"

},

{

"id": "d1d7eb56-0887-427e-afa9-340bbb411706",

"zip": "02145",

"city": "Somerville",

"type": "Mailing/Billing",

"line1": "100 Main St",

"line2": "",

"state": "MA",

"county": "Middlesex",

"country": "USA"

}

],

"phones": [

{

"id": "546a8adf-15fa-4d9b-b2b9-80bcd0210c33",

"type": "work",

"phone": "+1676586052222264"

},

{

"id": "55a7ce4f-3475-4740-83e8-0d5e5db7ec5d",

"type": "work",

"phone": "+1676586052222264"

},

{

"id": "7a383046-b8b5-443a-abc5-3ced0d017dcc",

"type": "work",

"phone": "+1676586052222264"

},

{

"id": "c946c85e-6aab-4854-a8f3-e07cb8d4df9b",

"type": "work",

"phone": "+1676586052222264"

},

{

"id": "ed1b2c5d-afa7-4899-a2a6-913f25f567d1",

"type": "Work",

"phone": "+16765860564"

},

{

"id": "719f4764-a200-4379-ad7a-aa04d2ba5764",

"type": "mobile",

"phone": "+1123"

}

],

"emails": [

{

"id": "4280aebc-bc81-4c0d-afe8-8183b7a61302",

"type": "Work",

"email": "faker81862@gmail.com"

},

{

"id": "4af2b220-149a-4403-a376-c41ce575a3ee",

"type": "Work",

"email": "faker81862@gmail.com"

},

{

"id": "4af80261-4d8d-4b1a-ba4e-c645c333841e",

"type": "Work",

"email": "faker81862@gmail.com"

},

{

"id": "b81845bd-dd81-4f5b-81b5-733bbf16f691",

"type": "Work",

"email": "faker81862@gmail.com"

},

{

"id": "f75f7dbf-abeb-48c6-8ffd-b40c030740a8",

"type": "Work",

"email": "faker81862@gmail.com"

}

],

"primary_address": {

"id": "08dd4b60-7dc5-449a-aba3-d233ba84dc74",

"zip": "02145",

"city": "Somerville",

"type": "Mailing/Billing",

"line1": "100 Main St",

"line2": "",

"state": "MA",

"county": "Middlesex",

"country": "USA"

},

"primary_phone": {

"id": "19c1ca6f-65eb-40bb-9ed5-0aebce841898",

"type": "work",

"phone": "+1676586052222264"

},

"primary_email": {

"id": "2b4211be-779d-49c6-99b9-3c268a66f4ae",

"type": "Work",

"email": "faker81862@gmail.com"

},

"is_approved_vendor": false,

"gender": null

},

"related_party_roles": [

{

"id": "423037de-90d0-4573-aba9-62a9562ad78e",

"name": "attorney",

"label": "Attorney",

"priority": 3,

"metadata": {

"pages": "all",

"first_page": "search"

}

},

{

"id": "a42daf2d-0815-4385-a697-af3263570274",

"name": "claimant_attorney",

"label": "Claimant Attorney",

"priority": 4,

"metadata": {

"pages": "all",

"first_page": "search"

}

}

],

"payee_role": {

"order": 2,

"name": "associated_party",

"label": "Associated Parties"

},

"is_approved_vendor": false

},

{

"id": "a468d561-0917-4ca9-b40e-e98eee500f67",

"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",

"contact": {

"id": "07890f82-a3cb-47e2-8fd1-12df4a920618",

"dba": "",

"dbs": null,

"dob": "1980-02-13 00:00:00",

"ssn": "",

"name": "Mike Gerber",

"type": "individual",

"emails": [],

"phones": [],

"fein_tax": null,

"position": null,

"addresses": [],

"primary_email": {

"id": "9e3bc74f-9339-4e44-92f7-9f347535b097",

"type": "Home",

"email": "mike_gerber19@gmail.com"

},

"primary_phone": {

"id": "ce559dc9-fc91-4b42-ab9c-91926716769b",

"type": "Cell",

"phone": "+13607854434"

},

"primary_address": {

"id": "8ca7fd3e-199e-4b15-9c70-f6e161ebf403",

"zip": "33333",

"city": "Fort Lauderdale",

"type": "Mailing",

"line1": "401 Marlins Way",

"line2": "",

"state": "FL",

"county": "Broward",

"country": "USA"

},

"is_approved_vendor": false

},

"related_party_roles": [

{

"id": "a5073f13-8c6a-4702-a146-603ac214e353",

"name": "agent",

"label": "Agent",

"priority": 2,

"metadata": {

"pages": "all",

"first_page": "search"

}

},

{

"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",

"name": "other",

"label": "Other",

"priority": 13,

"metadata": {

"pages": "all",

"first_page": "add"

}

}

],

"payee_role": {

"order": 1,

"name": "claimant",

"label": "Claimant(s)"

},

"is_approved_vendor": false

},

{

"id": "cf8ccbd0-d7f1-4c3a-918b-b3de88f17d12",

"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",

"contact": {

"id": "8ccad944-ab73-4877-b198-8ad57061be49",

"dba": "",

"dbs": null,

"dob": null,

"ssn": "",

"name": "Sarah Hughes",

"type": "individual",

"emails": [],

"phones": [],

"fein_tax": null,

"position": null,

"addresses": [],

"primary_email": {

"id": "c6d8123c-2ec4-4330-a281-52f5e1111ea9",

"type": "Other",

"email": "sarah_hu@hotmail.com"

},

"primary_phone": {

"id": "409d7ab3-899b-4400-bfa2-6568319ca535",

"type": "Cell",

"phone": "+17124475281"

},

"primary_address": {

"id": "b9208776-f7a0-4950-9c63-72fa047ff786",

"zip": "22222",

"city": "Arlington",

"type": "Mailing/Billing",

"line1": "222 Main St",

"line2": "",

"state": "VA",

"county": "Arlington",

"country": "USA"

},

"is_approved_vendor": false

},

"related_party_roles": [

{

"id": "e30155f8-8350-42cd-8b0c-b5a5804aa113",

"name": "medical_professional",

"label": "Medical Professional",

"priority": 8,

"metadata": {

"pages": "all",

"first_page": "search",

"equivalent_claim_party_role": "medical-professional"

}

},

{

"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",

"name": "other",

"label": "Other",

"priority": 13,

"metadata": {

"pages": "all",

"first_page": "add"

}

}

],

"payee_role": {

"order": 3,

"name": "exposure_vendor",

"label": "Exposure Vendors"

},

"is_approved_vendor": false

},

{

"id": "02f352be-348b-4bd0-8d00-975e6ed93bc6",

"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",

"contact": {

"id": "6dafe7a3-f979-4811-b1f3-b7f8329226d6",

"dba": "",

"dbs": null,

"dob": "1996-06-15 00:00:00",

"ssn": "",

"name": "Tommie Dahl",

"type": "individual",

"emails": [],

"phones": [],

"fein_tax": null,

"position": null,

"addresses": [],

"primary_email": null,

"primary_phone": null,

"primary_address": null,

"is_approved_vendor": false

},

"related_party_roles": [

{

"id": "73ca225f-d9b4-4161-8b63-1695838fbee1",

"name": "child",

"label": "Child",

"priority": 5,

"metadata": {

"pages": "all",

"first_page": "add"

}

}

],

"payee_role": {

"order": 3,

"name": "exposure_vendor",

"label": "Exposure Vendors"

},

"is_approved_vendor": false

}

]

}

Step 7: Retrieve payment methods

Use the claims_payments_payment-methods_list endpoint (/claims/payments/payment-methods/) to retrieve a list of payment methods on file.

Sample request

View code
curl --location --request GET '/api/claims/payments/payment-methods/'

Sample response

View code
{
"count": 4,
"next": null,
"previous": null,
"results": [
{
"id": "1cb1eee8-0d27-4308-8aad-8f5dd8946c98",
"name": "eft",
"label": "EFT"
},
{
"id": "93a4d737-519c-46fb-8ace-df16d71fafb7",
"name": "voucher",
"label": "Voucher"
},
{
"id": "8a4d02f1-8072-4648-abf8-078da3cd943f",
"name": "manual-adjustment",
"label": "Manual Adjustment"
},
{
"id": "a6ca284d-098c-48de-a081-13f27eaa822d",
"name": "check",
"label": "Check"
}
]
}
Step 6: Retrieve payment types
The claims_payments_payment-types_list endpoint to retrieve a list of payment types on file.
Sample request
curl --location --request GET '/api/claims/payments/payment-types/'
Sample response
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "a56d4141-086f-4884-9fbe-c0257e4c1926",
"name": "final_payment",
"label": "Final Payment"
},
{
"id": "64bfc956-8116-453a-910c-3915d9863037",
"name": "partial_payment",
"label": "Partial Payment"
}
]
}

Step 8: Retrieve pay codes, reserve amounts, and other payment information

Use the claims_exposures_reserve-categories_read endpoint (/claims/exposures/{exposure_id}/reserve-categories/{reserve_category_id}/) to retrieve pay codes, reserve amounts, and other payment information on a particular category. exposure_id and reserve_category_id are both required.

Sample request

View code
curl --location --request GET ' /api/claims/exposures/fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48/reserve-categories/31761083-b23a-424f-ae43-be6a68812e61/'

Sample response

View code
{

"id": "31761083-b23a-424f-ae43-be6a68812e61",

"name": "bodily_injury",

"label": "Bodily Injury",

"children": [],

"reserve_category_type": {

"id": "80962f03-fa2e-4aeb-8767-7691394f9dc2",

"name": "loss",

"label": "Loss"

},

"pay_codes": [

{

"id": "8cf10c81-e817-4dac-9a39-609ffb63c0d3",

"name": "Bodily Injury",

"label": "Bodily Injury"

}

],

"reserve_amount": 1000.0,

"payments_amount": 0.0,

"recovery_reserve": 0.0,

"recoveries": 0.0

}

Step 9: Submit a payment

The claims_payments_submit endpoint sends a JSON payload with payment information to submit. The request must include the following parameters:

  • exposure_id and reserve_category_id (required)
  • Payees (required)
  • Payment should have at least one payee "payee_type": "primary" but can also have have additional payees (and)
  • alternative payees (or)
    Payee fields:
    • party_id (required) – Get id from Get Possible Payees
    • party_type (required) – options are primary, additional, alternative (just primary is required)
    • location (required for primary) – This is payment address only
    • primary should have address
    • payees_display_on_check_edited (required)
    • Get name of payees and combine them:
      • Mike Gerber (primary)
      • Tommie Dahl (additional)
      • Sarah Hughes (alternative)
  • then payees_display_on_check_edited should be “Mike Gerber and Tommie Dahl or Sarah Hughes”
  • payment_method_id (required) – Get id from Get Payment Methods
  • payment_type_id (required)- Get id from Get Payment Types
  • pay_code_id (required)- Get id from pay_codes -> Get Pay Codes, Reserve Amount, Other Payments
  • amount (required)- Payment Amount
  • due_date (required)
  • in_payment_of (optional)
  • Memo- comments (optional)
  • check informations (optional)

The following fields aren’t required; you may set them as null:

  • Check_number
  • Check_date
  • Cleared_date
  • deductible_amount_before_adjustments and deductible_amount_to_pay

Sample request

View code
curl --location --request POST '/api/claims/payments/submit/' \

--header 'Content-Type: application/json' \

--data-raw '{

"exposure_id": "fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48",

"reserve_category_id": "ce3964c4-e3a1-4208-a007-0e13442863a8",

"payees": [

{

"party_id": "a468d561-0917-4ca9-b40e-e98eee500f67",

"payee_type": "primary",

"location": {

"type": "Mailing",

"zip": "33333",

"city": "Fort Lauderdale",

"line1": "401 Marlins Way",

"line2": "",

"state": "FL",

"county": "Broward",

"country": "USA"

}

},

{

"party_id": "02f352be-348b-4bd0-8d00-975e6ed93bc6",

"payee_type": "additional"

},

{

"party_id": "cf8ccbd0-d7f1-4c3a-918b-b3de88f17d12",

"payee_type": "alternative"

}

],

"payees_display_on_check_edited": "Mike Gerber and Tommie Dahl or Sarah Hughes",

"payment_method_id": "a6ca284d-098c-48de-a081-13f27eaa822d",

"payment_type_id": "a56d4141-086f-4884-9fbe-c0257e4c1926",

"pay_code_id": "c7ac530f-f8bd-4f97-9884-de0f33e04ea6",

"amount": "100",

"due_date": "2020-08-06",

"in_payment_of": "In Payment Of (Memo)",

"comments": "Comments\n",

"check_number": "Check Number",

"check_date": "2020-08-16",

"cleared_date": "2020-08-19",

"deductible_amount_before_adjustments": null,

"deductible_amount_to_pay": null

}'

Sample response

View code
{

"id": "5ae41fc5-8a82-41c7-bf58-8158df908940",

"payment_method_id": "a6ca284d-098c-48de-a081-13f27eaa822d",

"pay_code_id": "c7ac530f-f8bd-4f97-9884-de0f33e04ea6",

"due_date": "2020-08-06",

"payment_type_id": "a56d4141-086f-4884-9fbe-c0257e4c1926",

"payees": [

{

"id": "dcfc288d-526f-41a0-87c7-bb68711a5491",

"party": {

"id": "a468d561-0917-4ca9-b40e-e98eee500f67",

"number": "P01",

"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",

"party_type": {

"id": "12df2a0a-468a-450f-a524-08c6a5c41fc1",

"name": "individual",

"label": "Individual"

},

"contact_id": "07890f82-a3cb-47e2-8fd1-12df4a920618",

"contact": {

"id": "07890f82-a3cb-47e2-8fd1-12df4a920618",

"dba": "",

"dbs": null,

"dob": "1980-02-13 00:00:00",

"ssn": "",

"name": "Mike Gerber",

"type": "individual",

"emails": [],

"phones": [],

"fein_tax": null,

"position": null,

"addresses": [],

"primary_email": {

"id": "9e3bc74f-9339-4e44-92f7-9f347535b097",

"type": "Home",

"email": "mike_gerber19@gmail.com"

},

"primary_phone": {

"id": "ce559dc9-fc91-4b42-ab9c-91926716769b",

"type": "Cell",

"phone": "+13607854434"

},

"primary_address": {

"id": "8ca7fd3e-199e-4b15-9c70-f6e161ebf403",

"zip": "33333",

"city": "Fort Lauderdale",

"type": "Mailing",

"line1": "401 Marlins Way",

"line2": "",

"state": "FL",

"county": "Broward",

"country": "USA"

},

"is_approved_vendor": false

},

"labels": [],

"roles": [

{

"id": "04bc69c5-3270-4031-b55e-53d782aea391",

"name": "owner",

"label": "Owner",

"priority": 1,

"metadata": {

"pages": "all",

"first_page": "search"

}

},

{

"id": "a2a12717-a9dc-4125-a55c-b04362d333af",

"name": "driver",

"label": "Driver",

"priority": 2,

"metadata": {

"pages": "all",

"first_page": "search"

}

},

{

"id": "a5073f13-8c6a-4702-a146-603ac214e353",

"name": "agent",

"label": "Agent",

"priority": 2,

"metadata": {

"pages": "all",

"first_page": "search"

}

},

{

"id": "4f54e18b-947e-488d-b814-bd26b9931306",

"name": "reporter",

"label": "Reporter",

"priority": 4,

"metadata": {

"pages": "all",

"first_page": "search"

}

},

{

"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",

"name": "other",

"label": "Other",

"priority": 13,

"metadata": {

"pages": "all",

"first_page": "add"

}

}

],

"claim_roles": [

{

"id": "4f54e18b-947e-488d-b814-bd26b9931306",

"name": "reporter",

"label": "Reporter"

}

],

"risk_roles": [

{

"id": "04bc69c5-3270-4031-b55e-53d782aea391",

"name": "owner",

"label": "Owner",

"priority": 1,

"metadata": {

"pages": "all",

"first_page": "search"

}

},

{

"id": "a2a12717-a9dc-4125-a55c-b04362d333af",

"name": "driver",

"label": "Driver",

"priority": 2,

"metadata": {

"pages": "all",

"first_page": "search"

}

}

],

"related_party_roles": [

{

"id": "a5073f13-8c6a-4702-a146-603ac214e353",

"name": "agent",

"label": "Agent",

"priority": 2,

"metadata": {

"pages": "all",

"first_page": "search"

}

},

{

"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",

"name": "other",

"label": "Other",

"priority": 13,

"metadata": {

"pages": "all",

"first_page": "add"

}

}

],

"is_involved": true,

"policy_contact": false,

"fields": {

"license_state": "FL",

"drivers_license": "mikegerb*336FR"

},

"preferred_phone_id": null,

"preferred_email_id": null,

"preferred_address_id": null,

"refused_to_provide_dob": false,

"refused_to_provide_ssn": false,

"refused_to_provide_gender": false

},

"party_id": "a468d561-0917-4ca9-b40e-e98eee500f67",

"location": {

"id": "0e30932c-d348-41f9-a4bf-5dbf114c51a1",

"line1": "401 Marlins Way",

"line2": "",

"city": "Fort Lauderdale",

"country": "USA",

"county": "Broward",

"state": "FL",

"zip": "33333",

"latitude": null,

"longitude": null,

"full_address": "401 Marlins Way, Fort Lauderdale, FL, 33333",

"other_details": null,

"type": "Mailing"

},

"payee_type": "primary"

},

{

"id": "337575ca-209d-4f18-a32f-239bff61fd58",

"party": {

"id": "02f352be-348b-4bd0-8d00-975e6ed93bc6",

"number": null,

"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",

"party_type": {

"id": "12df2a0a-468a-450f-a524-08c6a5c41fc1",

"name": "individual",

"label": "Individual"

},

"contact_id": "6dafe7a3-f979-4811-b1f3-b7f8329226d6",

"contact": {

"id": "6dafe7a3-f979-4811-b1f3-b7f8329226d6",

"dba": "",

"dbs": null,

"dob": "1996-06-15 00:00:00",

"ssn": "",

"name": "Tommie Dahl",

"type": "individual",

"emails": [],

"phones": [],

"fein_tax": null,

"position": null,

"addresses": [],

"primary_email": null,

"primary_phone": null,

"primary_address": null,

"is_approved_vendor": false

},

"labels": [],

"roles": [

{

"id": "04bc69c5-3270-4031-b55e-53d782aea391",

"name": "owner",

"label": "Owner",

"priority": 1,

"metadata": {

"pages": "all",

"first_page": "search"

}

},

{

"id": "73ca225f-d9b4-4161-8b63-1695838fbee1",

"name": "child",

"label": "Child",

"priority": 5,

"metadata": {

"pages": "all",

"first_page": "add"

}

}

],

"claim_roles": [],

"risk_roles": [

{

"id": "04bc69c5-3270-4031-b55e-53d782aea391",

"name": "owner",

"label": "Owner",

"priority": 1,

"metadata": {

"pages": "all",

"first_page": "search"

}

}

],

"related_party_roles": [

{

"id": "73ca225f-d9b4-4161-8b63-1695838fbee1",

"name": "child",

"label": "Child",

"priority": 5,

"metadata": {

"pages": "all",

"first_page": "add"

}

}

],

"is_involved": false,

"policy_contact": false,

"fields": {},

"preferred_phone_id": null,

"preferred_email_id": null,

"preferred_address_id": null,

"refused_to_provide_dob": false,

"refused_to_provide_ssn": false,

"refused_to_provide_gender": false

},

"party_id": "02f352be-348b-4bd0-8d00-975e6ed93bc6",

"location": null,

"payee_type": "additional"

},

{

"id": "42ff2cf7-58de-4c04-b31e-c9a30c611d33",

"party": {

"id": "cf8ccbd0-d7f1-4c3a-918b-b3de88f17d12",

"number": null,

"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",

"party_type": {

"id": "12df2a0a-468a-450f-a524-08c6a5c41fc1",

"name": "individual",

"label": "Individual"

},

"contact_id": "8ccad944-ab73-4877-b198-8ad57061be49",

"contact": {

"id": "8ccad944-ab73-4877-b198-8ad57061be49",

"dba": "",

"dbs": null,

"dob": null,

"ssn": "",

"name": "Sarah Hughes",

"type": "individual",

"emails": [],

"phones": [],

"fein_tax": null,

"position": null,

"addresses": [],

"primary_email": {

"id": "c6d8123c-2ec4-4330-a281-52f5e1111ea9",

"type": "Other",

"email": "sarah_hu@hotmail.com"

},

"primary_phone": {

"id": "409d7ab3-899b-4400-bfa2-6568319ca535",

"type": "Cell",

"phone": "+17124475281"

},

"primary_address": {

"id": "b9208776-f7a0-4950-9c63-72fa047ff786",

"zip": "22222",

"city": "Arlington",

"type": "Mailing/Billing",

"line1": "222 Main St",

"line2": "",

"state": "VA",

"county": "Arlington",

"country": "USA"

},

"is_approved_vendor": false

},

"labels": [],

"roles": [

{

"id": "e30155f8-8350-42cd-8b0c-b5a5804aa113",

"name": "medical_professional",

"label": "Medical Professional",

"priority": 8,

"metadata": {

"pages": "all",

"first_page": "search",

"equivalent_claim_party_role": "medical-professional"

}

},

{

"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",

"name": "other",

"label": "Other",

"priority": 13,

"metadata": {

"pages": "all",

"first_page": "add"

}

}

],

"claim_roles": [],

"risk_roles": [],

"related_party_roles": [

{

"id": "e30155f8-8350-42cd-8b0c-b5a5804aa113",

"name": "medical_professional",

"label": "Medical Professional",

"priority": 8,

"metadata": {

"pages": "all",

"first_page": "search",

"equivalent_claim_party_role": "medical-professional"

}

},

{

"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",

"name": "other",

"label": "Other",

"priority": 13,

"metadata": {

"pages": "all",

"first_page": "add"

}

}

],

"is_involved": false,

"policy_contact": false,

"fields": {},

"preferred_phone_id": null,

"preferred_email_id": null,

"preferred_address_id": null,

"refused_to_provide_dob": false,

"refused_to_provide_ssn": false,

"refused_to_provide_gender": false

},

"party_id": "cf8ccbd0-d7f1-4c3a-918b-b3de88f17d12",

"location": null,

"payee_type": "alternative"

}

],

"final_payment": false,

"in_payment_of": "In Payment Of (Memo)",

"from_date": null,

"through_date": null,

"billed_amount": null,

"invoice_number": null,

"invoice_date": null,

"check_number": "Check Number",

"check_date": "2020-08-16",

"cleared_date": "2020-08-19",

"payees_display_on_check_edited": "Mike Gerber and Tommie Dahl or Sarah Hughes",

"payment_id": null,

"deductible_amount_before_adjustments": null,

"deductible_amount_to_pay": null

}

Step 10: Retrieve a list of payments waiting to be processed

The claims_payments_list endpoint (/claims/payments) retrieves a list of payments. Pass the exposure_id to and batch_processed = false as a parameter to get the list of payments waiting to be processed for a particular exposure.

Sample request

View code
curl --location --request GET '/api/claims/payments/?page=1&page_size=25&batch_processed=false&exposure_id=fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48'

Sample response

View code
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "5ae41fc5-8a82-41c7-bf58-8158df908940",
"date_added": "2020-08-14T14:46:56.025874Z",
"date_modified": "2020-08-14T14:46:56.025910Z",
"pay_code": {
"id": "c7ac530f-f8bd-4f97-9884-de0f33e04ea6",
"name": "adjuster",
"label": "Adjuster"
},
"pay_code_id": "c7ac530f-f8bd-4f97-9884-de0f33e04ea6",
"payment_method_id": "a6ca284d-098c-48de-a081-13f27eaa822d",
"payment_method": {
"id": "a6ca284d-098c-48de-a081-13f27eaa822d",
"name": "check",
"label": "Check"
},
"pre_process_status": {
"id": "08dd8ef3-9fb2-4234-b1fa-7344372192de",
"name": "pass",
"label": "Pass"
},
"payees": [
{
"id": "dcfc288d-526f-41a0-87c7-bb68711a5491",
"party": {
"id": "a468d561-0917-4ca9-b40e-e98eee500f67",
"number": "P01",
"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",
"party_type": {
"id": "12df2a0a-468a-450f-a524-08c6a5c41fc1",
"name": "individual",
"label": "Individual"
},
"contact_id": "07890f82-a3cb-47e2-8fd1-12df4a920618",
"contact": {
"id": "07890f82-a3cb-47e2-8fd1-12df4a920618",
"dba": "",
"dbs": null,
"dob": "1980-02-13 00:00:00",
"ssn": "",
"name": "Mike Gerber",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": {
"id": "9e3bc74f-9339-4e44-92f7-9f347535b097",
"type": "Home",
"email": "mike_gerber19@gmail.com"
},
"primary_phone": {
"id": "ce559dc9-fc91-4b42-ab9c-91926716769b",
"type": "Cell",
"phone": "+13607854434"
},
"primary_address": {
"id": "8ca7fd3e-199e-4b15-9c70-f6e161ebf403",
"zip": "33333",
"city": "Fort Lauderdale",
"type": "Mailing",
"line1": "401 Marlins Way",
"line2": "",
"state": "FL",
"county": "Broward",
"country": "USA"
},
"is_approved_vendor": false
},
"labels": [],
"roles": [
{
"id": "04bc69c5-3270-4031-b55e-53d782aea391",
"name": "owner",
"label": "Owner",
"priority": 1,
"metadata": {
"pages": "all",
"first_page": "search"
}
},
{
"id": "a2a12717-a9dc-4125-a55c-b04362d333af",
"name": "driver",
"label": "Driver",
"priority": 2,
"metadata": {
"pages": "all",
"first_page": "search"
}
},
{
"id": "a5073f13-8c6a-4702-a146-603ac214e353",
"name": "agent",
"label": "Agent",
"priority": 2,
"metadata": {
"pages": "all",
"first_page": "search"
}
},
{
"id": "4f54e18b-947e-488d-b814-bd26b9931306",
"name": "reporter",
"label": "Reporter",
"priority": 4,
"metadata": {
"pages": "all",
"first_page": "search"
}
},
{
"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",
"name": "other",
"label": "Other",
"priority": 13,
"metadata": {
"pages": "all",
"first_page": "add"
}
}
],
"claim_roles": [
{
"id": "4f54e18b-947e-488d-b814-bd26b9931306",
"name": "reporter",
"label": "Reporter"
}
],
"risk_roles": [
{
"id": "04bc69c5-3270-4031-b55e-53d782aea391",
"name": "owner",
"label": "Owner",
"priority": 1,
"metadata": {
"pages": "all",
"first_page": "search"
}
},
{
"id": "a2a12717-a9dc-4125-a55c-b04362d333af",
"name": "driver",
"label": "Driver",
"priority": 2,
"metadata": {
"pages": "all",
"first_page": "search"
}
}
],
"related_party_roles": [
{
"id": "a5073f13-8c6a-4702-a146-603ac214e353",
"name": "agent",
"label": "Agent",
"priority": 2,
"metadata": {
"pages": "all",
"first_page": "search"
}
},
{
"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",
"name": "other",
"label": "Other",
"priority": 13,
"metadata": {
"pages": "all",
"first_page": "add"
}
}
],
"is_involved": true,
"policy_contact": false,
"fields": {
"license_state": "FL",
"drivers_license": "mikegerb*336FR"
},
"preferred_phone_id": null,
"preferred_email_id": null,
"preferred_address_id": null,
"refused_to_provide_dob": false,
"refused_to_provide_ssn": false,
"refused_to_provide_gender": false
},
"party_id": "a468d561-0917-4ca9-b40e-e98eee500f67",
"location": {
"id": "0e30932c-d348-41f9-a4bf-5dbf114c51a1",
"line1": "401 Marlins Way",
"line2": "",
"city": "Fort Lauderdale",
"country": "USA",
"county": "Broward",
"state": "FL",
"zip": "33333",
"latitude": null,
"longitude": null,
"full_address": "401 Marlins Way, Fort Lauderdale, FL, 33333",
"other_details": null,
"type": "Mailing"
},
"payee_type": "primary"
},
{
"id": "337575ca-209d-4f18-a32f-239bff61fd58",
"party": {
"id": "02f352be-348b-4bd0-8d00-975e6ed93bc6",
"number": null,
"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",
"party_type": {
"id": "12df2a0a-468a-450f-a524-08c6a5c41fc1",
"name": "individual",
"label": "Individual"
},
"contact_id": "6dafe7a3-f979-4811-b1f3-b7f8329226d6",
"contact": {
"id": "6dafe7a3-f979-4811-b1f3-b7f8329226d6",
"dba": "",
"dbs": null,
"dob": "1996-06-15 00:00:00",
"ssn": "",
"name": "Tommie Dahl",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": null,
"primary_phone": null,
"primary_address": null,
"is_approved_vendor": false
},
"labels": [],
"roles": [
{
"id": "04bc69c5-3270-4031-b55e-53d782aea391",
"name": "owner",
"label": "Owner",
"priority": 1,
"metadata": {
"pages": "all",
"first_page": "search"
}
},
{
"id": "73ca225f-d9b4-4161-8b63-1695838fbee1",
"name": "child",
"label": "Child",
"priority": 5,
"metadata": {
"pages": "all",
"first_page": "add"
}
}
],
"claim_roles": [],
"risk_roles": [
{
"id": "04bc69c5-3270-4031-b55e-53d782aea391",
"name": "owner",
"label": "Owner",
"priority": 1,
"metadata": {
"pages": "all",
"first_page": "search"
}
}
],
"related_party_roles": [
{
"id": "73ca225f-d9b4-4161-8b63-1695838fbee1",
"name": "child",
"label": "Child",
"priority": 5,
"metadata": {
"pages": "all",
"first_page": "add"
}
}
],
"is_involved": false,
"policy_contact": false,
"fields": {},
"preferred_phone_id": null,
"preferred_email_id": null,
"preferred_address_id": null,
"refused_to_provide_dob": false,
"refused_to_provide_ssn": false,
"refused_to_provide_gender": false
},
"party_id": "02f352be-348b-4bd0-8d00-975e6ed93bc6",
"location": null,
"payee_type": "additional"
},
{
"id": "42ff2cf7-58de-4c04-b31e-c9a30c611d33",
"party": {
"id": "cf8ccbd0-d7f1-4c3a-918b-b3de88f17d12",
"number": null,
"claim_id": "02d6fabb-b415-4f2a-bea5-f51ebf11e040",
"party_type": {
"id": "12df2a0a-468a-450f-a524-08c6a5c41fc1",
"name": "individual",
"label": "Individual"
},
"contact_id": "8ccad944-ab73-4877-b198-8ad57061be49",
"contact": {
"id": "8ccad944-ab73-4877-b198-8ad57061be49",
"dba": "",
"dbs": null,
"dob": null,
"ssn": "",
"name": "Sarah Hughes",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": {
"id": "c6d8123c-2ec4-4330-a281-52f5e1111ea9",
"type": "Other",
"email": "sarah_hu@hotmail.com"
},
"primary_phone": {
"id": "409d7ab3-899b-4400-bfa2-6568319ca535",
"type": "Cell",
"phone": "+17124475281"
},
"primary_address": {
"id": "b9208776-f7a0-4950-9c63-72fa047ff786",
"zip": "22222",
"city": "Arlington",
"type": "Mailing/Billing",
"line1": "222 Main St",
"line2": "",
"state": "VA",
"county": "Arlington",
"country": "USA"
},
"is_approved_vendor": false
},
"labels": [],
"roles": [
{
"id": "e30155f8-8350-42cd-8b0c-b5a5804aa113",
"name": "medical_professional",
"label": "Medical Professional",
"priority": 8,
"metadata": {
"pages": "all",
"first_page": "search",
"equivalent_claim_party_role": "medical-professional"
}
},
{
"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",
"name": "other",
"label": "Other",
"priority": 13,
"metadata": {
"pages": "all",
"first_page": "add"
}
}
],
"claim_roles": [],
"risk_roles": [],
"related_party_roles": [
{
"id": "e30155f8-8350-42cd-8b0c-b5a5804aa113",
"name": "medical_professional",
"label": "Medical Professional",
"priority": 8,
"metadata": {
"pages": "all",
"first_page": "search",
"equivalent_claim_party_role": "medical-professional"
}
},
{
"id": "0db14a3f-38c3-4aa2-89ab-61d216c89c0f",
"name": "other",
"label": "Other",
"priority": 13,
"metadata": {
"pages": "all",
"first_page": "add"
}
}
],
"is_involved": false,
"policy_contact": false,
"fields": {},
"preferred_phone_id": null,
"preferred_email_id": null,
"preferred_address_id": null,
"refused_to_provide_dob": false,
"refused_to_provide_ssn": false,
"refused_to_provide_gender": false
},
"party_id": "cf8ccbd0-d7f1-4c3a-918b-b3de88f17d12",
"location": null,
"payee_type": "alternative"
}
],
"due_date": "2020-08-06",
"processed_date": null,
"is_processed": false,
"transaction_id": "bf6f37b2-f7df-49ba-862b-1d4a6ff26081",
"transaction": {
"id": "bf6f37b2-f7df-49ba-862b-1d4a6ff26081",
"date_added": "2020-08-14T14:46:56.008129Z",
"date_modified": "2020-08-14T14:46:56.020610Z",
"transaction_status": {
"id": "4dfe2144-a9f5-4de9-aebb-3904000e5281",
"name": "approved",
"label": "Approved"
},
"lob": "Personal Auto",
"exposure_coverage_label": "Bodily Injury",
"claim_number": "C-75-2020",
"exposure_claimant_contact_name": "Mike Gerber",
"exposure_claimant_display_number": "P01",
"reserve_category_id": "ce3964c4-e3a1-4208-a007-0e13442863a8",
"reserve_category_label": "Adjuster",
"reserve_category_type_label": "Expense",
"number": "T000000745",
"amount": 100.0,
"adjuster_contact_name": "--",
"exposure_id": "fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48",
"exposure_number": "C-75-2020-E002",
"exposure_display_number": "E002",
"comments": "Comments"
},
"final_payment": false,
"in_payment_of": "In Payment Of (Memo)",
"from_date": null,
"through_date": null,
"billed_amount": null,
"invoice_number": null,
"invoice_date": null,
"check_number": "Check Number",
"check_date": "2020-08-16",
"cleared_date": "2020-08-19",
"payment_type_id": "a56d4141-086f-4884-9fbe-c0257e4c1926",
"payment_type": {
"id": "a56d4141-086f-4884-9fbe-c0257e4c1926",
"name": "final_payment",
"label": "Final Payment"
},
"claim_number": "C-75-2020",
"payees_display_on_check_edited": "Mike Gerber and Tommie Dahl or Sarah Hughes",
"payees_display_on_check_generated": "Mike Gerber and Tommie Dahl or Sarah Hughes",
"deductible_amount_before_adjustments": null,
"deductible_amount_to_pay": null
}
]
}

Step 11: Process the payments

The claims_payments_batches_create endpoint (/claims/payments/batches/)receives an array of payment_ids and processes a batch of the payments.

Sample request

View code
curl --location --request POST '/api/claims/payments/batches/' \

--header 'Content-Type: application/json' \

--data-raw '{

"payments": [

"c010369c-3823-442d-9d8a-f545bf2ea0a9"

]

}'

Sample response

View code
{

"id": "cfe85cac-6464-430f-b345-88edc67670ca",

"amount": 100.0,

"run_by": {

"id": "08465d3c-b218-4a26-8a3c-aa072e782e55",

"name": "Joe Doe",

"username": "jodedoeusername",

"address": "",

"email": "joe.doe@acme.com",

"phone": ""

}

}

Step 12: Retrieve a list of recovery reserve categories

The claims_exposures_accounting_recovery endpoint (claims/exposures/{exposure_id}/accounting/recovery/) lists the recovery reserve categories for a particular exposure. The exposure_id is required.

Sample request

View code
curl --location --request GET '/api/claims/exposures/fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48/reserve-categories/?recovery=true'

Sample response

View code
{

"count": 3,

"next": null,

"previous": null,

"results": [

{

"id": "8f0cd059-f164-449d-9c9b-495cf4e61880",

"name": "loss_subrogation",

"label": "Loss",

"children": [],

"reserve_category_type": {

"id": "148ac100-d773-4c75-a091-09e4e966ef15",

"name": "subrogation",

"label": "Subrogation"

},

"pay_codes": [

{

"id": "594f9595-ba27-4503-bc25-0e18fe504713",

"name": "subrogation",

"label": "Subrogation"

}

],

"recovery": true

},

{

"id": "61ee89a0-26f7-4913-95e8-3babb1764036",

"name": "adjuster_subrogation",

"label": "Adjuster",

"children": [],

"reserve_category_type": {

"id": "148ac100-d773-4c75-a091-09e4e966ef15",

"name": "subrogation",

"label": "Subrogation"

},

"pay_codes": [

{

"id": "594f9595-ba27-4503-bc25-0e18fe504713",

"name": "subrogation",

"label": "Subrogation"

}

],

"recovery": true

},

{

"id": "1d408aa7-4319-4d3f-816a-130c84b77ac2",

"name": "legal_subrogation",

"label": "Legal",

"children": [],

"reserve_category_type": {

"id": "148ac100-d773-4c75-a091-09e4e966ef15",

"name": "subrogation",

"label": "Subrogation"

},

"pay_codes": [

{

"id": "594f9595-ba27-4503-bc25-0e18fe504713",

"name": "subrogation",

"label": "Subrogation"

}

],

"recovery": true

}

]

}

Step 13: Retrieve for sum of reserve amounts and recovery amount for all reserve categories

The claims_exposures_accounting_summary endpoint (/claims/exposures/{exposure_id}/accounting/summary/) retrieves the sum of reserve amounts and recovery amount for all reserve categories. Under the reserve_categories, you will see reserve amount and recovery amount that is set for each reserve category. exposure_id is required.

Sample request

View code
curl --location --request GET ' api/claims/exposures/fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48/accounting/recovery/'

Sample response

View code
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "148ac100-d773-4c75-a091-09e4e966ef15",
"name": "subrogation",
"label": "Subrogation",
"recovery_reserve": 2200.0,
"recovered": 0.0,
"total_recovery": 2200.0,
"reserve_categories": [
{
"id": "8f0cd059-f164-449d-9c9b-495cf4e61880",
"name": "loss_subrogation",
"label": "Loss",
"children": null,
"recovery_reserve": 2000.0,
"recovered": 0.0,
"total_recovery": 2000.0
},
{
"id": "61ee89a0-26f7-4913-95e8-3babb1764036",
"name": "adjuster_subrogation",
"label": "Adjuster",
"children": null,
"recovery_reserve": 200.0,
"recovered": 0.0,
"total_recovery": 200.0
},
{
"id": "1d408aa7-4319-4d3f-816a-130c84b77ac2",
"name": "legal_subrogation",
"label": "Legal",
"children": null,
"recovery_reserve": 0.0,
"recovered": 0.0,
"total_recovery": 0.0
}
]
}
]
}

Step 14: Set recovery reserve

The claims_exposures_recovery-reserves_create endpoint (/claims/exposures/{exposure_id}/recovery-reserves/) updates the recovery reserve amount of a particular exposure. The following parameters are required:

  • exposure_id
  • reserve_category_id
  • amount
  • new_amount

Sample request

View code
curl --location --request POST /api/claims/exposures/fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48/recovery-reserves/' \

--header 'Content-Type: application/json' \

--data-raw '{

"amount": 5000.00,

"new_amount": 10000.00,

"reserve_category_id": "8f0cd059-f164-449d-9c9b-495cf4e61880"

}'

Sample response

View code

{

"id": "666e618a-c831-492c-ba40-3a74dea45be1",

"date_added": "2020-08-14T16:24:55.986357Z",

"date_modified": "2020-08-14T16:24:55.991969Z",

"exposure_id": "fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48",

"reserve_category": {

"id": "8f0cd059-f164-449d-9c9b-495cf4e61880",

"name": "loss_subrogation",

"label": "Loss",

"children": [],

"reserve_category_type": {

"id": "148ac100-d773-4c75-a091-09e4e966ef15",

"name": "subrogation",

"label": "Subrogation"

},

"pay_codes": [

{

"id": "594f9595-ba27-4503-bc25-0e18fe504713",

"name": "subrogation",

"label": "Subrogation"

}

],

"recovery": true

},

"transaction_status": {

"id": "918ba38b-ad54-43b6-98b3-f2828451abf2",

"name": "posted",

"label": "Posted"

},

"transaction_type": {

"id": "3461fb14-0dde-44d1-9c80-252c344a37dc",

"name": "recovery-reserve",

"label": "Recovery Reserve"

},

"transaction_sub_type_id": "eb1b303f-d61a-4995-8bb7-98a41e1e796e",

"transaction_sub_type": {

"id": "eb1b303f-d61a-4995-8bb7-98a41e1e796e",

"name": "reserve-change",

"label": "Reserve Change"

},

"amount": 5000.0,

"entry_by": null,

"comments": ""

}

Step 15: Submit recovery

The claims_exposures_recoveries_create endpoint (/claims/exposures/{exposure_id}/recoveries/) submits a recovery for a particular exposure and reserve category. The following parameters are required:

  • exposure_id
  • reserve_category_id
  • payment_method_id
  • amount
  • pay_code_id
  • payor
  • Line1 (address)
  • city
  • state
  • zip
  • Received_date

Line 2 and comments are optional. You can enter null.

Sample request

View code
curl --location --request POST ' /api/claims/exposures/fde4cec1-ed0a-4b83-81d8-cdf3d10b6a48/recoveries/' \

--header 'Content-Type: application/json' \

--data-raw '{

"payor": "Payor Name",

"reserve_category_id": "8f0cd059-f164-449d-9c9b-495cf4e61880",

"pay_code_id": "594f9595-ba27-4503-bc25-0e18fe504713",

"received_date": "2020-08-13",

"reserve_amount": 2000,

"line1": "Street Address",

"line2": "Additional Street Address",

"city": "City",

"state": "MO",

"zip": "12345",

"payment_method_id": "a6ca284d-098c-48de-a081-13f27eaa822d",

"amount": "1000",

"comments": "Comments"

}'

Sample response

View code
{

"id": "d040434a-40e4-4f53-aa03-eb9e9d1ad4ce",

"payment_method_id": "a6ca284d-098c-48de-a081-13f27eaa822d",

"pay_code_id": "594f9595-ba27-4503-bc25-0e18fe504713",

"payor": "Payor object (19a74fac-44ea-45d9-9929-cb1764936f5a)",

"line1": null,

"line2": null,

"received_date": "2020-08-13"

}