{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_patient-payments.subpackage_patient-payments/v4 API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_patient-payments.subpackage_patient-payments/v4",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get patient payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/api/patient-payments/v4",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Defaults to 100. The value must be greater than 0 and less than 1000."
              },
              {
                "name": "patient_external_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "claim_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "service_line_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "billing_provider_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "unattributed",
                "value": "",
                "type": "query",
                "description": "returns payments with unattributed allocations if set to true"
              },
              {
                "name": "invoice_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "sources",
                "value": "",
                "type": "query"
              },
              {
                "name": "source_internal_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Defaults to payment_timestamp"
              },
              {
                "name": "sort_direction",
                "value": "",
                "type": "query",
                "description": "Sort direction. Defaults to descending order if not provided."
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns all patient payments satisfying the search criteria AND whose organization_id matches\nthe current organization_id of the authenticated user."
        },
        {
          "info": {
            "name": "Create patient payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pre-api.joincandidhealth.com/api/patient-payments/v4",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new patient payment record and returns the newly created PatientPayment object.\nThe allocations can describe whether the payment is being applied toward a specific service line,\nclaim, or billing provider."
        },
        {
          "info": {
            "name": "Get patient payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/api/patient-payments/v4/:patient_payment_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "patient_payment_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a previously created patient payment by its `patient_payment_id`."
        },
        {
          "info": {
            "name": "Update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://pre-api.joincandidhealth.com/api/patient-payments/v4/:patient_payment_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "patient_payment_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the patient payment record matching the provided patient_payment_id."
        },
        {
          "info": {
            "name": "Delete patient payment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://pre-api.joincandidhealth.com/api/patient-payments/v4/:patient_payment_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "patient_payment_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deletes the patient payment record matching the provided patient_payment_id."
        }
      ]
    }
  ],
  "bundled": true
}