Update | Candid | API Reference

curl -X PATCH https://api.joincandidhealth.com/api/non-insurance-payer-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "non_insurance_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "non_insurance_payer": {
    "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "name": "name",
    "enabled": true,
    "clinical_trials": [
      {
        "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "clinical_trial_number": "clinical_trial_number",
        "is_active": true,
        "name": "name",
        "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "clinical_trial_phase": "Phase 1"
      },
      {
        "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "clinical_trial_number": "clinical_trial_number",
        "is_active": true,
        "name": "name",
        "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "clinical_trial_phase": "Phase 1"
      }
    ],
    "description": "description",
    "category": "category",
    "address": {
      "address1": "address1",
      "city": "city",
      "state": "AA",
      "zip_code": "zip_code",
      "address2": "address2",
      "zip_plus_four_code": "zip_plus_four_code"
    }
  },
  "amount_cents": 1,
  "allocations": [
    {
      "amount_cents": 1,
      "target": {
        "type": "service_line",
        "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      },
      "earmark": {
        "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "target": {
          "type": "date_of_service",
          "value": "target"
        },
        "amount_earmarked_cents": 1,
        "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      },
      "allocated_on": "2024-01-15T09:30:00Z"
    },
    {
      "amount_cents": 1,
      "target": {
        "type": "service_line",
        "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      },
      "earmark": {
        "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "target": {
          "type": "date_of_service",
          "value": "target"
        },
        "amount_earmarked_cents": 1,
        "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      },
      "allocated_on": "2024-01-15T09:30:00Z"
    }
  ],
  "refund_timestamp": "2024-01-15T09:30:00Z",
  "refund_note": "refund_note",
  "check_number": "check_number",
  "refund_reason": "OVERCHARGED",
  "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}

Updates the non-insurance payer refund record matching the provided non_insurance_payer_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

non_insurance_payer_refund_idUUIDRequired

Request

This endpoint expects an object.

refund_timestampdatetimeOptional

refund_noteobjectOptional

refund_reasonobjectOptional

invoice_idobjectOptional

Response

This endpoint returns an object.

non_insurance_payer_refund_idUUID

non_insurance_payerobject

amount_centsinteger

allocationslist of objects

refund_timestampdatetime

refund_notestring

check_numberstring

refund_reasonenum

Allowed values:

invoice_idUUID

Errors

404

Entity Not Found Error

422

Unprocessable Entity Error