Sales

Archives a Closed sale whose accomplishment is Completed by setting its status to Archived (61). The optional notes (up to 2000 characters, no < or >) become the text of the file's ARCHIVE log entry. Returns 403 if the caller's role lacks the ArchiveFiles permission (by default only Broker, Auditor and Non-Approving Auditor have it), and 422 if the sale is not Closed and Completed, including when it is already Archived, or if the body is present but is not a single JSON object whose notes is a string.

Validation & Requirements

Required Parameters

  • saleGuid (path, string, format=guid)

Required JSON Body Fields

  • None

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}/archive

Request

  • Base URL
    https://api.skyslope.com
  • Auth
    OpenID Connect (https://example.com/.well-known/openid-configuration)

Path parameters

saleGuidstring guid required

GUID of the sale to archive.

Request body

notesstring nullable

Response

valueArchiveSaleResponse
warningsstring[] nullable

Changes