Claim (CL)


The Claim entity is the header of the Claim document.

Fields

  • uniqueName – Document ID.

  • claimType – uniqueName of the Claim Type which is used to process this Claim document.

  • customerId – ID of the customer/distributor from whom this Claim is.

  • claimRecord – ID of the Claim Record which was generated for this Claim document after the Claim was approved.

  • claimStatus – Status of the document.

    • Draft – When the Claim is new, submitted and waiting for approval, or denied.

    • Approved – Either if no approval was needed or if it was approved by approvers.

    • Revoked – Manually revoked by user.

  • workflowStatus – See WorkflowStatus.

Since version 15.0, it is no longer possible to store null labels. Any API request attempting to do so will result in an error. However, it is still possible to store an empty string value, as this case is handled by the application's frontend validation.