Exemption Certificate Management

CertCapture RESTful APIs

ClassificationSettingsOutputModel

API response for classification settings, including optimistic versioning and pipeline state.

Parameters
companyIdOptional
integer

Company that owns the settings row.

modeOptional
string

Current classification mode.

criteriaOptional
ClassificationCriteriaModel

Criteria flags when in partial-auto mode.

countryScopeOptional
CountryScopeModel

Configured country scope.

settingsVersionOptional
integer

Monotonic settings version; increments when IMS updates the row.

processingStateOptional
string

created immediately after create/update from this API; downstream may set processing then completed.

processingVersionOptional
integer

Processing attempt counter aligned with downstream jobs.

processingStartedDateOptional
string

Set when IMS create/update last wrote the row (enters created).

processingCompletedDateOptional
string

Set by the downstream completion service when state becomes completed; null until then.

processingNoteOptional
string

Optional pipeline note (processingnote on dbo.itemclassificationsettings).

createdUserIdOptional
integer

User id that created the row.

createdDateOptional
string

UTC creation timestamp.

modifiedUserIdOptional
integer

User id for the last modification.

modifiedDateOptional
string

UTC last modification timestamp.