Edit a billing line
curl --request PATCH \
--url https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"description": "<string>",
"costBilled": "<string>",
"amountPaid": "<string>",
"paidDate": "2023-12-25"
}
'import requests
url = "https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}"
payload = {
"description": "<string>",
"costBilled": "<string>",
"amountPaid": "<string>",
"paidDate": "2023-12-25"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
costBilled: '<string>',
amountPaid: '<string>',
paidDate: '2023-12-25'
})
};
fetch('https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}', 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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}",
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([
'description' => '<string>',
'costBilled' => '<string>',
'amountPaid' => '<string>',
'paidDate' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"costBilled\": \"<string>\",\n \"amountPaid\": \"<string>\",\n \"paidDate\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"costBilled\": \"<string>\",\n \"amountPaid\": \"<string>\",\n \"paidDate\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"costBilled\": \"<string>\",\n \"amountPaid\": \"<string>\",\n \"paidDate\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appointmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "VISIT_FEE",
"description": "<string>",
"costBilled": "<string>",
"amountPaid": "<string>",
"paidDate": "2023-12-25",
"prescriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}Med Billing
Edit a billing line
Requires a provider-scoped key (cxpp_) at STANDARD tier. Firm and admin keys receive 403 wrong_scope. Restricted-access practices receive 403 restricted_access. Supplying a medReferralId that belongs to another practice is refused as 404 not_found.
PATCH
/
med-cases
/
{caseId}
/
appointments
/
{appointmentId}
/
billable-events
/
{eventId}
Edit a billing line
curl --request PATCH \
--url https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"description": "<string>",
"costBilled": "<string>",
"amountPaid": "<string>",
"paidDate": "2023-12-25"
}
'import requests
url = "https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}"
payload = {
"description": "<string>",
"costBilled": "<string>",
"amountPaid": "<string>",
"paidDate": "2023-12-25"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
costBilled: '<string>',
amountPaid: '<string>',
paidDate: '2023-12-25'
})
};
fetch('https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}', 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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}",
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([
'description' => '<string>',
'costBilled' => '<string>',
'amountPaid' => '<string>',
'paidDate' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"costBilled\": \"<string>\",\n \"amountPaid\": \"<string>\",\n \"paidDate\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"costBilled\": \"<string>\",\n \"amountPaid\": \"<string>\",\n \"paidDate\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/med-cases/{caseId}/appointments/{appointmentId}/billable-events/{eventId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"costBilled\": \"<string>\",\n \"amountPaid\": \"<string>\",\n \"paidDate\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appointmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "VISIT_FEE",
"description": "<string>",
"costBilled": "<string>",
"amountPaid": "<string>",
"paidDate": "2023-12-25",
"prescriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.
Path Parameters
Med case UUID
Appointment UUID
Billing line UUID
Body
application/json
Partial update. kind is immutable.
Required string length:
1 - 500Decimal string, e.g. "150.00". Strings, not numbers — matches the billing webhooks. Up to 8 integer digits (decimal(10,2) ceiling).
Pattern:
^\d{1,8}(\.\d{1,2})?$Decimal string, e.g. "150.00". Strings, not numbers — matches the billing webhooks. Up to 8 integer digits (decimal(10,2) ceiling).
Pattern:
^\d{1,8}(\.\d{1,2})?$
