Get

Beta

GET

/api/import-invoice/v1/:invoice_id

Retrieve and view an import invoice

Path parameters

invoice_idUUIDRequired

InvoiceId to be returned

Response

This endpoint returns an object.

idUUID

created_atdatetime

updated_atdatetime

itemsobject

The InvoiceItem rollup which contains all claim and service line invoice items

patient_external_idstring

external_customer_identifierstring

Id of the customer in the source system

statusenum

external_identifierstring

Id of the invoice being imported in the source system

due_datedate

amount_centsinteger

Total monetary amount (in cents) of all Invoice Items

notestringOptional

customer_invoice_urlstringOptional

Link to the patient view of the invoice in the third-party service

Errors

GET

1 curl https://api.joincandidhealth.com/api/import-invoice/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>"

1 {
2   "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "created_at": "2023-01-01T00:00:00Z",
4   "updated_at": "2023-01-01T00:00:00Z",
5   "items": {
6     "claim_invoice_items": {
7       "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": {
8         "service_line_invoice_items": {
9           "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": {
10             "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
11             "amount_cents": 0
12           }
13         },
14         "claim_invoice_item": {
15           "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16           "amount_cents": 0
17         }
18       }
19     },
20     "unattributed_items": [
21       {
22         "amount_cents": 0
23       }
24     ]
25   },
26   "patient_external_id": "string",
27   "external_customer_identifier": "string",
28   "status": "DRAFT",
29   "external_identifier": "string",
30   "due_date": "2023-01-01",
31   "amount_cents": 0,
32   "note": "string",
33   "customer_invoice_url": "string"
34 }

Built with

1	curl https://api.joincandidhealth.com/api/import-invoice/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2	-H "Authorization: Bearer <token>"

1	{
2	"id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3	"created_at": "2023-01-01T00:00:00Z",
4	"updated_at": "2023-01-01T00:00:00Z",
5	"items": {
6	"claim_invoice_items": {
7	"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": {
8	"service_line_invoice_items": {
9	"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": {
10	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
11	"amount_cents": 0
12	}
13	},
14	"claim_invoice_item": {
15	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16	"amount_cents": 0
17	}
18	}
19	},
20	"unattributed_items": [
21	{
22	"amount_cents": 0
23	}
24	]
25	},
26	"patient_external_id": "string",
27	"external_customer_identifier": "string",
28	"status": "DRAFT",
29	"external_identifier": "string",
30	"due_date": "2023-01-01",
31	"amount_cents": 0,
32	"note": "string",
33	"customer_invoice_url": "string"
34	}