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"
}
'

import requests

url = "https://api.splose.com/v1/payments"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.splose.com/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.splose.com/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.splose.com/v1/payments"

	payload := strings.NewReader("{\n  \"patientId\": 1,\n  \"locationId\": 1,\n  \"paymentMethodId\": 1,\n  \"amount\": 193.99,\n  \"paymentDate\": \"2024-03-01T00:00:00.000Z\",\n  \"paymentInvoices\": [\n    {\n      \"invoiceId\": 1,\n      \"amount\": 193.99,\n      \"xeroId\": \"<string>\"\n    }\n  ],\n  \"xeroId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.splose.com/v1/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"patientId\": 1,\n  \"locationId\": 1,\n  \"paymentMethodId\": 1,\n  \"amount\": 193.99,\n  \"paymentDate\": \"2024-03-01T00:00:00.000Z\",\n  \"paymentInvoices\": [\n    {\n      \"invoiceId\": 1,\n      \"amount\": 193.99,\n      \"xeroId\": \"<string>\"\n    }\n  ],\n  \"xeroId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.splose.com/v1/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"patientId\": 1,\n  \"locationId\": 1,\n  \"paymentMethodId\": 1,\n  \"amount\": 193.99,\n  \"paymentDate\": \"2024-03-01T00:00:00.000Z\",\n  \"paymentInvoices\": [\n    {\n      \"invoiceId\": 1,\n      \"amount\": 193.99,\n      \"xeroId\": \"<string>\"\n    }\n  ],\n  \"xeroId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": null,
  "archived": false
}

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"
}
'

import requests

url = "https://api.splose.com/v1/payments"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.splose.com/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.splose.com/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.splose.com/v1/payments"

	payload := strings.NewReader("{\n  \"patientId\": 1,\n  \"locationId\": 1,\n  \"paymentMethodId\": 1,\n  \"amount\": 193.99,\n  \"paymentDate\": \"2024-03-01T00:00:00.000Z\",\n  \"paymentInvoices\": [\n    {\n      \"invoiceId\": 1,\n      \"amount\": 193.99,\n      \"xeroId\": \"<string>\"\n    }\n  ],\n  \"xeroId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.splose.com/v1/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"patientId\": 1,\n  \"locationId\": 1,\n  \"paymentMethodId\": 1,\n  \"amount\": 193.99,\n  \"paymentDate\": \"2024-03-01T00:00:00.000Z\",\n  \"paymentInvoices\": [\n    {\n      \"invoiceId\": 1,\n      \"amount\": 193.99,\n      \"xeroId\": \"<string>\"\n    }\n  ],\n  \"xeroId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.splose.com/v1/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"patientId\": 1,\n  \"locationId\": 1,\n  \"paymentMethodId\": 1,\n  \"amount\": 193.99,\n  \"paymentDate\": \"2024-03-01T00:00:00.000Z\",\n  \"paymentInvoices\": [\n    {\n      \"invoiceId\": 1,\n      \"amount\": 193.99,\n      \"xeroId\": \"<string>\"\n    }\n  ],\n  \"xeroId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": null,
  "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

Show child attributes

xeroId

string<uuid>

Xero batch payment id, only applicable for Xero batch payment

Response

200 - application/json

Object with payment data.

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

Show child attributes

creditAllocations

object[]

required

Credit allocated to invoices

Show child attributes

Example:

[]

xeroId

string<uuid> | null

required

Xero batch payment id

archivedAt

required

Payment archive date time

Example:

null

archived

boolean | null

default:false

Whether the payment has been archived

Get a paged array of payments Get a single payment

Get started

API Reference

Create single payment for specific invoice

Authorizations

Body

Response