The Dunning 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.

status string

Default: draft

company string required

customer_name string

posting_date string required

dunning_type string

dunning_fee number

Default: 0

language string

letter_head string

body_text string

closing_text string

posting_time string

rate_of_interest number

Default: 0

address_display string

contact_display string

contact_mobile string

company_address_display string

contact_email string

customer string required

grand_total number

Default: 0

income_account string

total_interest number

Default: 0

total_outstanding number

customer_address string

contact_person string

dunning_amount number

Default: 0

cost_center string

spacer string

company_address string

currency string

conversion_rate number

base_dunning_amount number

Default: 0

The Dunning object

{
  "id": "dunning_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "customer_name": "customer_name_example",
  "posting_date": "2024-01-15",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "language": "language_example",
  "letter_head": "letter_head_example",
  "body_text": "body_text_example",
  "closing_text": "closing_text_example",
  "posting_time": "posting_time_example",
  "rate_of_interest": 0,
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "company_address_display": "Example Corp",
  "contact_email": "[email protected]",
  "customer": "customer_example",
  "grand_total": 0,
  "income_account": "income_account_example",
  "total_interest": 0,
  "total_outstanding": 0,
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "dunning_amount": 0,
  "cost_center": "cost_center_example",
  "spacer": "spacer_example",
  "company_address": "Example Corp",
  "currency": "USD",
  "conversion_rate": 0,
  "base_dunning_amount": 0
}

GET /api/accounts/dunning/{id}

Retrieve a dunning

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

Path parameters

id string required

The identifier of the dunning to retrieve.

Returns

Returns the dunning object if a valid identifier was provided.

GET /api/accounts/dunning/{id}

curl https://api.overplane.dev/api/accounts/dunning/dunning_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "dunning_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "customer_name": "customer_name_example",
  "posting_date": "2024-01-15",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "language": "language_example",
  "letter_head": "letter_head_example",
  "body_text": "body_text_example",
  "closing_text": "closing_text_example",
  "posting_time": "posting_time_example",
  "rate_of_interest": 0,
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "company_address_display": "Example Corp",
  "contact_email": "[email protected]",
  "customer": "customer_example",
  "grand_total": 0,
  "income_account": "income_account_example",
  "total_interest": 0,
  "total_outstanding": 0,
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "dunning_amount": 0,
  "cost_center": "cost_center_example",
  "spacer": "spacer_example",
  "company_address": "Example Corp",
  "currency": "USD",
  "conversion_rate": 0,
  "base_dunning_amount": 0
}

GET /api/accounts/dunning

List all dunnings

Returns a list of dunnings. 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 objects.

GET /api/accounts/dunning

curl https://api.overplane.dev/api/accounts/dunning \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "dunning_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "customer_name": "customer_name_example",
      "posting_date": "2024-01-15",
      "dunning_type": "dunning_type_example",
      "dunning_fee": 0,
      "language": "language_example",
      "letter_head": "letter_head_example",
      "body_text": "body_text_example",
      "closing_text": "closing_text_example",
      "posting_time": "posting_time_example",
      "rate_of_interest": 0,
      "address_display": "address_display_example",
      "contact_display": "contact_display_example",
      "contact_mobile": "contact_mobile_example",
      "company_address_display": "Example Corp",
      "contact_email": "[email protected]",
      "customer": "customer_example",
      "grand_total": 0,
      "income_account": "income_account_example",
      "total_interest": 0,
      "total_outstanding": 0,
      "customer_address": "customer_address_example",
      "contact_person": "contact_person_example",
      "dunning_amount": 0,
      "cost_center": "cost_center_example",
      "spacer": "spacer_example",
      "company_address": "Example Corp",
      "currency": "USD",
      "conversion_rate": 0,
      "base_dunning_amount": 0
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/accounts/dunning

Create a dunning

Creates a new dunning object.

Body parameters

status string

Default: draft

company string required

customer_name string

posting_date string required

dunning_type string

dunning_fee number

Default: 0

language string

letter_head string

body_text string

closing_text string

posting_time string

rate_of_interest number

Default: 0

address_display string

contact_display string

contact_mobile string

company_address_display string

contact_email string

customer string required

grand_total number

Default: 0

income_account string

total_interest number

Default: 0

total_outstanding number

customer_address string

contact_person string

dunning_amount number

Default: 0

cost_center string

spacer string

company_address string

currency string

conversion_rate number

base_dunning_amount number

Default: 0

Returns

Returns the newly created dunning object if the call succeeded.

POST /api/accounts/dunning

curl https://api.overplane.dev/api/accounts/dunning \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","posting_date":"2024-01-15","customer":"customer_example"}'

Response

{
  "id": "dunning_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "customer_name": "customer_name_example",
  "posting_date": "2024-01-15",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "language": "language_example",
  "letter_head": "letter_head_example",
  "body_text": "body_text_example",
  "closing_text": "closing_text_example",
  "posting_time": "posting_time_example",
  "rate_of_interest": 0,
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "company_address_display": "Example Corp",
  "contact_email": "[email protected]",
  "customer": "customer_example",
  "grand_total": 0,
  "income_account": "income_account_example",
  "total_interest": 0,
  "total_outstanding": 0,
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "dunning_amount": 0,
  "cost_center": "cost_center_example",
  "spacer": "spacer_example",
  "company_address": "Example Corp",
  "currency": "USD",
  "conversion_rate": 0,
  "base_dunning_amount": 0
}

PATCH /api/accounts/dunning/{id}

Update a dunning

Updates the specified dunning 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 to update.

Body parameters

status string

Default: draft

company string

customer_name string

posting_date string

dunning_type string

dunning_fee number

Default: 0

language string

letter_head string

body_text string

closing_text string

posting_time string

rate_of_interest number

Default: 0

address_display string

contact_display string

contact_mobile string

company_address_display string

contact_email string

customer string

grand_total number

Default: 0

income_account string

total_interest number

Default: 0

total_outstanding number

customer_address string

contact_person string

dunning_amount number

Default: 0

cost_center string

spacer string

company_address string

currency string

conversion_rate number

base_dunning_amount number

Default: 0

Returns

Returns the updated dunning object.

PATCH /api/accounts/dunning/{id}

curl https://api.overplane.dev/api/accounts/dunning/dunning_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'

Response

{
  "id": "dunning_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "customer_name": "customer_name_example",
  "posting_date": "2024-01-15",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "language": "language_example",
  "letter_head": "letter_head_example",
  "body_text": "body_text_example",
  "closing_text": "closing_text_example",
  "posting_time": "posting_time_example",
  "rate_of_interest": 0,
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "company_address_display": "Example Corp",
  "contact_email": "[email protected]",
  "customer": "customer_example",
  "grand_total": 0,
  "income_account": "income_account_example",
  "total_interest": 0,
  "total_outstanding": 0,
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "dunning_amount": 0,
  "cost_center": "cost_center_example",
  "spacer": "spacer_example",
  "company_address": "Example Corp",
  "currency": "USD",
  "conversion_rate": 0,
  "base_dunning_amount": 0
}

DELETE /api/accounts/dunning/{id}

Delete a dunning

Permanently deletes a dunning. This cannot be undone.

Path parameters

id string required

The identifier of the dunning to delete.

Returns

Returns a confirmation that the dunning has been deleted.

DELETE /api/accounts/dunning/{id}

curl https://api.overplane.dev/api/accounts/dunning/dunning_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "dunning_abc123",
  "deleted": true
}

POST /api/accounts/dunning/{id}/submit

Submit a dunning

Submits a draft dunning, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the dunning to act on.

Returns

Returns the dunning object with updated status.

POST /api/accounts/dunning/{id}/submit

curl https://api.overplane.dev/api/accounts/dunning/dunning_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "dunning_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "customer_name": "customer_name_example",
  "posting_date": "2024-01-15",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "language": "language_example",
  "letter_head": "letter_head_example",
  "body_text": "body_text_example",
  "closing_text": "closing_text_example",
  "posting_time": "posting_time_example",
  "rate_of_interest": 0,
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "company_address_display": "Example Corp",
  "contact_email": "[email protected]",
  "customer": "customer_example",
  "grand_total": 0,
  "income_account": "income_account_example",
  "total_interest": 0,
  "total_outstanding": 0,
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "dunning_amount": 0,
  "cost_center": "cost_center_example",
  "spacer": "spacer_example",
  "company_address": "Example Corp",
  "currency": "USD",
  "conversion_rate": 0,
  "base_dunning_amount": 0
}

POST /api/accounts/dunning/{id}/cancel

Cancel a dunning

Cancels a submitted dunning, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the dunning to act on.

Returns

Returns the dunning object with updated status.

POST /api/accounts/dunning/{id}/cancel

curl https://api.overplane.dev/api/accounts/dunning/dunning_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "dunning_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "customer_name": "customer_name_example",
  "posting_date": "2024-01-15",
  "dunning_type": "dunning_type_example",
  "dunning_fee": 0,
  "language": "language_example",
  "letter_head": "letter_head_example",
  "body_text": "body_text_example",
  "closing_text": "closing_text_example",
  "posting_time": "posting_time_example",
  "rate_of_interest": 0,
  "address_display": "address_display_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "company_address_display": "Example Corp",
  "contact_email": "[email protected]",
  "customer": "customer_example",
  "grand_total": 0,
  "income_account": "income_account_example",
  "total_interest": 0,
  "total_outstanding": 0,
  "customer_address": "customer_address_example",
  "contact_person": "contact_person_example",
  "dunning_amount": 0,
  "cost_center": "cost_center_example",
  "spacer": "spacer_example",
  "company_address": "Example Corp",
  "currency": "USD",
  "conversion_rate": 0,
  "base_dunning_amount": 0
}

Line items

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

Overdue Payment

Attributes

idx integer

dunning_id string required

payment_term string

description string

due_date string

mode_of_payment string

invoice_portion number

payment_amount number

outstanding number

paid_amount number

discounted_amount number

sales_invoice string required

payment_schedule string

overdue_days string

dunning_level integer

interest number

Endpoints

GET /api/accounts/overdue-payment?parent_id={id}

POST /api/accounts/overdue-payment

PATCH /api/accounts/overdue-payment/{id}

DELETE /api/accounts/overdue-payment/{id}

POST /api/accounts/overdue-payment/reorder

Overdue Payment object

{
  "id": "overdue-payment_abc123",
  "idx": 1,
  "dunning_id": "dunning_id_example",
  "payment_term": "payment_term_example",
  "description": "description_example",
  "due_date": "2024-01-15",
  "mode_of_payment": "mode_of_payment_example",
  "invoice_portion": 0,
  "payment_amount": 0,
  "outstanding": 0,
  "paid_amount": 0,
  "discounted_amount": 0,
  "sales_invoice": "sales_invoice_example",
  "payment_schedule": "payment_schedule_example",
  "overdue_days": "overdue_days_example",
  "dunning_level": 1,
  "interest": 0
}

The Dunning object

Attributes

Retrieve a dunning

Path parameters

Returns

List all dunnings

Query parameters

Returns

Create a dunning

Body parameters

Returns

Update a dunning

Path parameters

Body parameters

Returns

Delete a dunning

Path parameters

Returns

Submit a dunning

Path parameters

Returns

Cancel a dunning

Path parameters

Returns

Line items

Overdue Payment

Attributes

Endpoints

Coming Soon