The Dunning Type object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

dunning_type string required
dunning_fee number
rate_of_interest number
is_default boolean

Default: false

income_account string
cost_center string
company string required
The Dunning Type object 
{
  "id": "dunning-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "rate_of_interest": 0,
  "is_default": false,
  "income_account": "income_account_example",
  "cost_center": "cost_center_example",
  "company": "Example Corp"
}
GET /api/accounts/dunning-type/{id}

Retrieve a dunning type

Retrieves the details of an existing dunning type. Supply the unique dunning type ID that was returned from a previous request.

Path parameters

id string required

The identifier of the dunning type to retrieve.

Returns

Returns the dunning type object if a valid identifier was provided.

GET /api/accounts/dunning-type/{id} 
curl https://api.overplane.dev/api/accounts/dunning-type/dunning-type_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "dunning-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "rate_of_interest": 0,
  "is_default": false,
  "income_account": "income_account_example",
  "cost_center": "cost_center_example",
  "company": "Example Corp"
}
GET /api/accounts/dunning-type

List all dunning types

Returns a list of dunning types. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of dunning type objects.

GET /api/accounts/dunning-type 
curl https://api.overplane.dev/api/accounts/dunning-type \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "dunning-type_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "dunning_type": "dunning_type_example",
      "dunning_fee": 0,
      "rate_of_interest": 0,
      "is_default": false,
      "income_account": "income_account_example",
      "cost_center": "cost_center_example",
      "company": "Example Corp"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/dunning-type

Create a dunning type

Creates a new dunning type object.

Body parameters

dunning_type string required
dunning_fee number
rate_of_interest number
is_default boolean

Default: false

income_account string
cost_center string
company string required

Returns

Returns the newly created dunning type object if the call succeeded.

POST /api/accounts/dunning-type 
curl https://api.overplane.dev/api/accounts/dunning-type \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"dunning_type":"dunning_type_example","company":"Example Corp"}'
Response 
{
  "id": "dunning-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "rate_of_interest": 0,
  "is_default": false,
  "income_account": "income_account_example",
  "cost_center": "cost_center_example",
  "company": "Example Corp"
}
PATCH /api/accounts/dunning-type/{id}

Update a dunning type

Updates the specified dunning type by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the dunning type to update.

Body parameters

dunning_type string
dunning_fee number
rate_of_interest number
is_default boolean

Default: false

income_account string
cost_center string
company string

Returns

Returns the updated dunning type object.

PATCH /api/accounts/dunning-type/{id} 
curl https://api.overplane.dev/api/accounts/dunning-type/dunning-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"dunning_type":"dunning_type_example","dunning_fee":0}'
Response 
{
  "id": "dunning-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "rate_of_interest": 0,
  "is_default": false,
  "income_account": "income_account_example",
  "cost_center": "cost_center_example",
  "company": "Example Corp"
}
DELETE /api/accounts/dunning-type/{id}

Delete a dunning type

Permanently deletes a dunning type. This cannot be undone.

Path parameters

id string required

The identifier of the dunning type to delete.

Returns

Returns a confirmation that the dunning type has been deleted.

DELETE /api/accounts/dunning-type/{id} 
curl https://api.overplane.dev/api/accounts/dunning-type/dunning-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "dunning-type_abc123",
  "deleted": true
}

Line items

Child objects that belong to this dunning type. These are accessed via the parent's ID.

Dunning Letter Text

Attributes

idx integer
dunning_type_id string required
language string
is_default_language boolean
body_text string
closing_text string

Endpoints

GET /api/accounts/dunning-letter-text?parent_id={id}
POST /api/accounts/dunning-letter-text
PATCH /api/accounts/dunning-letter-text/{id}
DELETE /api/accounts/dunning-letter-text/{id}
POST /api/accounts/dunning-letter-text/reorder
Dunning Letter Text object 
{
  "id": "dunning-letter-text_abc123",
  "idx": 1,
  "dunning_type_id": "dunning_type_id_example",
  "language": "language_example",
  "is_default_language": false,
  "body_text": "body_text_example",
  "closing_text": "closing_text_example"
}