Update invoices
curl --request PATCH \
--url https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"practitioner_id": 123,
"invoice_date": "2023-12-25",
"note": "<string>",
"line_items": [
{
"description": "<string>",
"quantity": 123,
"price": 123,
"id": 123,
"billable_item_id": 123,
"provider_id": 123
}
],
"metadata": {}
}
'import requests
url = "https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}"
payload = {
"practitioner_id": 123,
"invoice_date": "2023-12-25",
"note": "<string>",
"line_items": [
{
"description": "<string>",
"quantity": 123,
"price": 123,
"id": 123,
"billable_item_id": 123,
"provider_id": 123
}
],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
practitioner_id: 123,
invoice_date: '2023-12-25',
note: '<string>',
line_items: [
{
description: '<string>',
quantity: 123,
price: 123,
id: 123,
billable_item_id: 123,
provider_id: 123
}
],
metadata: {}
})
};
fetch('https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}', 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://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'practitioner_id' => 123,
'invoice_date' => '2023-12-25',
'note' => '<string>',
'line_items' => [
[
'description' => '<string>',
'quantity' => 123,
'price' => 123,
'id' => 123,
'billable_item_id' => 123,
'provider_id' => 123
]
],
'metadata' => [
]
]),
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://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}"
payload := strings.NewReader("{\n \"practitioner_id\": 123,\n \"invoice_date\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"line_items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"id\": 123,\n \"billable_item_id\": 123,\n \"provider_id\": 123\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"practitioner_id\": 123,\n \"invoice_date\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"line_items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"id\": 123,\n \"billable_item_id\": 123,\n \"provider_id\": 123\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"practitioner_id\": 123,\n \"invoice_date\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"line_items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"id\": 123,\n \"billable_item_id\": 123,\n \"provider_id\": 123\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"appointment_id": "<string>",
"practitioner_id": 123,
"location_id": "<string>",
"patient_id": 123,
"total": "<string>",
"third_party": "<string>",
"updated": "<string>",
"created": "<string>",
"number": "<string>",
"state": "<string>",
"type": "<string>",
"invoice_date": "2023-12-25",
"note": "<string>",
"subtotal": "<string>",
"balance": "<string>",
"patient_balance": "<string>",
"third_party_balance": "<string>",
"metadata": {}
}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}Invoices
Update invoices
PATCH
https://{clinic}.{region}.practicehub.io/v3/api
/
invoices
/
{id}
Update invoices
curl --request PATCH \
--url https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"practitioner_id": 123,
"invoice_date": "2023-12-25",
"note": "<string>",
"line_items": [
{
"description": "<string>",
"quantity": 123,
"price": 123,
"id": 123,
"billable_item_id": 123,
"provider_id": 123
}
],
"metadata": {}
}
'import requests
url = "https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}"
payload = {
"practitioner_id": 123,
"invoice_date": "2023-12-25",
"note": "<string>",
"line_items": [
{
"description": "<string>",
"quantity": 123,
"price": 123,
"id": 123,
"billable_item_id": 123,
"provider_id": 123
}
],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
practitioner_id: 123,
invoice_date: '2023-12-25',
note: '<string>',
line_items: [
{
description: '<string>',
quantity: 123,
price: 123,
id: 123,
billable_item_id: 123,
provider_id: 123
}
],
metadata: {}
})
};
fetch('https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}', 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://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'practitioner_id' => 123,
'invoice_date' => '2023-12-25',
'note' => '<string>',
'line_items' => [
[
'description' => '<string>',
'quantity' => 123,
'price' => 123,
'id' => 123,
'billable_item_id' => 123,
'provider_id' => 123
]
],
'metadata' => [
]
]),
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://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}"
payload := strings.NewReader("{\n \"practitioner_id\": 123,\n \"invoice_date\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"line_items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"id\": 123,\n \"billable_item_id\": 123,\n \"provider_id\": 123\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"practitioner_id\": 123,\n \"invoice_date\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"line_items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"id\": 123,\n \"billable_item_id\": 123,\n \"provider_id\": 123\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{clinic}.{region}.practicehub.io/v3/api/invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"practitioner_id\": 123,\n \"invoice_date\": \"2023-12-25\",\n \"note\": \"<string>\",\n \"line_items\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"price\": 123,\n \"id\": 123,\n \"billable_item_id\": 123,\n \"provider_id\": 123\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"appointment_id": "<string>",
"practitioner_id": 123,
"location_id": "<string>",
"patient_id": 123,
"total": "<string>",
"third_party": "<string>",
"updated": "<string>",
"created": "<string>",
"number": "<string>",
"state": "<string>",
"type": "<string>",
"invoice_date": "2023-12-25",
"note": "<string>",
"subtotal": "<string>",
"balance": "<string>",
"patient_balance": "<string>",
"third_party_balance": "<string>",
"metadata": {}
}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}Authorizations
API key from Developers → API Keys, sent as Authorization: Bearer .
Path Parameters
Body
application/json
Maximum string length:
500Show child attributes
Show child attributes
Integrator-owned key/value metadata (max 50 keys). Values are strings (≤500 chars), numbers or booleans and read back with the type they were written with. On write, a null value removes the key. Filter with metadata[key]=op:value; number operands compare numerically.
Show child attributes
Show child attributes
Response
The resource
Show child attributes
Show child attributes
Was this page helpful?
⌘I