---
title: "Update"
method: PATCH
path: "/api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}"
tags: ["v1"]
---

# Update

`PATCH /api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}`

## Request

- Base URL: `https://pre-api.joincandidhealth.com`
- URL: `https://pre-api.joincandidhealth.com/api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}`
- Auth: HTTP bearer

## Path parameters

- `non_insurance_payer_payment_id` string, uuid, required

## Request body

- object
  - `payment_timestamp` string, date-time
  - `payment_note` union
    - object
      - `type` 'set', required: Discriminator value: set
      - `value` string, required
    - object
      - `type` 'remove', required: Discriminator value: remove
  - `invoice_id` union
    - object
      - `type` 'set', required: Discriminator value: set
      - `value` string, uuid, required
    - object
      - `type` 'remove', required: Discriminator value: remove

## Response `200`

Response with status 200

- NonInsurancePayerPaymentsV1NonInsurancePayerPayment
  - `non_insurance_payer_payment_id` string, uuid, required
  - `non_insurance_payer` NonInsurancePayersV1NonInsurancePayer, required
    - `non_insurance_payer_id` string, uuid, required
    - `name` string, required
    - `description` string
    - `category` string
    - `payer_id` string: The identifier used to route claims to this payer. Required in order to submit an 837 to this payer. Must be between 2 and 80 characters.
    - `enabled` boolean, required
    - `address` CommonsStreetAddressShortZip
      - `address1` string, required
      - `address2` string
      - `city` string, required
      - `state` 'AA' | 'AE' | 'AP' | 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'FM' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MH' | 'MI' | 'MN' | 'MP' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'PW' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VI' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'FC', required
      - `zip_code` string, required: 5-digit zip code
      - `zip_plus_four_code` string: 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4
    - `clinical_trials` ClinicalTrialsV1ClinicalTrial[], required
      - `name` string, required
      - `clinical_trial_number` string, required: Must be 8 characters long
      - `clinical_trial_phase` 'Phase 1' | 'Phase 2' | 'Phase 3'
      - `clinical_trial_id` string, uuid, required
      - `non_insurance_payer_id` string, uuid, required
      - `is_active` boolean, required
  - `amount_cents` integer, required
  - `check_number` string
  - `payment_timestamp` string, date-time
  - `payment_note` string
  - `allocations` FinancialsAllocation[], required
    - `allocation_id` string, uuid
    - `amount_cents` integer, required
    - `target` union, required: Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.
      - object
        - `type` 'service_line', required: Discriminator value: service_line
        - `service_line_id` string, uuid, required
        - `claim_id` string, uuid, required
        - `encounter_id` string, uuid, required
      - object
        - `type` 'claim', required: Discriminator value: claim
        - `claim_id` string, uuid, required
        - `encounter_id` string, uuid, required
      - object
        - `type` 'billing_provider_id', required: Discriminator value: billing_provider_id
        - `billing_provider_id` string, uuid, required
      - object
        - `type` 'appointment', required: Discriminator value: appointment
        - `appointment_id` string, required
        - `patient_external_id` string, required
      - object
        - `type` 'unattributed', required: Discriminator value: unattributed
    - `earmark` FinancialsBalanceEarmark: Represents an active balance earmarking record that holds allocated funds for future auto-allocation. Earmarks are created when funds are allocated but should be held for a specific encounter or date of service. Only active (non-deleted) earmarks are returned.
      - `id` string, uuid, required
      - `target` union, required: If enabled for your organization, defines how a patient prepayment allocation should be earmarked for future auto-allocation. Earmarks hold the allocation until a matching encounter is created, then attempt to allocate to that encounter. Only applicable for unattributed allocations.
        - object: Earmark for auto-allocation to an encounter with this specific date of service
          - `type` 'date_of_service', required: Discriminator value: date_of_service
          - `value` string, required: ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
        - object: Earmark for auto-allocation to an encounter with this specific external ID (more specific than date of service)
          - `type` 'external_encounter_id', required: Discriminator value: external_encounter_id
          - `value` string, required
      - `amount_earmarked_cents` integer: The amount earmarked in cents for future allocation
      - `created_by_allocation_id` string, uuid
    - `allocated_on` string, date-time
  - `invoice_id` string, uuid

## Other responses

- `404`: Error response with status 404
- `422`: Error response with status 422

## Changes

- **2026-09-17** `24b2d80d577a`: 1 breaking, 1 warning, 10 info
  - the response's body type changed from no type to `object` for status `200`
  - deleted the `header` request parameter `Authorization`
  - the endpoint scheme security `OAuthScheme` was added to the API
  - for the `path` request parameter `non_insurance_payer_payment_id`, the type was generalized from no type to `string`, and format from no format to `uuid`
  - …8 more
- **2026-09-12** `3a81ee81d4ed`: 1 info
  - api operation id `update` removed and replaced with `v1_update_17`

[Operation history](https://skmtc.dev/joincandidhealth/apis/api-reference/changes/api/non-insurance-payer-payments/v1/:non_insurance_payer_payment_id/patch.md)

---

[API](https://skmtc.dev/joincandidhealth/apis/api-reference.md) - [All operations](https://skmtc.dev/joincandidhealth/apis/api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/joincandidhealth/apis/api-reference/revisions/d8b0a61873e2?raw)