Get a paged array of invoices

curl --request GET \
  --url https://api.splose.com/v1/invoices \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "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"
      ],
      "reference": "Some references",
      "description": "Some description",
      "isArchived": false,
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

GET

invoices

curl --request GET \
  --url https://api.splose.com/v1/invoices \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "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"
      ],
      "reference": "Some references",
      "description": "Some description",
      "isArchived": false,
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

id_gt

integer | null

The starting object id of the next page

Example:

200

id_lt

integer | null

The starting object id of the previous page

Example:

100

update_gt

Search for objects updated after this date time

Example:

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

update_lt

Search for objects updated before this date time

Example:

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

include_archived

enum<string> | null

default:false

Whether archived objects should be retrieved, default is false

Available options:

true,

false

patientId

number | null

Search for Invoices of this patient

Example:

1

locationId

number | null

Search for Invoices created at this location

Example:

1

practitionerId

number | null

Search for Invoices created by this practitioner

Example:

1

status

enum<string> | null

Search for invoices of this status

Available options:

Draft,

Awaiting Payment,

Paid

Example:

"Paid"

Response

200 - application/json

A paged array of invoices

data

object[]

required

Show child attributes

data.id

integer

required

Invoice id

Required range: x > 0

Example:

1

data.invoiceNumber

string

required

Invoice number

Example:

"INV-0001"

data.issueDate

required

Invoice issue date time

Example:

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

data.dueDate

required

Invoice due date time

Example:

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

data.patientId

integer

required

The invoice patient id

Required range: x > 0

Example:

1

data.contactId

integer | null

required

The invoice contact id

Required range: x > 0

Example:

1

data.locationId

integer

required

The invoice location id

Required range: x > 0

Example:

1

data.practitionerId

integer | null

required

The invoice practitioner id

Required range: x > 0

Example:

1

data.extraBillingInfo

string | null

required

Invoice extra billing info

Example:

"Some extra info"

data.subtotal

number | null

required

Invoice subtotal amount

Example:

193.99

data.taxStatus

enum<string>

required

Invoice tax status

Available options:

including,

excluding,

no tax

Example:

"excluding"

data.tax

number | null

required

Invoice tax amount

Example:

0

data.total

number | null

required

Invoice total amount

Example:

193.99

data.paidAmount

number | null

required

Invoice paid amount

Example:

193.99

data.status

enum<string>

required

Invoice status

Available options:

Draft,

Awaiting Payment,

Paid

Example:

"Paid"

data.invoiceItems

object[]

required

Show child attributes

data.invoiceItems.id

integer

required

Invoice item id

Required range: x > 0

Example:

1

data.invoiceItems.type

enum<string>

required

Invoice item type

Available options:

appointment,

supportActivity,

supportItem,

service,

productStock,

custom,

GiftVoucher

Example:

"appointment"

data.invoiceItems.typeId

integer | null

required

Invoice item object id

Required range: x > 0

Example:

1

data.invoiceItems.code

string | null

required

Invoice item code

Example:

1234567

data.invoiceItems.description

string | null

required

Invoice item description

Example:

"Wed 30 Aug 2023, 09:00am - Initial Assessment"

data.invoiceItems.unitPrice

number | null

required

Invoice item unit price, in dollar

Example:

193.99

data.invoiceItems.quantity

number | null

required

Invoice item quantity

Example:

0.5

data.invoiceItems.discount

string | null

required

Invoice item discount, in dollar or percentage

Example:

"$20.00"

data.invoiceItems.taxType

required

Tax type, check Splose support for more info

Available options:

STANDARD,

ZERO,

EXEMPT,

REDUCED

Example:

"STANDARD"

data.invoiceItems.taxRate

number | null

required

Tax rate, in percentage

Example:

10

data.paymentIds

integer[]

required

Required range: x > 0

data.referenceNumbers

string[] | null

required

Invoice provider numbers

Example:

["Medicare: 12345678"]

data.reference

string | null

required

Invoice reference

Example:

"Some references"

data.description

string | null

required

Invoice description

Example:

"Some description"

data.isArchived

boolean | null

default:false

Whether the invoice is archvied

data.createdAt

Object creation date time

Example:

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

data.updatedAt

Object update date time

Example:

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

links

object

required

Show child attributes

links.previousPage

string

The link to retrieve next page

Example:

"/v1/${object_type}?id_gt=200"

links.nextPage

string

The link to retrieve previous page

Example:

"/v1/${object_type}?id_lt=100"

Update single support-item Get a single invoice

⌘I

Get started

API Reference

Get a paged array of invoices

Authorizations

Query Parameters

Response