Accounts payableApproval policies

Update an approval policy

Update an existing approval policy.

Path parameters

approval_policy_idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
descriptionstringOptional

A brief description of the approval policy.

ends_atdatetimeOptional

The date and time (in the ISO 8601 format) when the approval policy stops being active and stops triggering approval workflows.If ends_at is provided in the request, then starts_at must also be provided and ends_at must be later than starts_at. The value will be converted to UTC.

namestringOptional

The name of the approval policy.

scriptlist of booleans or doubles or strings or lists of any or maps from strings to anyOptional

A list of JSON objects that represents the approval policy script. The script contains the logic that determines whether an action should be sent to approval. This field is required, and it should contain at least one script object.

starts_atdatetimeOptional

The date and time (in the ISO 8601 format) when the approval policy becomes active. Only payables submitted for approval during the policy’s active period will trigger this policy. If omitted or null, the policy is effective immediately. The value will be converted to UTC.

statusenumOptional

A string that represents the current status of the approval policy.

Allowed values:
triggerboolean or double or string or list of any or map from strings to anyOptional

A JSON object that represents the trigger for the approval policy. The trigger specifies the event that will trigger the policy to be evaluated.

Response

Successful Response

idstringformat: "uuid"
created_atdatetime
updated_atdatetime
created_bystringformat: "uuid"
namestring<=255 characters

The name of the approval policy.

scriptlist of booleans or doubles or strings or lists of any or maps from strings to any

A list of JSON objects that represents the approval policy script. The script contains the logic that determines whether an action should be sent to approval. This field is required, and it should contain at least one script object.

statusenum

The current status of the approval policy.

Allowed values:
descriptionstringOptional<=255 characters

A brief description of the approval policy.

ends_atdatetimeOptional

The date and time (in the ISO 8601 format) when the approval policy stops being active and stops triggering approval workflows.If ends_at is provided in the request, then starts_at must also be provided and ends_at must be later than starts_at. The value will be converted to UTC.

starts_atdatetimeOptional

The date and time (in the ISO 8601 format) when the approval policy becomes active. Only payables submitted for approval during the policy’s active period will trigger this policy. If omitted or null, the policy is effective immediately. The value will be converted to UTC.

triggerboolean or double or string or list of any or map from strings to anyOptional

A JSON object that represents the trigger for the approval policy. The trigger specifies the event that will trigger the policy to be evaluated.

updated_bystringOptionalformat: "uuid"

Errors