Create Claim Payment

post

https://unify.kolla.dev/dental/v1/claimPayments

Records an insurance check against an existing claim, allocating the insurance paid, write-off, and deductible to each procedure on the claim. The claim is marked received once every procedure on it has been received.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

validate_only

boolean

If set, the request is validated and resolved but nothing is written.

Body Params

A ClaimPayment is an insurance check (or EFT) received from a carrier and allocated to the procedures on a claim.

claim

string

required

^contacts/.+/claims/.+$

The claim being paid. Format: contacts/{contact}/claims/{claim}.

check_date

string

required

^\d{4}-\d{2}-\d{2}$

The date on the check (format: YYYY-MM-DD).

check_amount

string

^\d+(\.\d{1,2})?$

The total amount of the check as a positive decimal string. Defaults to the sum of the allocations' insurance paid amounts; a check that also pays other claims may be larger, in which case it is recorded as partial.

check_number

string

The check or EFT number.

carrier_title

string

The name of the paying carrier. Defaults to the carrier of the claim's insurance plan.

pay_type

string

The insurance payment type (format: customtypes/{custom_type}). Defaults to the practice's first visible insurance payment type.

location

string

^resources/.+$

The practice location the check is deposited to (format: resources/{resource}). Defaults to the claim's location.

note

string

A free-text note on the check.

allocations

array of objects

required

length ≥ 1

The per-procedure allocation of the check. Each procedure must be on the claim and not yet received.

allocations*

The portion of a claim payment applied to one procedure on the claim. Amounts are positive decimal strings.

procedure

string

required

^procedures/.+$

The procedure on the claim (format: procedures/{procedure}).

ins_pay_amount

string

^\d+(\.\d{1,2})?$

The amount insurance paid for the procedure.

write_off

string

^\d+(\.\d{1,2})?$

The contractual write-off for the procedure.

deductible

string

^\d+(\.\d{1,2})?$

The deductible applied to the procedure.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response