Documentation
Documentation
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 amount is the total amount of the not paid items. The amount cannot be change once the case is reviewed.
  • Billing Address
    The billing address of the case identifies the debtor.
  • Closed On
    The closed on date indicates when the case is closed on.
  • Contract Date
    The contract date is the date on which the contract with the debtor was signed on.
  • Created On
    The created on date indicates the date on which the entity was stored into the database.
  • Creator
    The creator references the user which has created the debt collection case.
  • Currency
    The currency defines the billing currency of the debt collection case.
  • Debt Collector Configuration
    The collector configuration determines how the debt collection case is processed.
  • Due Date
    The due date indicates the date on which the amount receivable was due. This date has to be always in the past.
  • Environment
    The environment in which this case will be processed. There must be a debt collector configuration present which supports the chosen environment.
  • 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 failed on date indicates when the case is failed on.
  • Failure Reason
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Labels
  • Language
    The language indicates the language to be used in the communication with the debtor.
  • Line Items
    The line items of the debt collection case will be shown on documents sent to the debtor and the total of them makes up total amount to collect.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Next Attempt On
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • Processing Started On
    The processing started on date indicates the date on which the processing of the case started on.
  • Processing Timeout On
  • Reference
    The case reference is used in the communication with the debtor. It should be unique and it should be linkable with the source of the debt collection case.
  • Review Started On
  • Reviewed On
    The reviewed on date indicates when the review of the case was conducted on.
  • Reviewer
    The reviewer references the user which has reviewed the case.
  • Source
    The source of the debt collection case indicates the origin of the amount receivable.
  • Source Entity ID
    The source entity ID points to the object which is the origin of the debt collection case. This ID is only set when the case was triggered by an internal process.
  • Space View
  • State
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.