Base APIs
Lists objects that have pending approval messages
HTTP method | GET |
URI | https://api.rambase.net/base/objects-pending-approval?regardingItemId={itm}&includeRequestsByCurrentUser={includeRequestsByCurrentUser}&includeAllEmployeesApprovals={includeAllEmployeesApprovals} |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Successful HTTP status code | 200 |
API resource identifier | 5584, version 18 |
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.
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.
regardingItemId Integer, optional | Query parameter for limiting notifications to specific item. Blank query parameter will hide all notifications regarding specific items. |
includeRequestsByCurrentUser Boolean, optional | Include approval requests that have been requested by current user |
includeAllEmployeesApprovals Boolean, optional | Include all pending approval requests in the company for all users, including those that have not been requested by current user or sent to currents users approval groups. Will also include those sent by current user. Permission 'ViewAllPendingApprovalRequests' is required. |
$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] |
$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 |
$expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
$select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
$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. |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
$pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
$filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
$orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
$inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
IsUrgent() Named filter | Requested priority of the approval request. |
SentToCurrentUser() Named filter | Approval requests sent to current user |
ApprovalPriority Integer | Requested priority of the approval request. |
ApprovalRequestComment String | Message entered by the user when requesting approval. |
ApprovalResponseComment String | Message entered by the user when approving or denying the approval request. |
ApprovedAt Datetime | Date and time of approvel. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
ApprovedBy Integer | Employee identifier. |
ApproverId Integer | User identifier. Available macros: currentUser() |
Category String | Category of notification type (warning, information etc). |
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
CreatedBy Integer | User identifier. |
CustomerFirstName String | Secondary name of a company or firstname of a person. |
CustomerId Integer | Customer identifier. |
CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person). |
ForwardNotifications Boolean | True if notifications created with this definition will be forwarded when the owner object is forwarded. |
IsApproved Boolean | True if the notification needs approval, and is approved. |
NotificationId Integer | Notification identifier. |
NotificationTypeId String | Notification type identifier. |
ObjectId Integer | Identifier of the object. |
ObjectStatus Integer | Status of the item/object. |
ObjectType String | Type of object. |
Priority String | Priority of notification with this notification type. |
Quantity Decimal | Item quantity. |
Status Integer | Status of the notification. |
SupplierFirstName String | Firstname/givenname if the supplier is a person. |
SupplierId Integer | RamBase supplier identifier. |
SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person). |
Read more about filters and sorting on how to use sortable parameters
ApprovalPriority Integer | Requested priority of the approval request. |
ApprovalRequestComment String | Message entered by the user when requesting approval |
ApprovalResponseComment String | Message entered by the user when approving or denying the approval request |
ApprovedAt Datetime | Date and time of approvel. |
ApprovedBy Integer | Employee identifier |
ApproverId Integer | User identifier |
Category String | Category of notification type (warning, information etc) |
CreatedAt Datetime | Date and time of creation |
CreatedBy Integer | User identifier |
CustomerFirstName String | Secondary name of a company or firstname of a person |
CustomerId Integer | Customer identifier |
CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person) |
ForwardNotifications Boolean | True if notifications created with this definition will be forwarded when the owner object is forwarded. |
IsApproved Boolean | True if the notification needs approval, and is approved. |
NotificationId Integer | Notification identifier |
NotificationTypeId String | Notification type identifier |
ObjectId Integer | Identifier of the object |
ObjectStatus Integer | Status of the item/object. |
ObjectType String | Type of object |
Priority String | Priority of notification with this notification type. |
Quantity Decimal | Item quantity. |
Status Integer | Status of the notification |
SupplierFirstName String | Firstname/givenname if the supplier is a person |
SupplierId Integer | RamBase supplier identifier |
SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person) |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>Status
Status of the object
>{Integer}</Status>DueDate
Date the object is due to be paid
>{Date}</DueDate>Assignee
The user who has been assigned to work with this object.
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>Firstname
Firstname/givenname if the supplier is a person
>{String}</Firstname>SupplierLink
Supplier reference
>{String}</SupplierLink>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>Firstname
Secondary name of a company or firstname of a person
>{String}</Firstname>CustomerLink
Customer reference
>{String}</CustomerLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>Status
Status of the item/object.
>{Integer}</Status>Quantity
Item quantity.
>{Decimal}</Quantity>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>ItemLink
API reference to the item
>{String}</ItemLink>NotificationTypeId
Notification type identifier
>{String}</NotificationTypeId>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>NotificationTypeLink
Notification type reference
>{String}</NotificationTypeLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Status
Status of the object
": "{Integer}",DueDate
Date the object is due to be paid
": "{Date}"Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",Firstname
Firstname/givenname if the supplier is a person
": "{String}",SupplierLink
Supplier reference
": "{String}"CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",Firstname
Secondary name of a company or firstname of a person
": "{String}",CustomerLink
Customer reference
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}"ItemId
Item-number of the object
": "{Integer}",Status
Status of the item/object.
": "{Integer}",Quantity
Item quantity.
": "{Decimal}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",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}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}"ItemLink
API reference to the item
": "{String}"NotificationTypeId
Notification type identifier
": "{String}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",NotificationTypeLink
Notification type reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 101746 HTTP 404 | Product structure not found. Id: {0} |
Error 102267 HTTP 404 | Product structure operation not found |
Error 102746 HTTP 400 | The parameter value can not be more than {0} |
Error 102747 HTTP 400 | Error in formula: {0} |
Error 105186 HTTP 400 | Postings are not allowed on control accounts. |
Error 101490 HTTP 400 | Illegal Account {0}: This account has been blocked for {1}-documents |
Error 101491 HTTP 400 | Illegal Account {0}: Check the account's FromPeriod and ToPeriod |
Error 101517 HTTP 400 | Illegal Account {0}: This account require ICTDB. |
Error 102482 HTTP 400 | Department is required for general ledger account {0} |
Error 102483 HTTP 400 | Finance project is required for general ledger account {0} |
Error 102484 HTTP 400 | Asset is required for general ledger account {0} |
Error 102485 HTTP 400 | Dimension {0} ({1}) is required for general ledger account {2} |
Error 101313 HTTP 400 | Department number is not valid: {0} |
Error 101320 HTTP 400 | The project number is not valid: {0} |
Error 101500 HTTP 400 | Project {0} could not be used : Check project FromPeriod and ToPeriod. |
Error 101501 HTTP 400 | Asset is not allowed on general ledger account {0} |
Error 101326 HTTP 400 | The asset number is not valid : {0} |
Error 102486 HTTP 400 | Invalid value for dimension {0} |