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

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

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

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/billing/{tenantLocator}/creditDistributions/{locator}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/billing/:tenantLocator/creditDistributions/: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

- CreditDistributionUpdateRequest
  - `accountLocator` string, ulid
  - `amount` number
  - `addSources` CreditItem[], required
    - `containerLocator` string, ulid, required
    - `containerType` 'invoice' | 'account' | 'subpayment' | 'invoiceItem', required
    - `amount` number
  - `removeSources` string[], required
  - `addTargets` CreditItem[], required
    - `containerLocator` string, ulid, required
    - `containerType` 'invoice' | 'account' | 'subpayment' | 'invoiceItem', required
    - `amount` number
  - `removeTargets` string[], required
  - `currency` string

## Response `200`

OK

- CreditDistributionResponse
  - `locator` string, ulid, required
  - `creditDistributionState` 'draft' | 'validated' | 'executed' | 'reversed' | 'discarded', required
  - `currency` string, required
  - `amount` number, required
  - `createdAt` string, date-time, required
  - `createdBy` string, uuid, required
  - `accountLocator` string, ulid
  - `sources` CreditItem[], required
    - `containerLocator` string, ulid, required
    - `containerType` 'invoice' | 'account' | 'subpayment' | 'invoiceItem', required
    - `amount` number
  - `targets` CreditItem[], required
    - `containerLocator` string, ulid, required
    - `containerType` 'invoice' | 'account' | 'subpayment' | 'invoiceItem', required
    - `amount` number
  - `validationResult` ValidationResult
    - `validationItems` ValidationItemResponse[]
      - `elementType` string, required
      - `locator` string, ulid, required
      - `errors` string[], required
    - `success` boolean, required
  - `executedAt` string, date-time
  - `reversalReason` string
  - `reversedAt` string, date-time
  - `shortfallCreditLocators` string[], required

---

[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/77ee7d8172b9?raw)