For the complete documentation index, see llms.txt. This page is also available as Markdown.

Procurement | Approval Requests

Get a list of approval requests with different filters

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters
assignedTointeger · int32Optional

Return all approval requests that are assigned to a specific person

assignedToGroupinteger · int32Optional

Return all approval requests that are assigned to a specific person

requestedByinteger · int32Optional

Not implemented!

procurementRequestinteger · int32Optional
statusstring[]Optional

Not implemented!

searchstringOptional
pageinteger · int32Optional

Not implemented!

Default: 1
pageSizeinteger · int32Optional

Not implemented!

Default: 500
Responses
200

OK

application/json
totalinteger · int32Required
get/v1/procurement/approval-requests
post
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Body

Create a new approval request task. This task can be assigned to a specific employee or a group of employees. An approval task can be linked to a cart item (procurement request).

Responses
200

OK

application/json
totalinteger · int32Required
post/v1/procurement/approval-requests
get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
idinteger · int32Required
Query parameters
languagestringOptional
Responses
200

OK

application/json
totalinteger · int32Required
get/v1/procurement/approval-requests/{id}
patch
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
idinteger · int32Required
Body
Responses
200

OK

application/json
totalinteger · int32Required
patch/v1/procurement/approval-requests/{id}
get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
idinteger · int32Required
Responses
200

OK

application/json
totalinteger · int32Required
get/v1/procurement/approval-requests/{id}/history

Get the participants (authorizing employees) assigned to an approval request.

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
idinteger · int32Required
Responses
200

OK

application/json

HATEOAS representation of the participant collection of an approval request. The Self link points to the participants collection sub-resource.

totalinteger · int32Required
get/v1/procurement/approval-requests/{id}/participants

Add one or more participants (authorizing employees) to an existing approval request.

post
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
idinteger · int32Required
Body

Request payload for adding one or more participants (authorizing employees) to an existing approval request.

participantsinteger · int32[] · nullableOptional

The employee IDs that should be added as participants to the approval request.

typestring · enumOptional

Scope of an ApprovalRequest <> Employee assignment. Approvers are the visible, counted participants; observers are scoped in (they can see and act on the request) but are never returned or counted as participants.

Possible values:
Responses
200

OK

application/json

HATEOAS representation of the participant collection of an approval request. The Self link points to the participants collection sub-resource.

totalinteger · int32Required
post/v1/procurement/approval-requests/{id}/participants

Remove a single participant (authorizing employee) from an existing approval request.

delete
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
idinteger · int32Required
employeeIdinteger · int32Required
Responses
204

No Content

No content

delete/v1/procurement/approval-requests/{id}/participants/{employeeId}

No content

Get a list of approval requests with different filters

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters
assignedToGroupinteger · int32Optional

Return all approval requests that are assigned to a specific person

requestedByMebooleanOptionalDefault: false
statusstringOptional

Not implemented!

languagestringOptional

User's selected Language

Responses
200

OK

application/json
totalinteger · int32Required
get/v1/procurement/my-approval-requests
get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Responses
200

OK

application/json
totalinteger · int32Required
get/v1/procurement/pending-approval-requests

Last updated

Was this helpful?