Module lexoffice::model::contacts [−][src]
This endpoint provides read access to contacts (e.g. customers, vendors). A contact can hold addresses, contact information (e.g. phone numbers, email addresses) and contact persons for company related contacts. It is also possible to use filters on the contacts collection.
Structs
Address | |
AddressBuilder | Builder for |
Addresses | Use this objects to provide billing and shipping information of a contact. |
AddressesBuilder | Builder for |
Company | Use this object to provide information for a contact of type company. |
CompanyBuilder | Builder for |
CompanyContactPerson | Please note that it’s only possible to create and change contacts with a maximum of one contact person. It’s possible to retrieve contacts with more than one contact person, but it’s not possible to update such a contact via the REST API. |
CompanyContactPersonBuilder | Builder for |
Contact | |
ContactBuilder | Builder for |
Customer | |
CustomerBuilder | Builder for |
EmailAddresses | Please note that it’s only possible to create and change contacts with a maximum of one entry in each of the below described lists. It’s possible to retrieve contacts with more than one entry in the lists, but it’s not possible to update such a contact via the REST API. |
EmailAddressesBuilder | Builder for |
Person | |
PersonBuilder | Builder for |
PhoneNumbers | Please note that it’s only possible to create and change contacts with a maximum of one entry in each of the below described lists. It’s possible to retrieve contacts with more than one entry in the lists, but it’s not possible to update such a contact via the REST API. |
PhoneNumbersBuilder | Builder for |
Roles | Contains a customer and/or a vendor object. The presence of a role in the JSON implies that the contact will have this role. For example, if the customer object is present, the contact has the role customer. Please note that each contact must have at least one role. |
RolesBuilder | Builder for |
Vendor | |
VendorBuilder | Builder for |
XRechnung | Contacts for German public authorities should be created with both of the following attributes set. This results in the generation of invoice documents conforming to the German XRechnung standard when creating invoices in lexoffice. |
XRechnungBuilder | Builder for |