---
title: "dunning"
description: "REST API endpoints for dunning."
canonical_url: "https://www.zeyos.com/api/dunning"
markdown_url: "https://www.zeyos.com/ai/guide/api/dunning.md"
section: "api-reference"
authority: "reference"
language: "en"
source_repository: "https://cloud.zeyos.com/__doc/openapi/api.json"
source_sha256: "f5850c6fa6f99a1b518fc8ddc4e566070b53b5506cde57a3299948d38fc6363c"
---

# ZeyOS Standard REST API (v1)

## Tag: dunning
Dunning Notices

## Spec
- /__doc/openapi/api.json

## Servers
- https://cloud.zeyos.com/{INSTANCE}/api/v1 — ZeyOS Cloud

## Authentication
- oauth (oauth2) — OAuth 2.0 Authorization ([RFC 6749](https://tools.ietf.org/html/rfc6749)); use the **[ZeyOS OAuth 2.0 API](https://developers.zeyos.com/oauth2) `POST /oauth2/v1/token`** to obtain a valid bearer token
- token (http) — HTTP Bearer Authentication ([RFC 6750](https://tools.ietf.org/html/rfc6750))
- session (apiKey) — Session Cookie Authentication ([RFC 6265](https://tools.ietf.org/html/rfc6265))

## Endpoints
| Method | Path | Summary |
| ------ | ---- | ------- |
| POST | /dunning | List dunning notices |
| PUT | /dunning | Create new dunning notice |
| DELETE | /dunning/{ID} | Delete dunning notice |
| GET | /dunning/{ID} | Get dunning notice |
| HEAD | /dunning/{ID} | Check if dunning notice exists |
| PATCH | /dunning/{ID} | Update existing dunning notice |

### POST /dunning
- Summary: List dunning notices
- OperationId: listDunningNotices
- Description: List selected data from all dunning notices that match the specified filter and search criteria in a specific sort order. Requires `collection` permission.

Parameters:
- (none)

Request body:
- #/components/requestBodies/list

Responses:
- 200 — OK
  - application/json — array
- 401: #/components/responses/401
- 403: #/components/responses/403
- 500: #/components/responses/500

### PUT /dunning
- Summary: Create new dunning notice
- OperationId: createDunningNotice
- Description: Create a new dunning notice and return its persistent data. Requires writable `collection` permission.

Parameters:
- (none)

Request body:
- #/components/requestBodies/dunning

Responses:
- 201 — Successful Creation (Created)
  - application/json — #/components/schemas/dunning
- 401: #/components/responses/401
- 403: #/components/responses/403
- 409 — ID Present (Conflict)
- 410 — Gone
- 500: #/components/responses/500

### DELETE /dunning/{ID}
- Summary: Delete dunning notice
- OperationId: deleteDunningNotice
- Description: Permanently delete an existing dunning notice by **`ID`**. Requires writable `collection` permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/If-Match
- #/components/parameters/If-Unmodified-Since

Request body:
- (none)

Responses:
- 204 — Successful Deletion (No Content)
- 401: #/components/responses/401
- 403: #/components/responses/403
- 404 — Not Found
- 409 — Not Deletable (Conflict)
- 412 — Non-matching ETag (Precondition Failed)
- 500: #/components/responses/500

### GET /dunning/{ID}
- Summary: Get dunning notice
- OperationId: getDunningNotice
- Description: Return the data of an existing dunning notice by **`ID`**. Requires `collection` permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/expand
- #/components/parameters/extdata
- #/components/parameters/tags
- #/components/parameters/If-Modified-Since
- #/components/parameters/If-None-Match

Request body:
- (none)

Responses:
- 200 — OK
  - application/json — #/components/schemas/dunning
- 304 — Not Modified
- 401: #/components/responses/401
- 403: #/components/responses/403
- 404 — Not Found
- 500: #/components/responses/500

### HEAD /dunning/{ID}
- Summary: Check if dunning notice exists
- OperationId: existsDunningNotice
- Description: Check if a dunning notice with **`ID`** exists, but do not return its data. Requires `collection` permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/If-Modified-Since
- #/components/parameters/If-None-Match

Request body:
- (none)

Responses:
- 204: #/components/responses/204-exists
- 304 — Not Modified
- 401: #/components/responses/401
- 404 — Not Found
- 500: #/components/responses/500

### PATCH /dunning/{ID}
- Summary: Update existing dunning notice
- OperationId: updateDunningNotice
- Description: Update an existing dunning notice by **`ID`** and return its persistent data. Requires writable `collection` permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/If-Match
- #/components/parameters/If-Unmodified-Since

Request body:
- #/components/requestBodies/dunning

Responses:
- 200 — Successful Update (OK)
  - application/json — #/components/schemas/dunning
- 401: #/components/responses/401
- 403: #/components/responses/403
- 404 — Not Found
- 409 — Non-matching ID (Conflict)
- 410 — Gone
- 412 — Non-matching ETag (Precondition Failed)
- 500: #/components/responses/500