Partially update a certificate

patch

https://ecm.cert.ceretax.net/certificates/{id}

Only the supplied fields are applied; child collections are reconciled against the stored certificate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

≥ 1

Certificate ID (positive integer)

Body Params

Create / update payload. stateId and formId are required on create
(POST) and full update (PUT); at least one customer is required. On
PATCH only the supplied fields are validated and applied. userId is the
portal user performing the write.

certificateId

integer

Optional on PUT/PATCH; when present it must match the path ID.

stateId

integer

≥ 1

authorityId

integer

formId

integer

≥ 1

formName

string

length ≤ 255

formVersionId

integer

certificateScope

string

scopeName

string

length ≤ 255

Normalized to a canonical name before it is persisted (projectNumber,
jobNumber, meter, invoiceNumber) so downstream consumers see one
spelling. Common variants are recognized case-, space- and
punctuation-insensitively — e.g. PRJ, PROJ, PN, P-No.,
Project #, project no. all persist as projectNumber; INV, INV#,
INVC, Invoice # as invoiceNumber; JOB, JB, JN, J-No. as
jobNumber; MTR, MET as meter. An unrecognized value is stored
verbatim.

scopeValue

string

length ≤ 255

purchaseItemsDescription

string

length ≤ 500

exemptionIdNumber

string

length ≤ 100

hasSignature

boolean

signature

string

length ≤ 65535

title

string

length ≤ 255

dateOfSignature

date | null

Required when a signature is present. Format YYYY-MM-DD; send null for absence (an empty string is rejected).

statusId

integer | null

effectiveFromDate

date | null

Required on create.

effectiveToDate

date | null

expirationDate

date | null

notes

string

length ≤ 2000

certificateVersion

integer

customers

array of objects

At least one customer is required; each must belong to the authenticated client.

customers

exemptionReasons

array of objects

exemptionReasons

exemptionStateIDs

array of objects

exemptionStateIDs

files

array of objects

files

userId

integer | null

Portal user performing the write (required and greater than 0 for update operations).

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Certificate updated

403Missing or unknown API key (code 1001)

404Resource not found (code 2021)

422Client-actionable error — validation failure, business-rule violation, or an unsupported HTTP method on this route.

500Internal server error (code 9000)