> 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.

# Update

PATCH https://api.joincandidhealth.com/api/import-invoice/v1/{invoice_id}
Content-Type: application/json

Update the information on the imported invoice

Reference: https://docs.joincandidhealth.com/api-reference/patient-collections/import-invoice/v-1/update

## 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

- `invoice_id` (UUID, required)

### Body (application/json)

This endpoint expects an ImportInvoiceUpdateRequest.

- `customer_invoice_url` (string, optional) — Link to the patient view of the invoice in the third-party service
- `status` (enum, optional)
  - Allowed values: `DRAFT`, `OPEN`, `PAID`, `VOID`, `UNCOLLECTIBLE`, `HELD`
- `note` (string, optional)
- `due_date` (date, optional)
- `items` (InvoiceItemInfoUpdate, optional) — None here represents there is no update to the invoice items

## Response

### 200

- `id` (UUID, required)
- `created_at` (datetime, required)
- `updated_at` (datetime, required)
- `items` (InvoiceItemInfo, required) — The InvoiceItem rollup which contains all claim and service line invoice items
- `patient_external_id` (string, required)
- `external_customer_identifier` (string, required) — Id of the customer in the source system
- `status` (enum, required)
  - Allowed values: `DRAFT`, `OPEN`, `PAID`, `VOID`, `UNCOLLECTIBLE`, `HELD`
- `external_identifier` (string, required) — Id of the invoice being imported in the source system
- `due_date` (date, required)
- `amount_cents` (integer, required) — Total monetary amount (in cents) of all Invoice Items
- `note` (string, optional)
- `customer_invoice_url` (string, optional) — Link to the patient view of the invoice in the third-party service

## Errors

### 404 Entity Not Found Error

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

## Types

### InvoiceItemInfoUpdate

- `update_type` (enum, required) — The only supported update operations for invoice items is to either overwrite the entire list of invoice items or to append new invoice items
  - Allowed values: `APPEND`, `OVERWRITE`
- `items` (list of InvoiceItemCreate, required)

### InvoiceItemInfo

- `claim_invoice_items` (map from UUID to ClaimInvoiceItemInfo, required)
- `unattributed_items` (list of UnattributedInvoiceItem, required)

### EntityNotFoundErrorMessage

- `id` (string, required)

### InvoiceItemCreate

- `attribution` (InvoiceItemAttributionCreate, required) — Points to the claim or service line that this invoice is attributed to
- `amount_cents` (integer, required)

### ClaimInvoiceItemInfo

- `service_line_invoice_items` (map from UUID to ServiceLineInvoiceItem, required)
- `claim_invoice_item` (ClaimInvoiceItem, optional)

### UnattributedInvoiceItem

- `amount_cents` (integer, required)

### InvoiceItemAttributionCreate

Points to the claim or service line that this invoice is attributed to

- `type`: `service_line_id`
  - `value` (UUID, required)
- `type`: `claim_id`
  - `value` (UUID, required)
- `type`: `unattributed`

### ServiceLineInvoiceItem

- `service_line_id` (UUID, required)
- `amount_cents` (integer, required)

### ClaimInvoiceItem

- `claim_id` (UUID, required)
- `amount_cents` (integer, required)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "items": {
    "claim_invoice_items": {
      "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": {
        "service_line_invoice_items": {
          "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": {
            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
            "amount_cents": 1
          }
        },
        "claim_invoice_item": {
          "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "amount_cents": 1
        }
      }
    },
    "unattributed_items": [
      {
        "amount_cents": 1
      },
      {
        "amount_cents": 1
      }
    ]
  },
  "patient_external_id": "patient_external_id",
  "external_customer_identifier": "external_customer_identifier",
  "status": "DRAFT",
  "external_identifier": "external_identifier",
  "due_date": "2023-01-15",
  "amount_cents": 1,
  "note": "note",
  "customer_invoice_url": "customer_invoice_url"
}
```

**SDK Code**

```python
import requests

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

payload = {}
headers = {
    "Authorization": "<token>.",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.joincandidhealth.com/api/import-invoice/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32';
const options = {
  method: 'PATCH',
  headers: {Authorization: '<token>.', 'Content-Type': 'application/json'},
  body: '{}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{}")

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

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

	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/import-invoice/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<token>.'
request["Content-Type"] = 'application/json'
request.body = "{}"

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.patch("https://api.joincandidhealth.com/api/import-invoice/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
  .header("Authorization", "<token>.")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.joincandidhealth.com/api/import-invoice/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', [
  'body' => '{}',
  'headers' => [
    'Authorization' => '<token>.',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.joincandidhealth.com/api/import-invoice/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "<token>.");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<token>.",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

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

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()
```