Skip to main content
Create single payment for specific invoice
curl --request POST \
  --url https://api.splose.com/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "patientId": 1,
  "locationId": 1,
  "paymentMethodId": 1,
  "amount": 193.99,
  "paymentDate": "2024-03-01T00:00:00.000Z",
  "paymentInvoices": [
    {
      "invoiceId": 1,
      "amount": 193.99,
      "xeroId": "<string>"
    }
  ],
  "xeroId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "id": 1,
  "paymentNumber": "RCPT-0001",
  "amount": 193.99,
  "patientId": 1,
  "locationId": 1,
  "paymentMethodId": 1,
  "paymentDate": "2023-07-30T09:00:00.000Z",
  "paymentInvoices": [
    {
      "invoiceId": 1,
      "amount": 193.99,
      "xeroId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "creditAllocations": [],
  "xeroId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archivedAt": "<string>",
  "archived": false
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
patientId
integer
required

Patient id

Required range: x > 0
Example:

1

​
locationId
integer
required

Location id

Required range: x > 0
Example:

1

​
paymentMethodId
integer
required

Payment method id

Required range: x > 0
Example:

1

​
amount
number | null
required

Total payment amount, it should be the same as the sum of all paymentInvoice amount

Example:

193.99

​
paymentDate
required

Payment date

Example:

"2024-03-01T00:00:00.000Z"

​
paymentInvoices
object[]
required

Payments made to invoices

​
xeroId
string<uuid>

Xero batch payment id, only applicable for Xero batch payment

Response

200 - application/json

Object with payment data.

​
id
integer
required

Payment id

Required range: x > 0
Example:

1

​
paymentNumber
string
required

Payment number

Example:

"RCPT-0001"

​
amount
number | null
required

Total payment amount. 0 for credit allocation

Example:

193.99

​
patientId
integer
required

The payment patient id

Required range: x > 0
Example:

1

​
locationId
integer
required

The payment location id

Required range: x > 0
Example:

1

​
paymentMethodId
integer | null
required

The payment method id, null for credit allocation

Required range: x > 0
Example:

1

​
paymentDate
required

Payment date

Example:

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

​
paymentInvoices
object[]
required

Payments made to invoices

​
creditAllocations
object[]
required

Credit allocated to invoices

Example:
[]
​
xeroId
string<uuid> | null
required

Xero batch payment id

​
archivedAt
required

Payment archive date time

​
archived
boolean | null
default:false

Whether the payment has been archived