Work Confirmation Header API

Retrieve information about service sheets. You can query all service sheets or request information about a single sheet by its ID.

Overview

The Work Confirmation API allows you to retrieve information about service sheets.

The URL to access the Work Confirmation endpoint is: https://{your_instance_name}/api/work_confirmation/headers

For more information, see Create or Edit a Service Sheet.

Actions

The Work Confirmation API allows you to:

Verb

Path

Action

Description

GET

/api/work_confirmation/headers

index

Query service sheets.

GET

/api/work_confirmation/headers/:id

show

Query a single service sheet by ID.

POST

/api/work_confirmation/headers/:id/void

void

Submit a void request for an approved service sheet. Moves the sheet to pending_void status and starts the configured void approval chain.

PUT

/api/work_confirmation/headers/:id/add_approver

add_approver

Add an approver or watcher to a service sheet that is pending approval.

PUT

/api/work_confirmation/headers/:id/remove_approval

remove_approval

Remove an approver or watcher from a service sheet that is pending approval.

PUT

/api/work_confirmation/headers/:id/bypass_current_approval

bypass_current_approval

Skip the current approval step on a service sheet that is pending approval. Cannot be used on the last step in the approval chain.

Action Parameters

The following parameters apply to the action endpoints listed above.

POST /api/work_confirmation/headers/:id/void

The service sheet must be in Approved status and linked to an open order line. Only one pending void per service sheet is allowed at a time.

Parameter

Description

Required?

Data Type

reason_insight_code

Stable code identifying an active Reason Insight configured for service sheet void. Use this or reason_insight_id.

yes*

string

reason_insight_id

ID of an active Reason Insight configured for service sheet void. Use this or reason_insight_code.

yes*

integer

comments

Free-text explanation for the void request.

yes

string

* Provide either reason_insight_code or reason_insight_id, not both.

PUT /api/work_confirmation/headers/:id/add_approver

Parameter

Description

Required?

Data Type

approver_id

ID of the user to add as an approver or watcher.

yes

integer

position

Where to insert the approver in the chain. Accepted values: end_of_list, watcher.

no

string

PUT /api/work_confirmation/headers/:id/remove_approval

Parameter

Description

Required?

Data Type

approval_id

ID of the approval record to remove.

yes

integer

PUT /api/work_confirmation/headers/:id/bypass_current_approval

Cannot be used to bypass the last approval step in the chain. Returns a 422 error if the sheet is not in pending approval status or if the current step is the final one.

Parameter

Description

Required?

Data Type

approval_comment

Reason for bypassing the current approval step.

no

string

Elements

The following elements are available for the Work Confirmation API:

Element

Description

Required Field?

Unique?

Allowable Value

Api_In Field?

Api_Out Field?

Data Type

approvals

Service Sheet approvals

yes

Approval

comments

Service Sheet comments

yes

Comment

created-at

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

yes

datetime

created-by

User who created the service sheet

yes

User

created-by-fullname

Full name of the creator of the Purchase Order

yes

string

currency

Currency of the associated Purchase Order

yes

Currency

id

Coupa's Internal ID

yes

integer

lines

Service Sheet lines

yes

WorkConfirmation::Line

order-header

Associated Purchase Order header

yes

OrderHeader

order-total

Total amount of the associated Purchase Order

yes

decimal

order-total-received-amount

Total amount received against the associated Purchase Order

yes

decimal

po-number

Purchase Order of the service sheet

yes

string

requested-by-fullname

Full name of the requester of the Purchase Order

yes

string

status

Service Sheet Status

yes

string(255)

submitted-at

Timestamp record was submitted in Coupa

yes

datetime

supplier

Supplier

yes

Supplier

supplier-display-name

Supplier display name

yes

string

supplier-reviews

Service Sheet quality assessment reviews

yes

SupplierReview

total

Total service sheet amount

yes

decimal

updated-at

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

yes

datetime

updated-by

User who updated

yes

User