Create non-insurance payer refund

POST

/api/non-insurance-payer-refunds/v1

POST

/api/non-insurance-payer-refunds/v1

import requests
url = "https://api.taigabilling.com/api/non-insurance-payer-refunds/v1"
payload = {
    "non_insurance_payer_id": "string",
    "amount_cents": 1,
    "allocations": [
        {
            "amount_cents": 1,
            "target": { "type": "service_line_by_id" }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "non_insurance_payer_refund_id": "string",
  "non_insurance_payer": {
    "non_insurance_payer_id": "string",
    "name": "Sunrise Foundation",
    "enabled": true,
    "clinical_trials": [
      {
        "clinical_trial_id": "string",
        "clinical_trial_number": "string",
        "is_active": true,
        "name": "string",
        "non_insurance_payer_id": "string",
        "clinical_trial_phase": "Phase 1"
      }
    ],
    "description": "string",
    "category": "string",
    "payer_id": "string",
    "address": {
      "address1": "string",
      "city": "string",
      "state": "AA",
      "zip_code": "string",
      "address2": "string",
      "zip_plus_four_code": "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",
  "check_number": "string",
  "refund_reason": "OVERCHARGED",
  "invoice_id": "string"
}

Creates a new non-insurance payer refund record and returns the newly created NonInsurancePayerRefund object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

non_insurance_payer_idstringRequiredformat: "uuid"

amount_centsintegerRequired

allocationslist of objectsRequired

invoice_idstring or nullOptionalformat: "uuid"

refund_timestampdatetime or nullOptional

refund_notestring or nullOptional

check_numberstring or nullOptional

refund_reasonenum or nullOptional

Allowed values:

Response

non_insurance_payer_refund_idstringformat: "uuid"

non_insurance_payerobject

amount_centsinteger

allocationslist of objects

refund_timestampdatetime or nullOptional

refund_notestring or nullOptional

check_numberstring or nullOptional

refund_reasonenum or nullOptional

Allowed values:

invoice_idstring or nullOptionalformat: "uuid"

Errors

404

Not Found Error

422

Unprocessable Entity Error