Update

Beta

PATCH

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.

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_timestampdatetimeOptional

refund_notestringOptional

refund_reason"OVERCHARGED"Optional

Allowed values: OVERCHARGED

invoice_idUUIDOptional

Errors

PATCH

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

1 {
2   "non_insurance_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "non_insurance_payer": {
4     "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5     "name": "string",
6     "enabled": true,
7     "description": "string",
8     "category": "string"
9   },
10   "amount_cents": 0,
11   "allocations": [
12     {
13       "amount_cents": 0,
14       "target": {
15         "type": "service_line",
16         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
19       }
20     }
21   ],
22   "refund_timestamp": "2023-01-01T00:00:00Z",
23   "refund_note": "string",
24   "refund_reason": "OVERCHARGED",
25   "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
26 }

Built with

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

1	{
2	"non_insurance_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3	"non_insurance_payer": {
4	"non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"name": "string",
6	"enabled": true,
7	"description": "string",
8	"category": "string"
9	},
10	"amount_cents": 0,
11	"allocations": [
12	{
13	"amount_cents": 0,
14	"target": {
15	"type": "service_line",
16	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
19	}
20	}
21	],
22	"refund_timestamp": "2023-01-01T00:00:00Z",
23	"refund_note": "string",
24	"refund_reason": "OVERCHARGED",
25	"invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
26	}