Get All Transactions within a Period of Time

Responses

• 200 Successfully returning data.
  sortNumber

  integer

  This number provides an order to all transactions returned in each request. It starts with 0 and will be incremented by 1 for each further transaction.

  id

  string

  This represents a unique id per transaction.

  type

  string

  Max length: 20

  Enum:

  • CONFIRMATION
  • REJECTION
  • STATUS
  • ACCOUNTING_DOCUMENT
  • CLOSING

  customerNumber

  string

  claimNumber

  string

  confirmation

  object

  date

  string

  yyyy-MM-dd

  Max length: 10

  The date of the confirmation.

  type

  string

  Max length: 20

  Enum:

  • INVOICE
  • CLIENT_INTERESTS
  • CLIENT_COSTS
  • CREDIT_WAIVER
  • DIRECT_PAYMENT
  • RECALL
  • CANCELLATION
  • DOCUMENT

  number

  string

  Max length: 40

  Number of the payment, provided by the client or the agency

  contractNumber

  string

  Max length: 40

  Number of the payment, provided by the client or the agency

  amount

  number

  Max length: 12

  currency

  string

  Max length: 3

  This reflects all relevant currencies in ISO-4217.

  rejection

  object

  date

  string

  yyyy-MM-dd

  Max length: 10

  The date of the rejection.

  type

  string

  Max length: 20

  Enum:

  • INVOICE
  • CLIENT_INTERESTS
  • CLIENT_COSTS
  • CREDIT_WAIVER
  • DIRECT_PAYMENT
  • RECALL
  • CANCELLATION
  • DOCUMENT

  description

  string

  Max length: 512

  Free text describing the rejection.

  number

  string

  Max length: 40

  Number of the payment, provided by the client or the agency

  contractNumber

  string

  Max length: 40

  Number of the payment, provided by the client or the agency

  amount

  number

  Max length: 12

  currency

  string

  Max length: 3

  This reflects all relevant currencies in ISO-4217.

  reason

  string

  Max length: 20

  Enum:

  • AMOUNT_TOO_LOW
  • AMOUNT_TOO_HIGH
  • CLAIM_NOT_PLAUSIBLE
  • BREACH_OF_CONTRACT
  • CONTRAVENTION
  • INSOLVENCY
  • INCORRECT_CURRENCY
  • NO_ASSIGNMENT_POSSIBLE
  • CUSTOMER_INCAPABLE_OF_CONTRACTING
  • CUSTOMER_ABROAD
  • FRAUD_KNOWN
  • OTHER

  The reason `OTHER` is used if it cannot be clearly assigned to one of the specific reasons. Further information can then be found in the field `description`.

  closing

  object

  date

  string

  yyyy-MM-dd

  Max length: 10

  The date of the closing.

  type

  string

  Max length: 20

  Enum:

  • IRRECOVERABLE
  • POOR_CREDIT_RATING
  • WRITE_OFF
  • PARTIAL_SUCCESS
  • RECALLED_BY_CLIENT
  • FRAUD
  • FULL_PAYMENT
  • UNKNOWN_ADDRESS
  • CLAIM_DISPUTED
  • DEBTOR_LIVING_ABROAD
  • CUSTOMER_INCAPABLE_OF_CONTRACTING
  • RETURNED_TO_CLIENT
  • COMPANY_LIQUIDATED
  • INSOLVENCY
  • COMPLETED_BY_CREDIT
  • HIGH_COST_RISK
  • LONGTERM_MONITORING
  • SOLDIER
  • MISSING_DATA
  • NO_CONTRACT_DOCUMENTATION
  • CLAIM_DISMISSED
  • MINOR_DEBTOR
  • PERIOD_OF_LIMITATION_REACHED
  • TOO_LOW_FOR_LEGAL_ACTION
  • DEBTOR_DECEASED
  • PAYMENT_BEFORE_HANDOVER
  • SECOND_PLACEMENT
  • COMPLETED_BY_SETTLEMENT
  • NO_GOODS_OR_SERVICE_TRANSFER

  contractNumber

  string

  Max length: 40

  Number of the payment, provided by the client or the agency

  invoice

  object

  number

  string

  Max length: 40

  The invoice number assigned by the client which the transaction refers to.

  date

  string

  yyyy-MM-dd

  Max length: 10

  The date of the invoice.

  amount

  number

  Max length: 12

  This is a description of the transaction.

  accountingDocument

  object

  date

  string

  yyyy-MM-dd

  Max length: 10

  The value date of the accounting document.

  type

  string

  Max length: 20

  Enum:

  • DIRECT_PAYMENT
  • AGENCY_PAYMENT
  • CREDIT_WAIVER
  • DEBIT
  • WRITE_OFF
  • CANCELLATION
  • REALLOCATION

  number

  string

  Max length: 40

  Number of the accounting document, provided by the debt collection agency

  e2eReferenceNumber

  string

  Max length: 40

  Number of the payment or credit waiver, provided by the client

  originalType

  string

  Max length: 20

  Enum:

  • DIRECT_PAYMENT
  • AGENCY_PAYMENT
  • CREDIT_WAIVER
  • DEBIT
  • WRITE_OFF

  The original type of the accounting document, if it is a CANCELLATION or REALLOCATION.

  originalNumber

  string

  Max length: 40

  The original number of the accounting document, if it is a CANCELLATION or REALLOCATION.

  sourceAccountingDocumentNumber

  string

  Max length: 40

  This is document number of the very first document in the chain. If the document is the first in the chain (e.g. an initial payment or booking), then SourceAccountingDocumentNumber is set to its own document number (i.e. number). For all subsequent documents (reallocations, cancellations, etc.), sourceAccountingDocumentNumber must still reference the document number of the very first document in the chain (i.e. the original booking). CANCELLATION WITHOUT REALLOCATIONS: Given a claim exists for a mandate reported to the API, and a payment has a booking document (e.g. original document number - V123). When the payment is cancelled, Then the cancellation document (e.g. V456): 1. must include originalNumber as V123 (the original document number), 2. must include SourceAccountingDocumentNumber as V123 (the original document number). CANCELLATION AFTER REALLOCATIONS : Given a claim exists for a mandate reported to the API, and a payment has a booking document (e.g: original document number V123), and there is a reallocation document (e.g: V456) for the payment, When the payment is cancelled, Then the cancellation document (e.g: V789): 1. must include originalNumber as V456 (the last reallocation document number), 2. must include SourceAccountingDocumentNumber as V123 (the original document number, i.e. the first document in the chain).

  amount

  number

  Max length: 12

  currency

  string

  Max length: 3

  This reflects all relevant currencies in ISO-4217.

  lineItems

  array

  id

  string

  Max length: 40

  invoiceNumber

  string

  Max length: 40

  contractNumber

  string

  Max length: 40

  amount

  number

  Max length: 12

  This is a description of the transaction.

  allocateTo

  string

  Max length: 20

  Enum:

  • PRINCIPAL_CLAIM
  • CLIENT_INTERESTS
  • ACCRUED_INTERESTS
  • CLIENT_COSTS
  • COLLECTION_COSTS
  • EXPENSES
  • OVERPAYMENT
  • CUSTOMER_OVERPAYMENT

  The bucket to allocate the payment to. * `principalClaim` - Allocated to principal claim. * `interest` - Allocated to interest. * `fee` - Allocated to client fees. * `dunning` - Allocated to client dunning costs. * `collectionCost` - Allocated to collection cost. * `expense` - Allocated to agency expense.

  status

  object

  category

  string

  Max length: 20

  Enum:

  • COLLECTION
  • LONGTERM
  • INVESTIGATION
  • REGISTRATION
  • LEGAL
  • ENFORCEMENT
  • PAYMENT_AGREEMENT
  • COMPLAINT
  • DEBTOR_SITUATION

  Category of the status update COLLECTION = Collection process LONGTERM = Long-term process INVESTIGATION = Investigation (e. g. Address Research) REGISTRATION = Registration (e. g. Schufa Registration) LEGAL = Legal process ENFORCEMENT = Enforcement process PAYMENT AGREEMENT = Payment agreement (e. g. installment, deferment of payment) COMPLAINT = Complaint or Client Request DEBTOR_SITUATION = Information about debtor situation (like insolvency or other negative features)

  code

  string

  Max length: 255

  Code within the debt collection backend system.

  description

  string

  Max length: 255

  English Translation of the code that is used within the debt collection backend system.

  detail

  string

  Max length: 20

  Enum:

  • SUCCESSFUL
  • UNSUCCESSFUL
  • PARTIALLY_SUCCESSFUL
  • JUDICIAL_SETTLEMENT
  • NOT_POSSIBLE
  • UNDERLYING
  • BANK_ACCOUNT
  • WAGES_AND_SALARIES
  • TAX_REFUND
  • PENSION
  • INSTALLMENT
  • DEFERMENT
  • SETTLEMENT

  Detail information based on the stage LEGAL: SUCCESSFUL, PARTIALLY_SUCCESSFUL, JUDICIAL_SETTLEMENT, NOT_POSSIBLE, UNDERLYING ENFORCEMENT: BANK_ACCOUNT, WAGES_AND_SALARIES, TAX_REFUND, PENSION PAYMENT_AGREEMENT: INSTALLMENT, DEFERMENT, SETTLEMENT DEBTOR_SITUATION: SUCCESSFUL, UNSUCCESSFUL

  date

  string

  yyyy-MM-dd

  Max length: 10

  Date of the action.

  phase

  string

  Max length: 20

  Enum:

  • PRE_COLLECTION
  • COLLECTION
  • LEGAL
  • POST_LEGAL
  • SURVEILLANCE

  the phase in which the claim is in the recovery process

  amount

  number

  Max length: 12

  will be set if the stage is PAYMENT_AGREEMENT and is the amount of the installment, deferment or settlement.

  currency

  string

  Max length: 3

  will be set if the stage is PAYMENT_AGREEMENT. This reflects all relevant currencies in ISO-4217.

  followUpDate

  string

  yyyy-MM-dd

  Max length: 10

  Follow-Up Date (date of the next action that is planned) Please note that the next action changes in case there is an action from any other person (like debtor, client, bailiff etc)

  courtName

  string

  Max length: 255

  docketNumber

  string

  Max length: 255

  Reference number within the legal or enforcement process

  caseNumber

  string

  Max length: 255

  Bailiff's case reference number
• 400 An error occurred.
  errorId

  string

  Internal ID for tracing the error throughout systems.

  timestamp

  string

  statusCode

  integer

  This is the error code.

  message

  string

  fields

  array

  This are the error messages.

  message

  string

  name

  string

  ref

  string
• 401 Not authorized.
  errorId

  string

  Internal ID for tracing the error throughout systems.

  timestamp

  string

  statusCode

  integer

  This is the error code.

  message

  string

  fields

  array

  This are the error messages.

  message

  string

  name

  string

  ref

  string