---
canonical_url: "https://docs.composio.dev/toolkits/debitura"
markdown_url: "https://docs.composio.dev/toolkits/debitura.md"
product: "platform"
version: null
last_updated: null
---

# Debitura

Debitura helps creditors manage debt collection cases, coverage, payments, divisions, tasks, and webhooks through its Customer API.

- **Category:** accounting
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 11
- **Triggers:** 0
- **Slug:** `DEBITURA`
- **Version:** 00000000_00

## Tools

### Check Case Eligibility

**Slug:** `DEBITURA_CHECK_CASE_ELIGIBILITY`

Check whether Debitura covers a proposed debtor jurisdiction and amount, returning the matched partner and power-of-attorney status without creating a case. This does not check the debt-collection agreement status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | number | Yes | Amount to recover in the specified currency; must be at least 0.01. |
| `debtor_type` | string ("Company" | "Private") | Yes | Whether the debtor is a company or a private person. |
| `state_alpha2` | string | No | Two-letter US state code. Required when country_alpha2 is US. |
| `currency_code` | string | Yes | Three-letter ISO 4217 currency code. |
| `country_alpha2` | string | Yes | Two-letter ISO 3166-1 debtor country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Division

**Slug:** `DEBITURA_CREATE_DIVISION`

Create a creditor division with its company, address, and office contact profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | Yes | City where the division is located. |
| `state` | string | No | State or region where the division is located. |
| `address` | string | No | Street address of the division. |
| `zip_code` | string | No | Postal code (maximum 50 characters). |
| `company_name` | string | Yes | Division company name (maximum 200 characters). |
| `country_code` | string | Yes | Two-letter ISO 3166-1 country code. |
| `office_email` | string | No | Valid office email address (maximum 250 characters). |
| `office_phone` | string | No | Office phone number (maximum 50 characters). |
| `idempotency_key` | string | No | Optional idempotency key retained by Debitura for 24 hours. Reuse the same key only when retrying the same create request. |
| `registration_number` | string | No | Company registration number (maximum 50 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Case Context

**Slug:** `DEBITURA_GET_CASE_CONTEXT`

Get one case by Debitura ID, Debitura reference, or creditor reference. By default, also fetch its timeline, payments, open tasks, and validation details; use include to select other sections or request case details only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `case_id` | string | No | Debitura case ID. Provide exactly one of case_id, case_reference, or creditor_reference. |
| `include` | array | No | Context sections to fetch. Defaults to timeline, payments, tasks, and validation. Other available sections are chats and files. Use an empty list for case details only. |
| `task_types` | array | No | Optional task type filters used when tasks are included. |
| `task_status` | string ("Open" | "Solved") | No | Status used when tasks are included. |
| `case_reference` | string | No | Debitura's case reference, for example Q8OAXF3W. Provide exactly one lookup field. |
| `creditor_reference` | string | No | The creditor's own unique case reference. Provide exactly one lookup field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Creditor Status

**Slug:** `DEBITURA_GET_CREDITOR_STATUS`

Return the connected creditor profile together with debt-collection contract onboarding status and any signing URL.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Divisions

**Slug:** `DEBITURA_LIST_DIVISIONS`

List creditor divisions, optionally including archived divisions. Returns one page and an opaque continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum divisions to return in this page (1-100). |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Pass it unchanged; omit it for the first page. |
| `include_archived` | boolean | No | Include archived divisions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payments

**Slug:** `DEBITURA_LIST_PAYMENTS`

List payments across all creditor cases. Returns one page and an opaque continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum payments to return in this page (1-100). |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Pass it unchanged; omit it for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tasks

**Slug:** `DEBITURA_LIST_TASKS`

List the creditor's action-item work queue across cases. Filter by status or task type and use the resolution URL or machine-readable action hint. Returns one page and an opaque continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `types` | array | No | Stable task type codes to include. Values are sent as repeated type query parameters. |
| `status` | string ("Open" | "Solved") | No | Task status to return: Open or Solved. |
| `page_size` | integer | No | Maximum tasks to return in this page (1-100). |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Pass it unchanged; omit it for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Case

**Slug:** `DEBITURA_PREVIEW_CASE`

Preview collection eligibility, partner assignment, blocking signing actions, jurisdiction, and estimated pricing without creating a case. Eligibility alone does not mean the case can be submitted; always inspect requiredActions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `due_date` | string | No | Invoice due date used for age pricing. It cannot be in the future and cannot be combined with age-bucket amounts. |
| `return_url` | string | No | Absolute HTTP(S) URL to return to after the creditor completes a signing handoff. |
| `debtor_type` | string ("Company" | "Private") | Yes | Whether the debtor is a company or a private person. |
| `state_alpha2` | string | No | Two-letter US state code. Required when country_alpha2 is US. |
| `currency_code` | string | Yes | Three-letter ISO 4217 currency code. |
| `country_alpha2` | string | Yes | Two-letter ISO 3166-1 debtor country code. |
| `amount_to_recover` | number | Yes | Total principal amount to recover. |
| `amount_over_6_months` | number | No | Portion over six months overdue. It requires the 12- and 24-month amounts, cannot exceed the total, and cannot be less than the 12-month amount. |
| `amount_over_12_months` | number | No | Portion over twelve months overdue. Supply it together with the 24-month amount; it cannot exceed the total. |
| `amount_over_24_months` | number | No | Portion over twenty-four months overdue. Supply it together with the 12-month amount; it cannot exceed that amount. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Cases

**Slug:** `DEBITURA_SEARCH_CASES`

Search the creditor's collection cases by lifecycle status, case IDs, debtor IDs, division IDs, and supported sort order. Returns one page and an opaque continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Comma-separated Field[:asc|desc] terms. Supported fields: DateCreated, DateUpdated, DateFinished, DateCollectionStarted, DueDate, Date, GrossAmount, Remainder, InterestFees, CollectionFees, ReminderFees, Lifecycle, and CloseCode. |
| `case_ids` | array | No | Restrict results to Debitura case IDs. |
| `statuses` | array | No | Lifecycle statuses to include: PendingContractSigning, PendingVerificationInternal, PendingVerification, NeedsAdditionalDetails, Leads, LeadsQuoteGiven, Active, Paused, Closed, or Merged. |
| `page_size` | integer | No | Maximum cases to return in this page (1-100). |
| `debtor_ids` | array | No | Restrict results to debtor IDs. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Pass it unchanged; omit it for the first page. |
| `division_ids` | array | No | Restrict results to creditor division IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Coverage

**Slug:** `DEBITURA_SEARCH_COVERAGE`

Find Debitura collection coverage by exact jurisdiction ID or by filtering the canonical coverage catalog for a country and optional US state. Returns partner conditions and power-of-attorney signing status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state_alpha2` | string | No | Optional two-letter US state code. Requires country_alpha2='US'. |
| `country_alpha2` | string | No | Two-letter ISO 3166-1 country code used to filter the coverage catalog. |
| `jurisdiction_id` | integer | No | Exact Debitura jurisdiction ID. Mutually exclusive with country_alpha2 and state_alpha2. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Division

**Slug:** `DEBITURA_UPDATE_DIVISION`

Fully replace an existing creditor division's editable company, address, and office contact profile. All required profile fields must be supplied.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | Yes | City where the division is located. |
| `state` | string | No | State or region where the division is located. |
| `address` | string | No | Street address of the division. |
| `zip_code` | string | No | Postal code (maximum 50 characters). |
| `division_id` | string | Yes | Debitura ID of the existing division whose profile will be fully replaced. |
| `company_name` | string | Yes | Division company name (maximum 200 characters). |
| `country_code` | string | Yes | Two-letter ISO 3166-1 country code. |
| `office_email` | string | No | Valid office email address (maximum 250 characters). |
| `office_phone` | string | No | Office phone number (maximum 50 characters). |
| `registration_number` | string | No | Company registration number (maximum 50 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |