Invoices

Get a single invoice

Retrieves an invoice's information under the current practitioner.

GET /invoices/:invoiceId

URL Parameters

Parameter	Description
invoiceId	The invoice's record ID

curl "https://partner-staging.i-screen.com.au/v1/invoices/610ad1070ae7ef00115c0a25" \
  -H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"

Response

{
  "_id": "66277f5819ffc6c9456e605c",
  "amount": 180.34,
  "invoiceNumber": "INV022254",
  "createdAt": "2024-04-23T09:28:56.451Z",
  "updatedAt": "2024-04-23T09:28:56.451Z",
  "paidAt": "2024-04-23T09:29:17.211Z",
  "tests": [
    {
      "_id": "66277f6d19ffc6c9456e60be",
      "status": "pending",
      "product": "Adrenal Stress Check",
      "testNumber": "00105529",
      "createdAt": "2024-04-23T09:29:17.198Z",
      "updatedAt": "2024-04-23T09:29:17.198Z",
      "patientId": "604705f9d1705600187a36d7"
    }
  ],
  "link": "https://practitioner.i-screen.com.au/invoice/66277f5819ffc6c9456e605c",
  "patientId": "604705f9d1705600187a36d7",
  "status": "settled"
}

---

Get multiple invoices

Retrieves multiple invoices under the current practitioner.

GET /invoices

Query Parameters

Parameter	Required	Default	Description
skip	No	0	Number of records to skip
limit	No	10	Max records to retrieve (max: 100)
invoiceNumber	No	-	Filter by invoice number
patientId	No	-	Filter by patient ID
status	No	-	Filter by status: active, settled, cancelled, expired

curl "https://partner-staging.i-screen.com.au/v1/invoices?patientId=610ad2a60ae7ef00115c0aa3" \
  -H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"

Response

{
  "total": 3,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "6214ddb936f3e20010995f72",
      "amount": 0.39,
      "invoiceNumber": "INV004900",
      "createdAt": "2022-02-22T12:57:29.514Z",
      "updatedAt": "2022-02-22T12:57:29.514Z",
      "paidAt": "2022-02-24T12:27:00.665Z",
      "link": "https://practitioner.i-screen.com.au/invoice/6214ddb936f3e20010995f72",
      "patientId": "610ad2a60ae7ef00115c0aa3",
      "status": "settled"
    }
  ]
}

---

Create a new invoice

Creates a new referral invoice for a given patient.

POST /invoices

note

Once the invoice is created, a notification email is always sent to the patient with a link to the invoice page for them to view and settle online. There is no separate email when the patient actually settles the invoice, that side of the flow only notifies the practitioner.

Payload

Parameter	Required	Description
patientId string	Yes	The patient's record ID
productIds array	Yes	The product ID(s) to order

curl -X POST https://partner-staging.i-screen.com.au/v1/invoices \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"

Payload

{
  "patientId": "623c1b54b3d2906cecc3f803",
  "productIds": ["59770901cca022000fd1c4fa", "59770901cca022000fd1c4f1"]
}

Response

{
  "_id": "6243cb56061c1c51a493903c",
  "invoiceNumber": "INV005176",
  "amount": 485.5,
  "createdAt": "2022-03-30T03:15:34.501Z",
  "updatedAt": "2022-03-30T03:15:34.501Z",
  "link": "https://practitioner.i-screen.com.au/invoice/6243cb56061c1c51a493903c",
  "patientId": "623c1b54b3d2906cecc3f803",
  "status": "active"
}

---

Cancel an invoice

Cancels an active invoice under the current practitioner.

DELETE /invoices/:invoiceId

warning

Cancelling an invoice stops reminder emails from being sent to the patient.

URL Parameters

Parameter	Description
invoiceId	The invoice's record ID

curl -X DELETE https://partner-staging.i-screen.com.au/v1/invoices/61f5fd2a46dd400012e8b8f9 \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"

Response

{
  "_id": "61f5fd2a46dd400012e8b8f9",
  "amount": 0.39,
  "invoiceNumber": "INV004540",
  "createdAt": "2022-01-30T02:51:22.930Z",
  "updatedAt": "2022-01-30T02:51:22.932Z",
  "cancelledAt": "2022-01-30T03:04:38.465Z",
  "link": "https://practitioner.i-screen.com.au/invoice/61f5fd2a46dd400012e8b8f9",
  "patientId": "610ad2a60ae7ef00115c0aa3",
  "status": "cancelled"
}