Get insurance refunds

GET

/api/insurance-refunds/v1

GET

/api/insurance-refunds/v1

import requests
url = "https://api.taigabilling.com/api/insurance-refunds/v1"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "items": [
    {
      "insurance_refund_id": "string",
      "payer": {
        "payer_uuid": "string",
        "payer_id": "12345",
        "payer_name": "Payer Name",
        "availity_payer_name": "string",
        "availity_claims_payer_id": "string",
        "availity_eligibility_id": "string",
        "availity_remittance_payer_id": "string",
        "street_address": {
          "address1": "string",
          "city": "string",
          "state": "AA",
          "zip_code": "string",
          "zip_plus_four_code": "1234",
          "address2": "string"
        }
      },
      "amount_cents": 1,
      "allocations": [
        {
          "amount_cents": 1,
          "target": {
            "claim_id": "string",
            "encounter_id": "string",
            "service_line_id": "string",
            "type": "service_line"
          },
          "allocation_id": "string",
          "earmark": {
            "id": "string",
            "target": {
              "type": "date_of_service",
              "value": "string"
            },
            "amount_earmarked_cents": 1,
            "created_by_allocation_id": "string"
          },
          "allocated_on": "2024-01-15T09:30:00Z"
        }
      ],
      "refund_timestamp": "2024-01-15T09:30:00Z",
      "refund_note": "string",
      "refund_reason": "OVERCHARGED"
    }
  ],
  "next_page_token": "string",
  "prev_page_token": "string"
}

Returns all insurance refunds satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.

Authentication

AuthorizationBearer

Send your Taiga API key as a Bearer token. Create and manage keys in the Taiga developer portal.

Query parameters

limitintegerOptional

Defaults to 100. The value must be greater than 0 and less than 1000.

payer_uuidstringOptionalformat: "uuid"

claim_idstringOptionalformat: "uuid"

service_line_idstringOptionalformat: "uuid"

billing_provider_idstringOptionalformat: "uuid"

sortenumOptional

Defaults to refund_timestamp

Allowed values:

sort_directionenumOptional

Sort direction. Defaults to descending order if not provided.

Allowed values:

page_tokenstringOptional

Response

itemslist of objects

next_page_tokenstring or nullOptional

prev_page_tokenstring or nullOptional

Errors

403

Forbidden Error

422

Unprocessable Entity Error