---
title: "PATCH /billing/{tenantLocator}/invoices/{locator}"
method: PATCH
path: "/billing/{tenantLocator}/invoices/{locator}"
---

# PATCH /billing/{tenantLocator}/invoices/{locator}

`PATCH /billing/{tenantLocator}/invoices/{locator}`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/billing/{tenantLocator}/invoices/{locator}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/billing/:tenantLocator/invoices/:locator/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required
- `locator` string, ulid, required

## Request body

- InvoiceUpdateRequest
  - `autopayTime` string, date-time
  - `suppressAutopay` boolean

## Response `200`

OK

- InvoiceResponse
  - `locator` string, ulid, required
  - `accountLocator` string, ulid, required
  - `invoiceState` 'building' | 'open' | 'settled' | 'discarded', required
  - `invoiceItems` InvoiceItemResponse[]: Not included when part of a list response
    - `locator` string, ulid, required
    - `chargeType` string, required
    - `chargeCategory` string, required
    - `amount` number, required
    - `remainingAmount` number
    - `settlementTime` string, date-time
    - `invoiceLocator` string, ulid, required
    - `installmentItemLocators` string[], required
    - `timezone` string, required
    - `quoteLocator` string, ulid
    - `policyLocator` string, ulid
    - `elementStaticLocator` string, ulid
    - `elementType` string
    - `transactionLocators` string[], required
    - `unsettledTime` string, date-time
  - `generatedTime` string, date-time, required
  - `dueTime` string, date-time, required
  - `currency` string, required
  - `startTime` string, date-time, required
  - `endTime` string, date-time, required
  - `unsettledTime` string, date-time
  - `timezone` string, required
  - `invoiceNumber` string
  - `autopayTime` string, date-time
  - `settledTime` string, date-time
  - `aggregateInvoiceLocator` string, ulid
  - `invoiceType` 'normal' | 'aggregate', required
  - `totalAmount` number
  - `totalRemainingAmount` number

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/6537d24b3693?raw)