---
title: "POST /billing/{tenantLocator}/holds"
method: POST
path: "/billing/{tenantLocator}/holds"
---

# POST /billing/{tenantLocator}/holds

`POST /billing/{tenantLocator}/holds`

## Request

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

## Path parameters

- `tenantLocator` string, uuid, required

## Request body

- HoldCreateRequest
  - `accountLocator` string, ulid, required
  - `targetType` 'invoicing' | 'delinquency', required

## Response `200`

OK

- HoldResponse
  - `locator` string, ulid, required
  - `accountLocator` string, ulid, required
  - `targetType` 'invoicing' | 'delinquency', required
  - `holdState` 'draft' | 'validated' | 'active' | 'discarded' | 'released', required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `validationResult` ValidationResult
    - `validationItems` ValidationItemResponse[]
      - `elementType` string, required
      - `locator` string, ulid, required
      - `errors` string[], required
    - `success` boolean, 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/6537d24b3693?raw)