JOjoincandidhealth
v1

Create non-insurance payer refund

Changed on

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.

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

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/non-insurance-payer-refunds/v1
  • Auth
    HTTP bearer

Request body

non_insurance_payer_idstring uuid required
invoice_idstring uuid
amount_centsinteger required
refund_timestampstring date-time
refund_notestring
check_numberstring
refund_reason'OVERCHARGED' | 'ENTERED_IN_ERROR' | 'TRANSFER'

Response

Response with status 200

non_insurance_payer_refund_idstring uuid required
amount_centsinteger required
refund_timestampstring date-time
refund_notestring
check_numberstring
refund_reason'OVERCHARGED' | 'ENTERED_IN_ERROR' | 'TRANSFER'
invoice_idstring uuid

Changes

  • 24b2d80d577aRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id create removed and replaced with v1_create_19