Skip to the page
Chapters

ERAs

Post an ERA

POST/api/v1/eras/{id}/post

Says you posted the ERA in your system: every claim it paid or denied (and that no later remittance changed) becomes reconciled, and the ERA posted. An ERA posted already is returned as it is. Unmatched payments stay unmatched: match them by hand, then reconcile their claims. Send an empty JSON object as the body. Needs a key with both read and submit: an ERA holds payments of the whole organization. Needs an Idempotency-Key header and a key with the submit permission.

Needs a key with submit permission.

Request

Headers

Headers
NameTypeRequiredDescription
Idempotency-KeystringrequiredMakes the request safe to repeat: a request with the same key and body returns the first answer (the reply has an idempotent-replayed header), and the same key with a different request is refused. 1 to 255 printable characters; a UUID is a good choice.At least 1 character.At most 255 characters.Matches `^[\x21-\x7e]{1,255}$`.

Path parameters

Path parameters
NameTypeRequiredDescription
idstringrequiredAn ERA ID (era_...).

Response

The ERA as it is now, and how many claims this marked reconciled. Status 200.

Response fields
NameTypeDescription
objectstringAlways `era_post`.
eraobject
era.idstringAn ID that starts with era_.
era.objectstringAlways `era`.
era.statestringneeds_review: received, not yet posted; posted: you posted it.One of: `needs_review`, `posted`.
era.payerobject or nullThe payer in the directory, when the remittance names one we know.
era.payer.idstringAn ID that starts with pyr_.
era.payer.payer_idstringThe payer's own payer ID.
era.payer.namestring
era.payer_namestringThe payer's name as the remittance gives it.
era.office_idstring or nullThe office the payment was made to (the payee), when exactly one office of yours matches it.
era.paymentobject
era.payment.methodstringACH (an electronic transfer), CHK (a check), NON (no payment) or another code as sent.
era.payment.trace_numberstringThe EFT trace or check number: matches the deposit in your bank account.
era.payment.datestring (date) or null
era.payment.totalstringThe amount paid.Matches `^-?\d+\.\d{2}$`.
era.payment.provider_adjustments_totalstringAdjustments at provider level (a recoupment, a forward balance): a positive one reduced the payment.Matches `^-?\d+\.\d{2}$`.
era.balancedbooleanWhether the remittance adds up (the payment, each claim and each line). One that does not is flagged for review: only the claims that add up on their own were applied.
era.countsobject
era.counts.claimsintegerAt least -9007199254740991.
era.counts.matchedintegerAt least -9007199254740991.
era.counts.unmatchedintegerAt least -9007199254740991.
era.received_atstring (date-time)
era.posted_atstring (date-time) or null
era.findingsarray of objectWhat does not add up, if anything: each with where (payment, a claim or a line) and the two figures.
era.findings[].scopestring
era.findings[].pathstring
era.findings[].messagestring
era.findings[].expectedstring or nullAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.findings[].actualstring or nullAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.provider_adjustmentsarray of object
era.provider_adjustments[].reason_codestring
era.provider_adjustments[].referencestring
era.provider_adjustments[].amountstringAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claimsarray of object
era.claims[].idstringAn ID that starts with erc_.
era.claims[].objectstringAlways `era_claim`.
era.claims[].claim_idstring or nullThe claim this payment is for; null while it is unmatched.
era.claims[].matchstringmatched: by the patient control number or the payer claim number; manual: matched by hand; unmatched: no claim with certainty (match it by hand).One of: `matched`, `unmatched`, `manual`.
era.claims[].unmatched_reasonstring or nullWhy a payment naming one of your claims was left unmatched: payer_differs (the ERA's payer is not the claim's), claim_not_payable (the claim could not take a payment in its state, such as while it is being corrected), estimate_for_claim (an estimate naming a claim), payment_for_predetermination (a payment naming a predetermination). Match it by hand once you have checked. Null otherwise.One of: `payer_differs`, `claim_not_payable`, `estimate_for_claim`, `payment_for_predetermination`.
era.claims[].patient_control_numberstringThe patient control number as the payer echoed it.
era.claims[].payer_claim_numberstring
era.claims[].statusobject
era.claims[].status.codestringThe payer's claim status (CLP02).
era.claims[].status.descriptionstring
era.claims[].outcomestringWhat the payment does to the claim: paid, denied, reversal (an earlier payment taken back), estimate (the answer to a predetermination, never a payment), or status (reported only).One of: `paid`, `denied`, `reversal`, `status`, `estimate`.
era.claims[].chargestringAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claims[].paidstringAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claims[].allowedstring or nullAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claims[].patient_responsibilitystringAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claims[].adjustmentsarray of objectAdjustments at claim level (each line has its own).
era.claims[].adjustments[].groupstringThe adjustment group: CO (contractual), PR (patient responsibility), OA (other), PI (payer initiated) or CR (correction).
era.claims[].adjustments[].group_descriptionstringThe group in plain words.
era.claims[].adjustments[].reasonstringThe claim adjustment reason code, as sent (such as 45, 2 or 119).
era.claims[].adjustments[].descriptionstringThe reason in our own plain words, for the common codes; the code itself for any other.
era.claims[].adjustments[].amountstringAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claims[].patient_namevalueThe patient as the payer wrote it, shown only while the payment is unmatched, to find its claim; null once matched.
era.claims[].balancedbooleanWhether its charge less its payment is its adjustments: one that is not was not applied to its claim.
era.claims[].appliedbooleanWhether it moved its claim (paid, denied or reversed).
era.claims[].postablebooleanWhether posting the ERA marks its claim reconciled: applied, the ERA not posted yet, and the claim paid or denied with this ERA's payment as its current one.
era.claims[].linesarray of object
era.claims[].lines[].procedure_codestringThe CDT code the payer paid.
era.claims[].lines[].modifiersarray of string
era.claims[].lines[].service_datestring (date) or null
era.claims[].lines[].chargestringAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claims[].lines[].paidstringAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claims[].lines[].allowedstring or nullAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claims[].lines[].unitsvalue
era.claims[].lines[].adjustmentsarray of object
era.claims[].lines[].adjustments[].groupstringThe adjustment group: CO (contractual), PR (patient responsibility), OA (other), PI (payer initiated) or CR (correction).
era.claims[].lines[].adjustments[].group_descriptionstringThe group in plain words.
era.claims[].lines[].adjustments[].reasonstringThe claim adjustment reason code, as sent (such as 45, 2 or 119).
era.claims[].lines[].adjustments[].descriptionstringThe reason in our own plain words, for the common codes; the code itself for any other.
era.claims[].lines[].adjustments[].amountstringAn amount in dollars, as a decimal string with two places (such as "113.60").Matches `^-?\d+\.\d{2}$`.
era.claims[].lines[].remarksarray of stringRemark codes, as sent.
era.claims[].lines[].line_control_numbervalueThe line control number the payer returned (ours is <patient control number>-<line>).
era.claims[].lines[].claim_line_numberinteger or nullThe line of the matched claim this pays; null when no line matched with certainty.At least -9007199254740991.
era.postable_countintegerHow many claims posting this ERA marks reconciled now (each claim once); 0 when it was posted, or has nothing to reconcile (posting it then marks it reviewed).At least -9007199254740991.
reconciledintegerHow many claims this post marked reconciled (none when the ERA was posted already).At least -9007199254740991.

Errors

Errors
HTTP statusCodeWhat it means
401UNAUTHORIZEDA valid API key is required. Send it as "Authorization: Bearer <key>".
403PERMISSION_DENIEDThis API key is not allowed to do that.
404NOT_FOUNDNot found.
422INVALID_REQUESTThe request is not valid.
400IDEMPOTENCY_KEY_REQUIREDPOST and PATCH requests need an Idempotency-Key header.
422IDEMPOTENCY_KEY_REUSEDThat Idempotency-Key was already used with a different request.
409IDEMPOTENCY_KEY_IN_USEA request with that Idempotency-Key is still running. Retry shortly.
413PAYLOAD_TOO_LARGEThe request body is larger than 1 MB.
504TIMEOUTThe request took too long to finish. It may still have taken effect: look it up before sending it again with a new Idempotency-Key. What it made is found with GET /api/v1/eligibility?request_id=<this request_id>, and the same filter on /api/v1/claims and /api/v1/attachments (a key with read permission).
500INTERNALSomething went wrong on our side. Quote the request ID if you contact us.

Example

Example request

Shell
curl -X POST "https://sandbox.myclaimhouse.com/api/v1/eras/era_01JM000000E00800000000003G/post" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Example response: 200

JSON
{
  "object": "era_post",
  "era": {
    "id": "era_01JM000000E00800000000003G",
    "object": "era",
    "state": "posted",
    "payer": {
      "id": "pyr_01JM000000E008000000000004",
      "payer_id": "00000",
      "name": "Example Dental Plan"
    },
    "payer_name": "EXAMPLE DENTAL PLAN",
    "office_id": "off_01JM000000E008000000000003",
    "payment": {
      "method": "ACH",
      "trace_number": "SBXEFT000001042",
      "date": "2026-09-24",
      "total": "820.80",
      "provider_adjustments_total": "0.00"
    },
    "balanced": true,
    "counts": {
      "claims": 2,
      "matched": 1,
      "unmatched": 1
    },
    "received_at": "2026-09-24T21:03:30.000000+00:00",
    "posted_at": "2026-09-25T09:00:00.000000+00:00",
    "findings": [],
    "provider_adjustments": [],
    "claims": [
      {
        "id": "erc_01JM000000E00800000000003H",
        "object": "era_claim",
        "claim_id": "clm_01JM000000E00800000000002G",
        "match": "matched",
        "unmatched_reason": null,
        "patient_control_number": "CH4Q7M2K9TRB",
        "payer_claim_number": "990000001042",
        "status": {
          "code": "1",
          "description": "Processed as primary."
        },
        "outcome": "paid",
        "charge": "1140.00",
        "paid": "820.80",
        "allowed": "1026.00",
        "patient_responsibility": "205.20",
        "adjustments": [],
        "patient_name": null,
        "balanced": true,
        "applied": true,
        "postable": false,
        "lines": [
          {
            "procedure_code": "D2740",
            "modifiers": [],
            "service_date": "2026-09-24",
            "charge": "1140.00",
            "paid": "820.80",
            "allowed": "1026.00",
            "units": 1,
            "adjustments": [
              {
                "group": "CO",
                "group_description": "The provider writes this off under its contract with the payer. The patient is not billed.",
                "reason": "45",
                "description": "The charge is more than the payer fee schedule allows.",
                "amount": "114.00"
              },
              {
                "group": "PR",
                "group_description": "The patient owes this.",
                "reason": "2",
                "description": "The patient coinsurance share.",
                "amount": "205.20"
              }
            ],
            "remarks": [],
            "line_control_number": "CH4Q7M2K9TRB-1",
            "claim_line_number": 1
          }
        ]
      },
      {
        "id": "erc_01JM000000E00800000000003J",
        "object": "era_claim",
        "claim_id": null,
        "match": "unmatched",
        "unmatched_reason": null,
        "patient_control_number": "PMS-77812",
        "payer_claim_number": "990000001077",
        "status": {
          "code": "4",
          "description": "Denied."
        },
        "outcome": "denied",
        "charge": "310.00",
        "paid": "0.00",
        "allowed": null,
        "patient_responsibility": "0.00",
        "adjustments": [],
        "patient_name": "SAMPLE, MIA",
        "balanced": true,
        "applied": false,
        "postable": false,
        "lines": [
          {
            "procedure_code": "D4341",
            "modifiers": [],
            "service_date": "2026-09-24",
            "charge": "310.00",
            "paid": "0.00",
            "allowed": null,
            "units": 1,
            "adjustments": [
              {
                "group": "CO",
                "group_description": "The provider writes this off under its contract with the payer. The patient is not billed.",
                "reason": "119",
                "description": "The benefit maximum for the period has been reached.",
                "amount": "310.00"
              }
            ],
            "remarks": [
              "N130"
            ],
            "line_control_number": "1",
            "claim_line_number": null
          }
        ]
      }
    ],
    "postable_count": 0
  },
  "reconciled": 1
}