Ticket Details Functionality

The Ticket Details functionality allows updating various parameters related to different ticket types. Each ticket type has its own set of details classes.

This section describes the key actions for handling ticket details, such as updating litigation tickets, general tickets, tenant search tickets, and sales tickets.

Litigation Ticket Details

Litigation ticket details allow managing financial details related to litigation.

Fields:

  • litigationPaidAmount: The amount already paid.
  • litigationUnPaidAmount: The remaining unpaid amount.

API Endpoint:

To patch litigation ticket details, use the following API endpoint:

PATCH /tickets/{id}/details

For more detailed API documentation and request/response examples, please refer to the Swagger documentation here.

General Ticket Details

General ticket details manage multiple financial and quantitative fields for a general ticket.

Fields:

  • fees: Quantity of fees related to the ticket.
  • workAmountWithoutTaxes: The work amount excluding taxes.
  • workAmountWithTaxes: The work amount including taxes.
  • valueIncrease: Value increase related to the ticket.
  • valueLoss: Value loss related to the ticket.
  • workingSurface: The surface area involved in the work.
  • amountPerSquareMeter: The cost per square meter of work.
  • workBudget: Total budget for the work.
  • insuranceIndemnity: Insurance compensation amount.

API Endpoint:

To patch general ticket details, use the following API endpoint:

PATCH /tickets/{id}/details

For more detailed API documentation and request/response examples, please refer to the Swagger documentation here.

Sales Ticket Details

Sales ticket details allow managing financial details related to sales activities.

Fields:

  • marketingAmount: The amount allocated for marketing.
  • transferAmount: The amount related to property transfer.
  • totalFeeAmount: Total fee amount involved.
  • sellerFeeAmount: Fee allocated to the seller.
  • buyerFeeAmount: Fee allocated to the buyer.
  • buyer: The buyer object for the sales ticket.

API Endpoint:

To patch sales ticket details, use the following API endpoint:

PATCH /tickets/{id}/details

For more detailed API documentation and request/response examples, please refer to the Swagger documentation here.

Tenant Search Ticket Details

Tenant search ticket details manage rental-related information for tenant searches.

Fields:

  • rentAmount: The rental amount for the tenant.
  • rentDepositAmount: The deposit amount for the rent.

API Endpoint:

To patch tenant search ticket details, use the following API endpoint:

PATCH /tickets/{id}/details

For more detailed API documentation and request/response examples, please refer to the Swagger documentation here.

Transition Input

For all ticket types, the transitionInput field is used to indicate the transition operation for the ticket state. This value triggers state machine transitions based on the provided input.