Get patient payments

GET

/api/patient-payments/v4

GET

/api/patient-payments/v4

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

{
  "items": [
    {
      "patient_payment_id": "string",
      "organization_id": "string",
      "payment_source": "MANUAL_ENTRY",
      "amount_cents": 1,
      "patient_external_id": "string",
      "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"
        }
      ],
      "source_internal_id": "string",
      "payment_timestamp": "2024-01-15T09:30:00Z",
      "payment_note": "string",
      "invoice": "string",
      "payment_method_detail": {
        "payment_method": {
          "type": "cash"
        },
        "collected_at_address": {
          "address1": "string",
          "city": "string",
          "state": "AA",
          "zip_code": "string",
          "address2": "string",
          "zip_plus_four_code": "string"
        },
        "provider_info": {
          "npi": "string",
          "first_name": "string",
          "last_name": "string"
        }
      }
    }
  ],
  "next_page_token": "string",
  "prev_page_token": "string"
}

Returns all patient payments 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.

patient_external_idstringOptional

claim_idstringOptionalformat: "uuid"

service_line_idstringOptionalformat: "uuid"

billing_provider_idstringOptionalformat: "uuid"

unattributedbooleanOptional

returns payments with unattributed allocations if set to true

invoice_idstringOptionalformat: "uuid"

sourceslist of enumsOptional

source_internal_idstringOptional

sortenumOptional

Defaults to payment_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