Proposals

Escalate a proposal

Escalates the specified proposal to another user in the subscriber’s multi-level proposal (MLP) approval hierarchy. The proposal can be approved, rejected, put on hold, or returned upon escalation. You can attach an existing work order or create a new one while submitting the request. <br />Note: This method is only available to subscribers with the MLP setting enabled. <br />MLP users can escalate a proposal if the following conditions are met:  • The user's approval level corresponds to the proposal level.  • The Override option is enabled for the user in case their level is higher than the proposal level. <br />Example Request

            PUT /proposals/{proposalId}/escalate
            {
               "Action": "Approve",
               "WoType": 2,
               "TrackingNumber": 140324907,
               "PoNumber": "",
               "ExistingPoNumber": "",
               "Category": "",
               "CategoryId": ,
               "ApprovalCode": "",
               "Priority": "",
               "Comment": "Escalating proposal to the General Manager",
               "RejectReasonCodeId": 0,
               "ReasonString": "",
               "EmailsToNotify": "john.smith@domain.com",
               "EmailMyself": false,
               "MyEmail": "",
               "ProposalId": 10010836
            }
put/proposals/{proposalId}/escalate

Request

Path parameters

proposalIdinteger required

The unique numeric identifier of the proposal to escalate.

Request body

Actionstring required

Proposal escalation action. Valid values: Approve, Reject, OnHold, Return.

WoTypeinteger

Work order type. Valid values: 0 — Origin, 1 — New, 2 — Existing.

TrackingNumberinteger

The unique numeric identifier of the work order. Required if the WoType is 2 — Existing.

PoNumberstring

Purchase order number.

ExistingPoNumberstring

The existing purchase order number. If the PoNumber parameter is passed, its value is used instead of ExistingPoNumber.

Categorystring

The overall classification of a WO, such as Maintenance, Repair, or CAPEX. Required if the WoType is 1 — New. The value you enter must be a valid category.

CategoryIdinteger

Numeric identifier of the category.

ApprovalCodestring

Approval code, or GL code, used when approving an invoice.

Prioritystring

Period during which a service provider should check in to perform the requested service. Required if the WoType is 1 — New. The value you enter must be a valid priority.

PriorityIdinteger

Numeric identifier of the Priority.

WoRecallboolean

The WO has been marked as recall.

AttachmentsToWOboolean

Move Approved Proposal attachments to WO.

Commentstring

Your comment describing why you are escalating the proposal.

RejectReasonCodeIdinteger

Numeric identifier of the reason for rejecting the proposal. Don’t pass when escalating the proposal.

ReasonStringstring

Reason for approving the proposal.

EmailsToNotifystring

The email address of the user to notify about the proposal escalation. When entering multiple addresses, separate them with a comma or semicolon.

EmailMyselfboolean

Defines if the proposal escalation notification is sent to the current user.

MyEmailstring

The email address of the current user to which a proposal escalation notification is sent.

ProposalIdinteger

The unique numeric identifier of the proposal to escalate.

DeleteLabelboolean

Is WorkOrder Label to delete.

Actorstring

The Actor is added to the work order note.

IsLinkToOriginatingWorkOrderboolean

Link To Originating WorkOrder flag

PinNoteboolean

Pin User note on WorkOrder

Response

The specified proposal is escalated and updated with the passed parameters. The response is intentionally blank.

Changes

No recorded changes to this operation across all 1 revision of this API.