Skip to content

Contact Details

Representative Model Class Update Model Class Create Model Class
ContactDetails ContactDetailsUpdate ContactDetailsCreate

Contact Details and Members

Note that contact details can be created standalone (independently of members), but members are required to have a contact details object linked.

additionalAdressInfo class-attribute instance-attribute 

additionalAdressInfo: str | None = Field(default=None, max_length=128)

addressCompany class-attribute instance-attribute 

addressCompany: bool | None = None

balance class-attribute instance-attribute 

balance: float | None = None

bankAccountOwner class-attribute instance-attribute 

bankAccountOwner: str | None = Field(default=None, max_length=128)

bic class-attribute instance-attribute 

bic: str | None = Field(default=None, max_length=100)

city class-attribute instance-attribute 

city: str | None = Field(default=None, max_length=100)

companyCity class-attribute instance-attribute 

companyCity: str | None = Field(default=None, max_length=64)

companyCountry class-attribute instance-attribute 

companyCountry: str | None = Field(default=None, max_length=50)

companyEmail class-attribute instance-attribute 

companyEmail: EmailStr | None = None

companyEmailInvoice class-attribute instance-attribute 

companyEmailInvoice: EmailStr | None = None

companyName class-attribute instance-attribute 

companyName: str | None = None

companyPhone class-attribute instance-attribute 

companyPhone: str | None = Field(default=None, max_length=100)

companyState class-attribute instance-attribute 

companyState: str | None = Field(default=None, max_length=100)

companyStreet class-attribute instance-attribute 

companyStreet: str | None = Field(default=None, max_length=100)

companyZip class-attribute instance-attribute 

companyZip: str | None = Field(default=None, max_length=20)

copiedFromParent class-attribute instance-attribute 

copiedFromParent: Any | None = Field(default=None, alias='_copiedFromParent')

Alias for _copiedFromParent field. See Pydantic Models for details.

copiedFromParentEndDate class-attribute instance-attribute 

copiedFromParentEndDate: Any | None = Field(default=None, alias='_copiedFromParentEndDate')

Alias for _copiedFromParentEndDate field. See Pydantic Models for details.

copiedFromParentEndDateAction class-attribute instance-attribute 

copiedFromParentEndDateAction: Any | None = Field(default=None, alias='_copiedFromParentEndDateAction')

Alias for _copiedFromParentEndDateAction field. See Pydantic Models for details.

copiedFromParentStartDate class-attribute instance-attribute 

copiedFromParentStartDate: Any | None = Field(default=None, alias='_copiedFromParentStartDate')

Alias for _copiedFromParentStartDate field. See Pydantic Models for details.

country class-attribute instance-attribute 

country: str | None = Field(default=None, max_length=50)

dateOfBirth class-attribute instance-attribute 

dateOfBirth: Date | None = None

datevAccountNumber class-attribute instance-attribute 

datevAccountNumber: int | None = None

familyName class-attribute instance-attribute 

familyName: str | None = Field(default=None, max_length=128)

firstName class-attribute instance-attribute 

firstName: str | None = Field(default=None, max_length=128)

iban class-attribute instance-attribute 

iban: str | None = Field(default=None, max_length=50)

internalNote class-attribute instance-attribute 

internalNote: str | None = None

invoiceCompany class-attribute instance-attribute 

invoiceCompany: bool | None = None

isCompany class-attribute instance-attribute 

isCompany: bool | None = Field(default=None, alias='_isCompany')

Alias for _isCompany field. See Pydantic Models for details.

methodOfPayment class-attribute instance-attribute 

methodOfPayment: int | None = None

Defines the method of payment preferred by the user.

Possible values:

  • 0: not selected
  • 1: direct debit
  • 2: bank transfer
  • 3: cash
  • 4: other

mobilePhone class-attribute instance-attribute 

mobilePhone: str | None = Field(default=None, max_length=100)

nameAffix class-attribute instance-attribute 

nameAffix: str | None = Field(default=None, max_length=100)

preferredCommunicationWay class-attribute instance-attribute 

preferredCommunicationWay: Literal[0, 1, 2] | None = None

preferredEmailField class-attribute instance-attribute 

preferredEmailField: Literal[0, 1, 2] | None = Field(default=None, alias='_preferredEmailField')

Alias for _preferredEmailField field. See Pydantic Models for details.

Possible values:

  • 0: same as login
  • 1: private
  • 2: company

primaryEmail class-attribute instance-attribute 

primaryEmail: str | None = 'email'

privateEmail class-attribute instance-attribute 

privateEmail: EmailStr | None = None

privatePhone class-attribute instance-attribute 

privatePhone: str | None = Field(default=None, max_length=100)

professionalRole class-attribute instance-attribute 

professionalRole: str | None = Field(default=None, max_length=500)

salutation class-attribute instance-attribute 

salutation: Literal['', 'Herr', 'Frau'] | None = None

sendInvoiceCompanyMail class-attribute instance-attribute 

sendInvoiceCompanyMail: bool | None = None

sepaDate class-attribute instance-attribute 

sepaDate: DateTime | None = None

sepaMandate class-attribute instance-attribute 

sepaMandate: str | None = Field(default=None, max_length=60)

state class-attribute instance-attribute 

state: str | None = Field(default=None, max_length=64)

street class-attribute instance-attribute 

street: str | None = Field(default=None, max_length=128)

zip class-attribute instance-attribute 

zip: str | None = Field(default=None, max_length=20)