Sales

Close sale

Closes a sale by setting its status to Closed (60) and recording the actual closing date. Returns 422 if the sale is already Closed, Archived, or a Dead Deal. Note: setting ActualClosingDate on PUT /api/files/sales/{id} also closes a sale implicitly — this endpoint is the preferred explicit form.

Validation & Requirements

Required Parameters

  • saleGuid (path, string, format=guid)
  • form (body, object)

Required JSON Body Fields

  • actualClosingDate (format=date-time, minLength=1)

Validations

  • Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
  • Invalid date values in *date* fields return 422 Unprocessable Entity.
  • Missing required request body returns 422 Unprocessable Entity with Missing request body..
  • Additional business-rule validation may return 422 with details in the errors array.

Integration Requirement

  • Retrieve the corresponding ...Form endpoint immediately before write operations to get current dynamic required fields and allowed values.
put/api/files/sales/{saleGuid}/close

Path parameters

saleGuidstring guid required

GUID of the sale to close.

Request body

actualClosingDatestring date-time required

Response

valueCloseSaleResponse
warningsstring[] nullable