Get a service ticket

reference

string

Conditional

Internal identifier of the service ticket. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values.

externalIdentifier

string

Conditional

External identifier of the service ticket, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values.

reference

string

Yes

Internal identifier of the service ticket, generated by Bloxs. Maximum length 100 characters.

externalIdentifier

string

No

External identifier of the service ticket, as set by the integrating system. Maximum length 100 characters.

externalLink

string

No

URL of the service ticket in a system outside of Bloxs, allowing quick navigation there without a separate search. Maximum length 256 characters.

reportingDate

string (date)

Yes

Date the service ticket was created. Not generated automatically; must be supplied at creation. ISO 8601 format.

stateName

string

Yes

Name of the ticket's current state. States are configurable in the Bloxs admin module. Maximum length 256 characters.

priority

integer

Yes

Priority of the report. Valid values are 1 (Low), 2 (Normal), or 3 (High). Fixed list, not configurable. Each priority level is linked to reminder settings that trigger tasks or emails at a defined frequency.

problemCategoryName

string

No

Problem category the ticket belongs to, indicating the type of issue, for example electrical or windows. Fixed list, not configurable. Maximum length 256 characters.

costsAreForTenant

boolean

No

Indicates whether the tenant is responsible for the costs of the ticket. Default value is false, meaning the owner is responsible.

costCategoryName

string

No

Cost category of the ticket, used to determine how the associated costs should be allocated, for example distinguishing a repair from a full replacement, or service charge costs from individual tenant charges. Fixed list, not configurable. Maximum length 256 characters.

description

string

Yes

Description of the reported problem.

realEstateObjectReference

string

Yes

Reference of the real estate object the ticket applies to. Maximum length 100 characters.

reporterReference

string

Yes

Reference of the relation to contact regarding the ticket. Must be an existing relation in Bloxs. Maximum length 100 characters.

reporterContactPersonReference

string

No

Reference of the contact person for communication about the ticket. Must be an existing relation in Bloxs. Only fill this in if the contact person is registered in Bloxs; otherwise use the reporterExternalContactPerson fields. Maximum length 100 characters.

reporterExternalContactPersonName

string

No

Name of the contact person, used only when the contact person is not registered in Bloxs. Maximum length 256 characters.

reporterExternalContactPersonPhoneNumber

string

No

Phone number of the contact person, used only when the contact person is not registered in Bloxs. Maximum length 512 characters.

reporterExternalContactPersonMobileNumber

string

No

Mobile phone number of the contact person, used only when the contact person is not registered in Bloxs. Maximum length 512 characters.

reporterExternalContactPersonEmail

string

No

Email address of the contact person, used only when the contact person is not registered in Bloxs. Maximum length 254 characters.

supplierReference

string

No

Reference of the supplier handling the ticket. Must be an existing relation in Bloxs. Maximum length 100 characters.

handledBySupplier

boolean

No

Indicates whether the supplier has accepted responsibility for resolving the ticket. If false, the supplier receives a reminder to accept or decline the order. Default value is false.

expectedCosts

number (double)

No

Estimated cost for resolving the issue.

mandateAmount

number (double)

No

Maximum amount for which the supplier has the mandate to resolve the issue underlying the ticket.

disableUIMutations

boolean

No

Indicates whether changes to the ticket are disabled in the Bloxs application. Default value is false, meaning changes are permitted.

disableSystemTasks

boolean

No

Indicates whether the system tasks triggered by the ticket's priority (such as required follow-up within a set number of hours) are disabled. Default value is false, meaning system tasks are active.

disableSystemCorrespondence

boolean

No

Indicates whether automatic system-generated correspondence for the ticket is disabled. Default value is false, meaning correspondence is sent automatically.

isVisibleInPortal_Owner

boolean

Yes

Indicates whether the ticket is visible in the Owner Portal. Only effective if the service ticket portal visibility feature is enabled for the environment.

isVisibleInPortal_Tenant

boolean

Yes

Indicates whether the ticket is visible in the Tenant Portal. Only effective if the service ticket portal visibility feature is enabled for the environment.