Skip to main content
Debitura logo
  • Category: accounting
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 11
  • Triggers: 0
  • Slug: DEBITURA
  • Version: 20261030_00

Tools

Slug: DEBITURA_CHECK_CASE_ELIGIBILITYCheck 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_CREATE_DIVISIONCreate a creditor division with its company, address, and office contact profile.

Input Parameters

string
required
City where the division is located.
string
State or region where the division is located.
string
Street address of the division.
string
Postal code (maximum 50 characters).
string
required
Division company name (maximum 200 characters).
string
required
Two-letter ISO 3166-1 country code.
string
Valid office email address (maximum 250 characters).
string
Office phone number (maximum 50 characters).
string
Optional idempotency key retained by Debitura for 24 hours. Reuse the same key only when retrying the same create request.
string
Company registration number (maximum 50 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_GET_CASE_CONTEXTGet 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

string
Debitura case ID. Provide exactly one of case_id, case_reference, or creditor_reference.
array
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.
array
Optional task type filters used when tasks are included.
string ("Open" | "Solved")
Status used when tasks are included.
string
Debitura’s case reference, for example Q8OAXF3W. Provide exactly one lookup field.
string
The creditor’s own unique case reference. Provide exactly one lookup field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_GET_CREDITOR_STATUSReturn the connected creditor profile together with debt-collection contract onboarding status and any signing URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_LIST_DIVISIONSList creditor divisions, optionally including archived divisions. Returns one page and an opaque continuation cursor.

Input Parameters

integer
Maximum divisions to return in this page (1-100).
string
Opaque continuation cursor returned by a previous call. Pass it unchanged; omit it for the first page.
boolean
Include archived divisions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_LIST_PAYMENTSList payments across all creditor cases. Returns one page and an opaque continuation cursor.

Input Parameters

integer
Maximum payments to return in this page (1-100).
string
Opaque continuation cursor returned by a previous call. Pass it unchanged; omit it for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_LIST_TASKSList 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_PREVIEW_CASEPreview 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

string
Invoice due date used for age pricing. It cannot be in the future and cannot be combined with age-bucket amounts.
string
Absolute HTTP(S) URL to return to after the creditor completes a signing handoff.
string ("Company" | "Private")
required
Whether the debtor is a company or a private person.
string
Two-letter US state code. Required when country_alpha2 is US.
string
required
Three-letter ISO 4217 currency code.
string
required
Two-letter ISO 3166-1 debtor country code.
number
required
Total principal amount to recover.
number
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.
number
Portion over twelve months overdue. Supply it together with the 24-month amount; it cannot exceed the total.
number
Portion over twenty-four months overdue. Supply it together with the 12-month amount; it cannot exceed that amount.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_SEARCH_CASESSearch 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_SEARCH_COVERAGEFind 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

string
Optional two-letter US state code. Requires country_alpha2=‘US’.
string
Two-letter ISO 3166-1 country code used to filter the coverage catalog.
integer
Exact Debitura jurisdiction ID. Mutually exclusive with country_alpha2 and state_alpha2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEBITURA_UPDATE_DIVISIONFully replace an existing creditor division’s editable company, address, and office contact profile. All required profile fields must be supplied.

Input Parameters

string
required
City where the division is located.
string
State or region where the division is located.
string
Street address of the division.
string
Postal code (maximum 50 characters).
string
required
Debitura ID of the existing division whose profile will be fully replaced.
string
required
Division company name (maximum 200 characters).
string
required
Two-letter ISO 3166-1 country code.
string
Valid office email address (maximum 250 characters).
string
Office phone number (maximum 50 characters).
string
Company registration number (maximum 50 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not