API

Finance APIs

GET system/reports/100108/result-set

Resource for REP/100108

Report name Supplier Billing - By Item
Report identifier 100108
HTTP method GET
URI https://api.rambase.net/system/reports/100108/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 3830, version 23

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.

SupCreditNoteItems() Named filter Supplier credit note items only
SupplierInvoiceItems() Named filter Supplier invoice items only
AccountingPeriod Integer Accounting period.
BuyersReferenceNumber String Buyers reference number.
ConvertedNetAmount Decimal Total net amount in company currency.
ConvertedNetPrice Decimal Final price per unit after deducting all discounts.
Currency String Three character code following the ISO 4217 standard.
DepartmentId Integer Department identifier.
FinanceProjectId Integer Finance project identifier.
GeneralLedgerAccountId Integer General ledger account identifier.
GeneralLedgerAccountNumber String The account number of the general ledger account.
IntercompanyCode String Intercompany database the supplier belongs to.
InvoiceAddressCountryCode String Two-character code (ISO 3166) identifying the country.
IssueDate Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ItemId Integer Item-number of the object.
ManufacturerShortName String Shortname/code of the manufacturer.
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
ObjectId Integer Identifier of the object.
ObjectType String Type of object.
ProductCustomField1 String Custom field for grouping, sorting, categorizing and other purposes.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal Quantity of billing item.
SupplierFirstname String Firstname/givenname if the supplier is a person.
SupplierId Integer RamBase supplier identifier.
SupplierLastname String Firstname/givenname if the supplier is a person.
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person).
SuppliersInvoiceNumber String Suppliers/sellers reference number. Typically to an external system.

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

ConvertedNetAmount Decimal Total net amount in company currency.
ConvertedNetPrice Decimal Final price per unit after deducting all discounts.
ItemId Integer Item-number of the object
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
ObjectId Integer Identifier of the object
ObjectType String Type of object
Quantity Decimal Quantity of billing item
SupplierFirstname String Firstname/givenname if the supplier is a person
SupplierLastname String Firstname/givenname if the supplier is 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
               <Object
Object

Object reference

>
5
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
7
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

>{String}</ObjectLink>
9
                    <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
10
                    <ItemType
ItemType

Type of item

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

>{String}</ItemType>
11
                    <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
12
               </Object>
13
               <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
14
               <AccountingPeriod
AccountingPeriod

Accounting period reference

>
15
                    <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
16
                    <Period
Period

Accounting period

>{Integer}</Period>
17
                    <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
18
               </AccountingPeriod>
19
               <Supplier
Supplier

Supplier reference

>
20
                    <SupplierId
SupplierId

RamBase supplier identifier

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

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

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

Firstname/givenname if the supplier is a person

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

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

Supplier reference

>{String}</SupplierLink>
24
               </Supplier>
25
               <Quantity
Quantity

Quantity of billing item

>{Decimal}</Quantity>
26
               <Product
Product

Product reference

>
27
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
28
                    <Name
Name

Name of the product

>{String}</Name>
29
                    <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
30
                    <Description
Description

Description of the product

>{String}</Description>
31
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
32
               </Product>
33
               <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

>
34
                    <GeneralLedgerAccount
GeneralLedgerAccount

Identifier of the general ledger account

>
35
                         <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
36
                         <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
37
                         <Name
Name

Name of general ledger account

>{String}</Name>
38
                         <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
39
                    </GeneralLedgerAccount>
40
                    <Department
Department

Department reference. One of the system/fixed account dimensions.

>
41
                         <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
42
                         <Name
Name

Name of department

>{String}</Name>
43
                         <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
44
                    </Department>
45
               </Accounting>
46
               <Price
Price

Price per unit

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

>
47
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
48
                    <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

>{Decimal}</NetPrice>
49
               </Price>
50
               <PriceConverted
PriceConverted

Price converted to local currency

>
51
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
52
                    <NetPrice
NetPrice

Final price per unit after deducting all discounts.

>{Decimal}</NetPrice>
53
               </PriceConverted>
54
               <Totals
Totals

Total amounts

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

>
55
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
56
                    <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

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

>{Decimal}</NetAmount>
57
               </Totals>
58
               <TotalsConverted
TotalsConverted

Totals converted to local currency

>
59
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
60
                    <NetAmount
NetAmount

Total net amount in company currency.

>{Decimal}</NetAmount>
61
               </TotalsConverted>
62
               <Inspect>
63
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
64
               </Inspect>
65
          </Row>
66
     </Rows>
67
     <Aggregated
Aggregated

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

>
68
          <Quantity
Quantity

Quantity of billing item

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

>{Decimal}</Quantity>
69
          <TotalsConverted
TotalsConverted

Totals converted to local currency

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

>
70
               <NetAmount
NetAmount

Total net amount in company currency.

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

>{Decimal}</NetAmount>
71
          </TotalsConverted>
72
     </Aggregated>
73
     <Paging
Paging

Detailed paging information for this list.

>
74
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
77
          <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>
78
          <FirstPage
FirstPage

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

>{String}</FirstPage>
79
          <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>
80
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
81
          <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>
82
          <NextPage
NextPage

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

>{String}</NextPage>
83
          <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>
84
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
86
     </Paging>
87
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "object
Object

Object reference

": {
6
                         "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
8
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

": "{String}",
10
                         "itemId
ItemId

Item-number of the object

": "{Integer}",
11
                         "itemType
ItemType

Type of item

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

": "{String}",
12
                         "itemLink
ItemLink

API reference to the item

": "{String}"
13
                    },
14
                    "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
15
                    "accountingPeriod
AccountingPeriod

Accounting period reference

": {
16
                         "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
17
                         "period
Period

Accounting period

": "{Integer}",
18
                         "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
19
                    },
20
                    "supplier
Supplier

Supplier reference

": {
21
                         "supplierId
SupplierId

RamBase supplier identifier

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

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

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

Firstname/givenname if the supplier is a person

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

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

Supplier reference

": "{String}"
25
                    },
26
                    "quantity
Quantity

Quantity of billing item

": "{Decimal}",
27
                    "product
Product

Product reference

": {
28
                         "productId
ProductId

Product identifier

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

Name of the product

": "{String}",
30
                         "type
Type

Type of product

Possible domain values can be found here

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

Description of the product

": "{String}",
32
                         "productLink
ProductLink

Product reference

": "{String}"
33
                    },
34
                    "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

": {
35
                         "generalLedgerAccount
GeneralLedgerAccount

Identifier of the general ledger account

": {
36
                              "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
37
                              "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
38
                              "name
Name

Name of general ledger account

": "{String}",
39
                              "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
40
                         },
41
                         "department
Department

Department reference. One of the system/fixed account dimensions.

": {
42
                              "departmentId
DepartmentId

Department identifier

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

Name of department

": "{String}",
44
                              "departmentLink
DepartmentLink

Finance department reference

": "{String}"
45
                         }
46
                    },
47
                    "price
Price

Price per unit

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

": {
48
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
49
                         "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

": "{Decimal}"
50
                    },
51
                    "priceConverted
PriceConverted

Price converted to local currency

": {
52
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
53
                         "netPrice
NetPrice

Final price per unit after deducting all discounts.

": "{Decimal}"
54
                    },
55
                    "totals
Totals

Total amounts

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

": {
56
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
57
                         "netAmount
NetAmount

Final item amount after deducting all discounts etc.

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

": "{Decimal}"
58
                    },
59
                    "totalsConverted
TotalsConverted

Totals converted to local currency

": {
60
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
61
                         "netAmount
NetAmount

Total net amount in company currency.

": "{Decimal}"
62
                    },
63
                    "inspect": {
64
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
65
                    }
66
               }
67
          ],
68
          "aggregated
Aggregated

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

": {
69
               "quantity
Quantity

Quantity of billing item

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

": "{Decimal}",
70
               "totalsConverted
TotalsConverted

Totals converted to local currency

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

": {
71
                    "netAmount
NetAmount

Total net amount in company currency.

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

": "{Decimal}"
72
               }
73
          }
74
     }
75
}

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 100027 HTTP 400 Missing mandatory parameter {0}
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