latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Sale CDA document data

Update CDA document data

Saves CDA document data for a Sale. Field definitions are always resolved from the Forms API on save.

Validation & Requirements

Required Parameters

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

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

Path parameters

saleGuidstring guid required

GUID of the sale.

Request body

formsFileIdinteger nullable
{"stackTrail":"components:schemas:SetCdaDocumentDataForm:properties:documentData","oasType":"schema","type":"unknown","nullable":true}

Response

warningsstring[] nullable