Customer

Property NameProperty ValueProperty Description
DisplayAsStringGets a display as value. Max Length=64. Is required.
NameStringCustomer's name. Max Length=64. Is required.
WorkZone{WorkZone entity reference}Community, the Work Zone to which Customer belongs. Is required.
DbaStringGets a DBA (Doing business as) value. Max Length=64. Is required.
InstructionsStringService instructions to relay to team members who are visiting this customer, HTML content supported. Max Length=3072.
TenantCodeStringGets a tenant code - unique number, usually used to map customer to external system. Max Length=64. Is required.
TaxExemptBooleanGets a value indicating whether this customer can be defined as tax exemption, True means Customer doesn't pay sales taxes (used by Customer Invoices). Is required.
Spaces[{Space entity reference}, ...]Spaces. Space (sometimes called Location) is occupancy record connecting Customer and Unit. Space means that Customer occupies particular Unit Asset.
Contacts[{Contact entity reference}, ...]Contacts are persons who are working for Customer and who actively participate in Work Order lifecycle. Is required.
CustomFields[{CustomField2 entity reference}, ...]Custom Fields
Notes[{Note entity reference}, ...]Notes
Addresses[{Address2 entity reference}, ...]Zero or one Street Address. Is required.
Contract{Contract entity reference}Default Financial contract assigned when work order is created for this customer, if it's not defined - the work zone contract will be used. Contract affects costs, vendor invoice/WON, charges etc.
GroupsBridge[{LinkCustomerAndGroup entity reference}, ...]Customer Groups. Is required.
ApprovalScopes[{ApprovalScope entity reference}, ...]
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.
Properties[{PropertyTreeNode object reference}, ...]List of filled properties
LimitMultipleEntitiesNumberBehaviourBooleanReturn exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API