Beta

Get Multi

GET

/api/import-invoice/v1

GET

1 import datetime
2 
3 from candid import CandidApiClient
4 from candid.resources.commons import SortDirection
5 from candid.resources.invoices.resources.v_2 import (
6     InvoiceSortField,
7     InvoiceStatus,
8 )
9 
10 client = CandidApiClient(
11     client_id="YOUR_CLIENT_ID",
12     client_secret="YOUR_CLIENT_SECRET",
13 )
14 client.import_invoice.v_1.get_multi(
15     patient_external_id="string",
16     encounter_external_id="string",
17     note="string",
18     due_date_before=datetime.date.fromisoformat(
19         "2023-01-15",
20     ),
21     due_date_after=datetime.date.fromisoformat(
22         "2023-01-15",
23     ),
24     status=InvoiceStatus.DRAFT,
25     limit=1,
26     sort=InvoiceSortField.CREATED_AT,
27     sort_direction=SortDirection.ASC,
28     page_token="eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
29 )

Play

200Retrieved

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

Returns all Invoices for the authenticated user’s organziation with all filters applied.

Query parameters

patient_external_idstringOptional

encounter_external_idstringOptional

notestringOptional

partial match supported

due_date_beforedateOptional

all invoices whose due date is before this due date, not inclusive

due_date_afterdateOptional

all invoices whose due date is after this due date, not inclusive

statusenumOptional

all invoices that match any of the provided statuses

limitintegerOptional

Defaults to 100

sortenumOptional

Defaults to created_at

sort_directionenumOptional

Sort direction. Defaults to descending order

Allowed values:

page_tokenstringOptional

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Headers

Query parameters

Response