Procurement APIs
Creates a new rule for automatic approval of purchase contracts
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/contracts/{purchaseContractId}/auto-approval-rules |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseContractId} |
Purchase contract identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 6782, version 2 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
ApprovalRule
Required/mandatory field
Approval rule reference
>ApprovalRuleId
Required/mandatory field
Approval rule identifier
Minimum value: 100000
>{Integer}</ApprovalRuleId>Product
Required/mandatory field
Product reference
>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>EffectiveDate
Required/mandatory field
The date from which the approval rule is active
>{Date}</EffectiveDate>ExpirationDate
Required/mandatory field
The date to which the approval rule is active
>{Date}</ExpirationDate>ApprovalRule
Required/mandatory field
Approval rule reference
": {ApprovalRuleId
Required/mandatory field
Approval rule identifier
Minimum value: 100000
": "{Integer}"Product
Required/mandatory field
Product reference
": {ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"EffectiveDate
Required/mandatory field
The date from which the approval rule is active
": "{Date}",ExpirationDate
Required/mandatory field
The date to which the approval rule is active
": "{Date}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
AutoApprovalRuleId
Item reference number
>{Integer}</AutoApprovalRuleId>Status
Status of an auto approval rule
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>ApprovalRule
Approval rule reference
>ApprovalRuleId
Approval rule identifier
>{Integer}</ApprovalRuleId>Name
Name of the approval rule
>{String}</Name>Description
Approval rule description
>{String}</Description>ApprovalRuleLink
Approval rule reference
>{String}</ApprovalRuleLink>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>EffectiveDate
The date from which the approval rule is active
>{Date}</EffectiveDate>ExpirationDate
The date to which the approval rule is active
>{Date}</ExpirationDate>CreatedBy
User reference
>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>AutoApprovalRuleLink
Auto approval rule reference
>{String}</AutoApprovalRuleLink>AutoApprovalRuleId
Item reference number
": "{Integer}",Status
Status of an auto approval rule
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",ApprovalRule
Approval rule reference
": {ApprovalRuleId
Approval rule identifier
": "{Integer}",Name
Name of the approval rule
": "{String}",Description
Approval rule description
": "{String}",ApprovalRuleLink
Approval rule reference
": "{String}"Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"EffectiveDate
The date from which the approval rule is active
": "{Date}",ExpirationDate
The date to which the approval rule is active
": "{Date}"CreatedBy
User reference
": {UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}"AutoApprovalRuleLink
Auto approval rule reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100089 HTTP 404 | Product {0} not found |
| Error 109640 HTTP 400 | Expiration date is mandatory |
| Error 109641 HTTP 400 | Effective date cannot be greater that expiration date |
| Error 109664 HTTP 400 | Only one auto approval rule with the same parameters can be in effect at a time. |