API Guide - $0 Insurance Payments

[SLeon]

Some developers requested the ability to make $0 claim payments via the API. We are adding this to the ClaimPayments POST logic now. We will update this thread once it is complete. In the meantime, developers can utilize the workflow below to create $0 claim payments. The underlined sections differ from the normal claim payment workflow.

You will need to already have the ClaimNum of the claim to which you want to apply the claim payment.

1. Use ClaimProcs GET with the ClaimNum parameter to get all of the ClaimProcs associated with the Claim. Note that claim payment cannot be made if any of these have a non-zero ClaimPaymentNum.
2. Use ClaimProcs PUT to update the Status to “Received” and set the InsPayAmt to $0.00. Do this for each ClaimProc on the claim, except one, which needs to be set to $0.01 instead.
3. Use Claims PUT to set the ClaimStatus to “Received”.
4. Use ClaimPayments POST for the ClaimNum using a value of $0.01 for the InsPayAmt.
5. Use ClaimPayments DELETE using the ClaimPaymentNum returned from Step 4.
6. Use ClaimProcs PUT to set the InsPayAmt to $0.00 on the $0.01 claimproc in Step 2.
7. Use ClaimPayments POST for the ClaimNum using a value of $0.00 for the InsPayAmt.

[RyanH]

The ability to make $0 claim payments via the API has been implemented in version 25.1.21. The workflow to create $0 claim payments is the same as described in ClaimPayments POST:

1. Use ClaimProcs GET to retrieve all ClaimProcs associated to a given ClaimNum.
2. For each ClaimProc, use ClaimProcs PUT to update the ClaimProc’s status to “Received” or “Supplemental” and ensure the InsPayAmt is $0.00.
3. Use Claims PUT to update the Claim’s status to “R” (Received).
4. Use ClaimPayments POST, supplying the ClaimNum and a value of $0.00 for the CheckAmt.