API

Finance APIs

GET system/reports/118119/result-set

List of confidential types with suppliers

Report name Confidential types with suppliers
Report identifier 118119
HTTP method GET
URI https://api.rambase.net/system/reports/118119/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 7089, version 3

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.

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

WithoutSuppliers() Named filter Confidential types without suppliers
ConfidentialTypeId Integer Confidential type identifier.
CreatedById Integer Employee identifier. Available macros: currentUser()
Description String Description of confidential type.
IsDefault Boolean Marks if this confidential type is the default for incoming invoices that does not have a supplier set.
Name String Name of confidential type.
Status Integer Confidential type status.
SupplierFirstname String Firstname/givenname if the supplier is a person.
SupplierId Integer RamBase supplier identifier.
SupplierIntercompanyCode String Intercompany database the supplier belongs to.
SupplierLegalEntityIdentifier String The suppliers unique enterprise/organization number.
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person).
SupplierVATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

Read more about filters and sorting on how to use sortable parameters

ConfidentialTypeId Integer Confidential type identifier
CreatedById Integer Employee identifier
Description String Description of confidential type
IsDefault Boolean Marks if this confidential type is the default for incoming invoices that does not have a supplier set
Name String Name of confidential type
Status Integer Confidential type status
SupplierFirstname String Firstname/givenname if the supplier is a person
SupplierId Integer RamBase supplier identifier
SupplierIntercompanyCode String Intercompany database the supplier belongs to.
SupplierLegalEntityIdentifier String The suppliers unique enterprise/organization number.
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person)
SupplierVATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

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
               <Status
Status

Confidential type status

Possible domain values can be found here

>{Integer}</Status>
5
               <ConfidentialTypeId
ConfidentialTypeId

Confidential type identifier

>{Integer}</ConfidentialTypeId>
6
               <Name
Name

Name of confidential type

>{String}</Name>
7
               <Description
Description

Description of confidential type

>{String}</Description>
8
               <Supplier
Supplier

Supplier reference

>
9
                    <SupplierId
SupplierId

RamBase supplier identifier

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

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

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

Firstname/givenname if the supplier is a person

>{String}</Firstname>
12
                    <LegalEntityIdentifier
LegalEntityIdentifier

The suppliers unique enterprise/organization number.

>{String}</LegalEntityIdentifier>
13
                    <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

>{String}</VATRegistrationNumber>
14
                    <Intercompany
Intercompany

Intercompany reference

>
15
                         <Code
Code

Intercompany database the supplier belongs to.

>{String}</Code>
16
                    </Intercompany>
17
                    <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
18
               </Supplier>
19
               <Inspect>
20
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
21
               </Inspect>
22
          </Row>
23
     </Rows>
24
     <Paging
Paging

Detailed paging information for this list.

>
25
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
28
          <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>
29
          <FirstPage
FirstPage

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

>{String}</FirstPage>
30
          <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>
31
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
32
          <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>
33
          <NextPage
NextPage

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

>{String}</NextPage>
34
          <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>
35
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
37
     </Paging>
38
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Confidential type status

Possible domain values can be found here

": "{Integer}",
6
                    "confidentialTypeId
ConfidentialTypeId

Confidential type identifier

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

Name of confidential type

": "{String}",
8
                    "description
Description

Description of confidential type

": "{String}",
9
                    "supplier
Supplier

Supplier reference

": {
10
                         "supplierId
SupplierId

RamBase supplier identifier

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

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

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

Firstname/givenname if the supplier is a person

": "{String}",
13
                         "legalEntityIdentifier
LegalEntityIdentifier

The suppliers unique enterprise/organization number.

": "{String}",
14
                         "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

": "{String}",
15
                         "intercompany
Intercompany

Intercompany reference

": {
16
                              "code
Code

Intercompany database the supplier belongs to.

": "{String}"
17
                         },
18
                         "supplierLink
SupplierLink

Supplier reference

": "{String}"
19
                    },
20
                    "inspect": {
21
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
22
                    }
23
               }
24
          ]
25
     }
26
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type