Skip to main content
Get a single invoice
curl --request GET \
  --url https://api.splose.com/v1/invoices/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "invoiceNumber": "INV-0001",
  "issueDate": "2023-07-30T09:00:00.000Z",
  "dueDate": "2023-07-30T09:00:00.000Z",
  "patientId": 1,
  "contactId": 1,
  "locationId": 1,
  "practitionerId": 1,
  "extraBillingInfo": "Some extra info",
  "subtotal": 193.99,
  "taxStatus": "excluding",
  "tax": 0,
  "total": 193.99,
  "paidAmount": 193.99,
  "status": "Paid",
  "invoiceItems": [
    {
      "id": 1,
      "type": "appointment",
      "typeId": 1,
      "code": 1234567,
      "description": "Wed 30 Aug 2023, 09:00am - Initial Assessment",
      "unitPrice": 193.99,
      "quantity": 0.5,
      "discount": "$20.00",
      "taxType": "STANDARD",
      "taxRate": 10
    }
  ],
  "paymentIds": [
    1
  ],
  "referenceNumbers": [
    "Medicare: 12345678"
  ],
  "isArchived": false,
  "reference": "Some references",
  "description": "Some description",
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required
Required range: x > 0
Example:

1

Response

200 - application/json

Object with invoice data.

​
id
integer
required

Invoice id

Required range: x > 0
Example:

1

​
invoiceNumber
string
required

Invoice number

Example:

"INV-0001"

​
issueDate
required

Invoice issue date time

Example:

"2023-07-30T09:00:00.000Z"

​
dueDate
required

Invoice due date time

Example:

"2023-07-30T09:00:00.000Z"

​
patientId
integer
required

The invoice patient id

Required range: x > 0
Example:

1

​
contactId
integer | null
required

The invoice contact id

Required range: x > 0
Example:

1

​
locationId
integer
required

The invoice location id

Required range: x > 0
Example:

1

​
practitionerId
integer | null
required

The invoice practitioner id

Required range: x > 0
Example:

1

​
extraBillingInfo
string | null
required

Invoice extra billing info

Example:

"Some extra info"

​
subtotal
number | null
required

Invoice subtotal amount

Example:

193.99

​
taxStatus
enum<string>
required

Invoice tax status

Available options:
including,
excluding,
no tax
Example:

"excluding"

​
tax
number | null
required

Invoice tax amount

Example:

0

​
total
number | null
required

Invoice total amount

Example:

193.99

​
paidAmount
number | null
required

Invoice paid amount

Example:

193.99

​
status
enum<string>
required

Invoice status

Available options:
Draft,
Awaiting Payment,
Paid
Example:

"Paid"

​
invoiceItems
object[]
required
​
paymentIds
integer[]
required
​
referenceNumbers
string[] | null
required

Invoice provider numbers

Example:
["Medicare: 12345678"]
​
reference
string | null
required

Invoice reference

Example:

"Some references"

​
description
string | null
required

Invoice description

Example:

"Some description"

​
isArchived
boolean | null
default:false

Whether the invoice is archvied

​
createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

​
updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"