ChangeRegistrationOptions

Parameters for changing document registration

Allow changing the registration number, registration date, or both simultaneously for app items of the Document type.

Hierarchy

  • ChangeRegistrationOptions

Properties

Optional dateRegistration

dateRegistration: TDatetime

New registration date.

The date changes regardless of the folder setting Allow editing the number after registration. If not specified, the registration date does not change.

Optional ignoreNumberEditingRestriction

ignoreNumberEditingRestriction: undefined | false | true

Ignore the Allow editing number after registration setting.

The parameter only affects ChangeRegistrationOptions.numberRegistration. Registration number change result:

  • If the folder setting is enabled and the parameter is false or not specified—the number is changed.
  • If the folder setting is enabled and the parameter is true—the number is changed.
  • If the folder setting is disabled and the parameter is false or not specified—the change fails with an error.
  • If the folder setting is disabled and the parameter is true— the number is changed. If ChangeRegistrationOptions.numberRegistration is not specified, the parameter has no effect.

Optional numberRegistration

numberRegistration: undefined | string

New registration number.

If not specified, the registration number remains unchanged.