Documentation
Documentation
    • English (United States)
Debt Collection Case
Close API Documentation
Debt Collection Case

The debt collection case represents a try to collect the money from the debtor.

States
  • Create
    The create state is set while the case is created.
  • Preparing
    The debt collection case is being prepared.
  • Pending
    The pending state indicates that the processing of the case is imminent.
  • Processing
    In the processing state the collector tries to collect the money from the debtor.
  • Closed
    The close state indicates that the collector has closed the case. The collected amount on the case indicates how much the collector was able to retain from the debtor.
  • Failed
    The processing of this case has failed. The failure has a technical cause.
  • Reviewing
    The review state allows to review the case before it is processed.
Properties
  • Amount
    The sum of all unpaid item prices in the case's currency. The amount can no longer be changed once the case has been reviewed.
  • Billing Address
    The billing address that identifies the debtor.
  • Closed On
    The date and time when the case was closed.
  • Contract Date
    The date and time when the contract with the debtor was signed.
  • Created On
    The date and time when the object was created.
  • Creator
    The ID of the user the case was created by.
  • Currency
    The three-letter code (ISO 4217 format) of the case's currency.
  • Debt Collector Configuration
    The configuration that the case is processed with.
  • Due Date
    The date and time when the claim was due.
  • Environment
    The environment in which the case is processed.
  • External ID
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • Failed On
    The date and time when the case failed.
  • Failure Reason
    The reason for the failure of the case.
  • ID
    A unique identifier for the object.
  • Labels
    The labels providing additional information about the object.
  • Language
    The language that is linked to the object.
  • Line Items
    The line items that are subject of this debt collection case.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Next Attempt On
    The date and time when the next attempt at processing the case will be made.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Processing Started On
    The date and time when the processing of the case was started.
  • Processing Timeout On
    The date and time when the processing of the case times out.
  • Reference
    A unique reference to identify the debt collection case in communication with the debtor.
  • Review Started On
    The date and time when the review of the case was started.
  • Reviewed On
    The date and time when the case was reviewed.
  • Reviewer
    The ID of the user the case was reviewed by.
  • Source
    The source of the case stating the origin of the claim.
  • Source Entity ID
    The ID of the object that is the source of the case. Only defined if the case was created by an internal process.
  • Space View ID
    The ID of the space view this object is linked to.
  • State
    The object's current state.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.