API

Base APIs

GET system/reports/112549/result-set

Objects sent for approval by current user, that have been reviewed and are ready for further processing.

Report name Objects sent for approval by current user - Review done
Report identifier 112549
HTTP method GET
URI https://api.rambase.net/system/reports/112549/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5866, version 7

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.

Format:
1
1

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.

$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.

OpenObjects() Named filter Open documents where status less than 9.
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).
ObjectId Integer Identifier of the object.
ObjectStatus Integer Status of the item/object.
ObjectType String Type of object.
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

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)
ObjectId Integer Identifier of the object
ObjectStatus Integer Status of the item/object.
ObjectType String Type of object
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.

Format:
1
<Report>
2
     <Rows>
3
          <Row>
4
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
5
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
6
               <Status
Status

Status of the object

>{Integer}</Status>
7
               <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
8
               <Payment
Payment

Payment reference

>
9
                    <DueDate
DueDate

Date the object is due to be paid

>{Date}</DueDate>
10
               </Payment>
11
               <Assignee
Assignee

The user who has been assigned to work with this object.

>
12
                    <UserId
UserId

User identifier

>{Integer}</UserId>
13
                    <Name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Assignee.Name in your request URI to get this field

>{String}</Name>
14
                    <FirstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Assignee.FirstName in your request URI to get this field

>{String}</FirstName>
15
                    <UserLink
UserLink

User reference

>{String}</UserLink>
16
               </Assignee>
17
               <Supplier
Supplier

Supplier reference

>
18
                    <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
19
                    <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
20
                    <Firstname
Firstname

Firstname/givenname if the supplier is a person

>{String}</Firstname>
21
                    <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
22
               </Supplier>
23
               <Customer
Customer

Customer reference

>
24
                    <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
25
                    <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
26
                    <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
27
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
28
               </Customer>
29
               <Totals
Totals

Total amounts

>
30
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
31
                    <SubTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

>{Decimal}</SubTotalAmount>
32
                    <VATAmount
VATAmount

Total value added tax in object currency.

>{Decimal}</VATAmount>
33
                    <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
34
               </Totals>
35
               <LatestApprovalResponse
LatestApprovalResponse

The latest review done of approval request

>
36
                    <IsApproved
IsApproved

True if the notification needs approval, and is approved.

>{Boolean}</IsApproved>
37
                    <Comment
Comment

Message entered by the user when approving or denying the approval request

>{String}</Comment>
38
                    <ReviewedAt
ReviewedAt

Date and time of approvel.

>{Datetime}</ReviewedAt>
39
                    <ReviewedBy
ReviewedBy

The employee who approved the notification.

>
40
                         <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
41
                         <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.LatestApprovalResponse.ReviewedBy.LastName in your request URI to get this field

>{String}</LastName>
42
                         <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.LatestApprovalResponse.ReviewedBy.FirstName in your request URI to get this field

>{String}</FirstName>
43
                         <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
44
                    </ReviewedBy>
45
               </LatestApprovalResponse>
46
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
47
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
48
               <Inspect>
49
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
50
               </Inspect>
51
          </Row>
52
     </Rows>
53
     <Paging
Paging

Detailed paging information for this list.

>
54
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
55
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
56
          <Page
Page

Page index

>{Integer}</Page>
57
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
58
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
59
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
60
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
61
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
62
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
63
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
64
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
65
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
66
     </Paging>
67
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
6
                    "objectType
ObjectType

Type of object

": "{String}",
7
                    "status
Status

Status of the object

": "{Integer}",
8
                    "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
9
                    "payment
Payment

Payment reference

": {
10
                         "dueDate
DueDate

Date the object is due to be paid

": "{Date}"
11
                    },
12
                    "assignee
Assignee

The user who has been assigned to work with this object.

": {
13
                         "userId
UserId

User identifier

": "{Integer}",
14
                         "name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Assignee.Name in your request URI to get this field

": "{String}",
15
                         "firstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Assignee.FirstName in your request URI to get this field

": "{String}",
16
                         "userLink
UserLink

User reference

": "{String}"
17
                    },
18
                    "supplier
Supplier

Supplier reference

": {
19
                         "supplierId
SupplierId

RamBase supplier identifier

": "{Integer}",
20
                         "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
21
                         "firstname
Firstname

Firstname/givenname if the supplier is a person

": "{String}",
22
                         "supplierLink
SupplierLink

Supplier reference

": "{String}"
23
                    },
24
                    "customer
Customer

Customer reference

": {
25
                         "customerId
CustomerId

Customer identifier

": "{Integer}",
26
                         "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
27
                         "firstname
Firstname

Secondary name of a company or firstname of a person

": "{String}",
28
                         "customerLink
CustomerLink

Customer reference

": "{String}"
29
                    },
30
                    "totals
Totals

Total amounts

": {
31
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
32
                         "subTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

": "{Decimal}",
33
                         "vATAmount
VATAmount

Total value added tax in object currency.

": "{Decimal}",
34
                         "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}"
35
                    },
36
                    "latestApprovalResponse
LatestApprovalResponse

The latest review done of approval request

": {
37
                         "isApproved
IsApproved

True if the notification needs approval, and is approved.

": "{Boolean}",
38
                         "comment
Comment

Message entered by the user when approving or denying the approval request

": "{String}",
39
                         "reviewedAt
ReviewedAt

Date and time of approvel.

": "{Datetime}",
40
                         "reviewedBy
ReviewedBy

The employee who approved the notification.

": {
41
                              "employeeId
EmployeeId

Employee identifier

": "{Integer}",
42
                              "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.LatestApprovalResponse.ReviewedBy.LastName in your request URI to get this field

": "{String}",
43
                              "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.LatestApprovalResponse.ReviewedBy.FirstName in your request URI to get this field

": "{String}",
44
                              "employeeLink
EmployeeLink

Employee reference

": "{String}"
45
                         }
46
                    },
47
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
48
                    "objectLink
ObjectLink

API reference to the object

": "{String}",
49
                    "inspect": {
50
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
51
                    }
52
               }
53
          ]
54
     }
55
}

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 100202 HTTP 404 Payable journal entry not found
Error 102750 HTTP 400 Number of parameter values does not match the number of parameters in the formula
Error 102749 HTTP 400 Missing parameter value for parameter {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}