Remittance

Remittances are the payment advices (835s) payers send back for submitted insurance claims. Each remittance carries the claims it covers, and each claim carries its charges and adjustments.

The remittance model

Properties

Name
id
Type
string
Description
Unique identifier for the remittance.
Name
object
Type
string
Description
Always 'insurance_remittance'.
Name
name
Type
string
Description
Name of the remittance.
Name
payer_id
Type
string
Description
Identifier of the payer that issued the remittance.
Name
payer_name
Type
string
Description
Name of the payer that issued the remittance.
Name
billing_provider
Type
string
Description
Billing provider the payment was made to.
Name
check_type
Type
string
Description
How the payment was made, for example 'ACH' or 'CHK'.
Name
check_number
Type
string
Description
Check or trace number of the payment.
Name
paid
Type
number
Description
Total amount paid on the remittance.
Name
paid_at
Type
date
Description
Date the payment was issued.
Name
pdf
Type
string
Description
URL of the remittance PDF, if one is available.
Name
external_accounts
Type
object
Description
Identifiers for the remittance in connected clearinghouses, for example claim_md.
Name
claims
Type
array of objects
Description
The claims covered by this remittance. Each has: id, insurance_claim (the matching insurance claim, or null if not yet matched), total_charge, patient_responsibility, total_paid, status_history, and charges.
Name
claims[].status_history
Type
array of objects
Description
Status changes of the remittance claim. Each has a status ('pending', 'denied', 'payment_posted', 'payment_posted_deleted', or 'settled'), changed_by, and changed_at.
Name
claims[].charges
Type
array of objects
Description
The service lines on the claim. Each has: id, billing_item, procedure, charge, allowed, paid, date_of_service_start, date_of_service_end, adjustments, and status_history (statuses 'pending' or 'posted').
Name
claims[].charges[].adjustments
Type
array of objects
Description
Payer adjustments on the charge. Each has: id, amount, group (the CAS group code, for example 'CO' or 'PR'), code (the claim adjustment reason code), and remark_code.
Name
created_by
Type
string
Description
Creator of the remittance.
Name
created_at
Type
date-time
Description
Timestamp (in ISO 8601 format) of when the remittance was created.
Name
last_updated_at
Type
date-time
Description
Timestamp (in ISO 8601 format) of when this remittance was last updated.

Response

{
    "id": "irmt_02DCBCXf3BglWGW0eC3H",
    "object": "insurance_remittance",
    "name": "Aetna — 2026-08-28",
    "payer_id": "60054",
    "payer_name": "Aetna",
    "billing_provider": "bprv_9g36hEN5wgew2M59eIrF",
    "check_type": "ACH",
    "check_number": "1234567890",
    "paid": 215.4,
    "paid_at": "2026-08-28",
    "pdf": "https://storage.avonhealth.com/remittances/irmt_02DCBCXf3BglWGW0eC3H.pdf",
    "external_accounts": {
        "claim_md": "98765432"
    },
    "claims": [
        {
            "id": "rclm_tJFm1YU2tWDhpgUhXSZ5",
            "insurance_claim": "iclm_GHY5mso3NpQP90bNHhpp",
            "total_charge": 300,
            "patient_responsibility": 40,
            "total_paid": 215.4,
            "status_history": [
                {
                    "status": "pending",
                    "changed_by": "user_idjkvxZTqfJD734feQHa",
                    "changed_at": "2026-08-28T14:02:11.000Z"
                }
            ],
            "charges": [
                {
                    "id": "chrg_Z1zXZKvqrpwxbznuW6lJ",
                    "billing_item": "bitm_iXijTmvKZayeKgLvUEUf",
                    "procedure": "99213",
                    "charge": 300,
                    "allowed": 255.4,
                    "paid": 215.4,
                    "date_of_service_start": "2026-08-10",
                    "date_of_service_end": "2026-08-10",
                    "adjustments": [
                        {
                            "id": "adjm_JAgHSJHuSodCZ7IhTMqT",
                            "amount": 44.6,
                            "group": "CO",
                            "code": "45",
                            "remark_code": null
                        },
                        {
                            "id": "adjm_QtD0YaeDw4VyS9UPBpX4",
                            "amount": 40,
                            "group": "PR",
                            "code": "3",
                            "remark_code": null
                        }
                    ],
                    "status_history": [
                        {
                            "status": "pending",
                            "changed_by": "user_idjkvxZTqfJD734feQHa",
                            "changed_at": "2026-08-28T14:02:11.000Z"
                        }
                    ]
                }
            ]
        }
    ],
    "created_by": "user_idjkvxZTqfJD734feQHa",
    "created_at": "2026-08-28T14:02:11.000Z",
    "last_updated_at": "2026-08-28T14:02:11.000Z"
}

GET/v2/insurance_remittances

List all remittances

Returns a list of all remittances, with their claims, charges, and adjustments embedded.

Optional query parameters

Name
search
Type
string
Description
Free-text search on name.

Request

GET

/v2/insurance_remittances

curl "https://{{base_subdomain}}.avonhealth.com/v2/insurance_remittances?search=Aetna" \
  -H "Authorization: Bearer {{token}}" \
  -H "x-jwt: {{jwt}}" \
  -H "account: {{account}}"

Response

    {
      "object": "list",
      "data": [
        {
            "id": "irmt_02DCBCXf3BglWGW0eC3H",
            "object": "insurance_remittance",
            "name": "Aetna — 2026-08-28",
            "payer_id": "60054",
            "payer_name": "Aetna",
            "billing_provider": "bprv_9g36hEN5wgew2M59eIrF",
            "check_type": "ACH",
            "check_number": "1234567890",
            "paid": 215.4,
            "paid_at": "2026-08-28",
            "pdf": "https://storage.avonhealth.com/remittances/irmt_02DCBCXf3BglWGW0eC3H.pdf",
            "external_accounts": {
                "claim_md": "98765432"
            },
            "claims": [
                {
                    "id": "rclm_tJFm1YU2tWDhpgUhXSZ5",
                    "insurance_claim": "iclm_GHY5mso3NpQP90bNHhpp",
                    "total_charge": 300,
                    "patient_responsibility": 40,
                    "total_paid": 215.4,
                    "status_history": [
                        {
                            "status": "pending",
                            "changed_by": "user_idjkvxZTqfJD734feQHa",
                            "changed_at": "2026-08-28T14:02:11.000Z"
                        }
                    ],
                    "charges": [
                        {
                            "id": "chrg_Z1zXZKvqrpwxbznuW6lJ",
                            "billing_item": "bitm_iXijTmvKZayeKgLvUEUf",
                            "procedure": "99213",
                            "charge": 300,
                            "allowed": 255.4,
                            "paid": 215.4,
                            "date_of_service_start": "2026-08-10",
                            "date_of_service_end": "2026-08-10",
                            "adjustments": [
                                {
                                    "id": "adjm_JAgHSJHuSodCZ7IhTMqT",
                                    "amount": 44.6,
                                    "group": "CO",
                                    "code": "45",
                                    "remark_code": null
                                }
                            ],
                            "status_history": [
                                {
                                    "status": "pending",
                                    "changed_by": "user_idjkvxZTqfJD734feQHa",
                                    "changed_at": "2026-08-28T14:02:11.000Z"
                                }
                            ]
                        }
                    ]
                }
            ],
            "created_by": "user_idjkvxZTqfJD734feQHa",
            "created_at": "2026-08-28T14:02:11.000Z",
            "last_updated_at": "2026-08-28T14:02:11.000Z"
        },
      ]
    }