> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server.

# Invoice Itemization

GET https://api.joincandidhealth.com/api/patient-ar/v1/invoice-itemization/{claim_id}

Provides detailed itemization of invoice data for a specific claim.

Reference: https://docs.joincandidhealth.com/api-reference/patient-collections/patient-ar/v-1/itemize

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://api.joincandidhealth.com` (Production, default)
- `https://api-staging.joincandidhealth.com` (Staging)
- `https://sandbox-api.joincandidhealth.com` (CandidSandbox)
- `https://staging-api.joincandidhealth.com` (CandidStaging)
- `http://localhost:5050` (Local)

## Request

### Path parameters

- `claim_id` (UUID, required)

## Response

### 200

- `claim_id` (UUID, required) — The ID of the claim associated with the invoice itemization.
- `patient_balance_cents` (integer, required) — The total patient balance in cents for the claim. Negative values indicate a credit balance.
- `claim_level_patient_payments` (PatientPaymentInfo, required)
- `service_line_itemization` (list of ServiceLineItemization, required) — A list of service line itemizations for the claim.
- `organization_service_facility_id` (UUID, optional) — The organization service facility ID from the claim's encounter.

## Errors

### 404 Entity Not Found Error

- `errorName` ("EntityNotFoundError", required)
- `content` (EntityNotFoundErrorMessage, required)

### 403 Unauthorized Error

- `errorName` ("UnauthorizedError", required)
- `content` (UnauthorizedErrorMessage, required)

## Types

### PatientPaymentInfo

- `total_payment_cents` (integer, required) — The total amount of patient payments in cents for the service line.
- `items` (list of PatientPaymentAllocation, required) — A list of patient payment items associated with the service line.

### ServiceLineItemization

- `service_line_id` (UUID, required) — The ID of the service line.
- `procedure_code` (string, required) — The procedure code (CPT/HCPCS) associated with the service line.
- `date_of_service` (date, required) — The date of service for the service line.
- `patient_balance_cents` (integer, required) — The total patient balance in cents for the service line. Negative values indicate a credit balance.
- `charge_amount_cents` (integer, required) — The total charge amount in cents for the service line.
- `insurance_adjustments` (InsuranceAdjustmentInfo, required)
- `insurance_payments` (InsurancePaymentInfo, required)
- `non_insurance_adjustments` (NonInsuranceAdjustmentInfo, required)
- `non_insurance_payments` (NonInsurancePaymentInfo, required)
- `patient_adjustments` (PatientAdjustmentInfo, required)
- `patient_payments` (PatientPaymentInfo, required)
- `copay_cents` (integer, required) — The copay amount in cents for the service line.
- `coinsurance_cents` (integer, required) — The coinsurance amount in cents for the service line.
- `deductible_cents` (integer, required) — The deductible amount in cents for the service line.

### EntityNotFoundErrorMessage

- `id` (string, required)

### UnauthorizedErrorMessage

- `message` (string, optional)

### PatientPaymentAllocation

- `amount_cents` (integer, required) — The amount of the patient payment in cents.
- `source_id` (string, optional) — Payment identifier from the source system (e.g., patient portal, manual entry). Note multiple allocations may exist for a single payment and thus may share the same source_id.

### InsuranceAdjustmentInfo

- `total_adjustment_cents` (integer, required) — The total amount of insurance adjustments in cents for the service line.

### InsurancePaymentInfo

- `total_payment_cents` (integer, required) — The total amount of insurance payments in cents for the service line.

### NonInsuranceAdjustmentInfo

- `total_adjustment_cents` (integer, required) — The total amount of non-insurance adjustments in cents for the service line.

### NonInsurancePaymentInfo

- `total_payment_cents` (integer, required) — The total amount of non-insurance payments in cents for the service line.

### PatientAdjustmentInfo

- `total_adjustment_cents` (integer, required) — The total amount of patient adjustments in cents for the service line.

## Examples

**Response**

```json
{
  "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "patient_balance_cents": 1,
  "claim_level_patient_payments": {
    "total_payment_cents": 1,
    "items": [
      {
        "amount_cents": 1,
        "source_id": "source_id"
      },
      {
        "amount_cents": 1,
        "source_id": "source_id"
      }
    ]
  },
  "service_line_itemization": [
    {
      "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "procedure_code": "procedure_code",
      "date_of_service": "2023-01-15",
      "patient_balance_cents": 1,
      "charge_amount_cents": 1,
      "insurance_adjustments": {
        "total_adjustment_cents": 1
      },
      "insurance_payments": {
        "total_payment_cents": 1
      },
      "non_insurance_adjustments": {
        "total_adjustment_cents": 1
      },
      "non_insurance_payments": {
        "total_payment_cents": 1
      },
      "patient_adjustments": {
        "total_adjustment_cents": 1
      },
      "patient_payments": {
        "total_payment_cents": 1,
        "items": [
          {
            "amount_cents": 1,
            "source_id": "source_id"
          },
          {
            "amount_cents": 1,
            "source_id": "source_id"
          }
        ]
      },
      "copay_cents": 1,
      "coinsurance_cents": 1,
      "deductible_cents": 1
    },
    {
      "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "procedure_code": "procedure_code",
      "date_of_service": "2023-01-15",
      "patient_balance_cents": 1,
      "charge_amount_cents": 1,
      "insurance_adjustments": {
        "total_adjustment_cents": 1
      },
      "insurance_payments": {
        "total_payment_cents": 1
      },
      "non_insurance_adjustments": {
        "total_adjustment_cents": 1
      },
      "non_insurance_payments": {
        "total_payment_cents": 1
      },
      "patient_adjustments": {
        "total_adjustment_cents": 1
      },
      "patient_payments": {
        "total_payment_cents": 1,
        "items": [
          {
            "amount_cents": 1,
            "source_id": "source_id"
          },
          {
            "amount_cents": 1,
            "source_id": "source_id"
          }
        ]
      },
      "copay_cents": 1,
      "coinsurance_cents": 1,
      "deductible_cents": 1
    }
  ],
  "organization_service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
```

**SDK Code**

```python
import requests

url = "https://api.joincandidhealth.com/api/patient-ar/v1/invoice-itemization/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"

headers = {"Authorization": "<token>."}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.joincandidhealth.com/api/patient-ar/v1/invoice-itemization/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32';
const options = {method: 'GET', headers: {Authorization: '<token>.'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.joincandidhealth.com/api/patient-ar/v1/invoice-itemization/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<token>.")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.joincandidhealth.com/api/patient-ar/v1/invoice-itemization/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<token>.'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.joincandidhealth.com/api/patient-ar/v1/invoice-itemization/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
  .header("Authorization", "<token>.")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.joincandidhealth.com/api/patient-ar/v1/invoice-itemization/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', [
  'headers' => [
    'Authorization' => '<token>.',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.joincandidhealth.com/api/patient-ar/v1/invoice-itemization/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<token>.");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<token>."]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.joincandidhealth.com/api/patient-ar/v1/invoice-itemization/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```