Debtors#

Debtors represent individuals or companies with outstanding debts. Debtor information is embedded within Collection Cases.

The Debtor object#

AttributeTypeDescription
typeenumcompany or private
namestringFull name or company name
contact_personstringContact person (companies only)
emailstringEmail address
phonestringPhone number
addressobjectPhysical address
address.line1stringStreet address
address.line2stringAdditional address line
address.citystringCity
address.statestringState/province
address.postal_codestringPostal code
address.countrystringISO 3166-1 alpha-2 country code
countrystringCountry of residence/registration
tax_idstringTax identification number
registration_numberstringCompany registration number

Private Debtor#

{
  "type": "private",
  "name": "John Smith",
  "email": "john.smith@example.com",
  "phone": "+49 170 1234567",
  "address": {
    "line1": "Friedrichstraße 123",
    "city": "Berlin",
    "postal_code": "10117",
    "country": "DE"
  },
  "country": "DE"
}

Company Debtor#

{
  "type": "company",
  "name": "Smith Enterprises GmbH",
  "contact_person": "John Smith",
  "email": "accounting@smithenterprises.de",
  "phone": "+49 30 9876543",
  "address": {
    "line1": "Unter den Linden 45",
    "city": "Berlin",
    "postal_code": "10117",
    "country": "DE"
  },
  "country": "DE",
  "tax_id": "DE123456789",
  "registration_number": "HRB 12345"
}