API

Finance APIs

GET system/reports/112702/result-set?fromDate={fromDate}&toDate={toDate}

Shows an overview of how matching between supplier product and rambase product was done for imported invoices.

Report name Report for imported invoice product matching
Report identifier 112702
HTTP method GET
URI https://api.rambase.net/system/reports/112702/result-set?fromDate={fromDate}&toDate={toDate}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5900, version 10

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.

fromDate Date, optional From date used to filter data
toDate Date, optional To date used to filter data
$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.

BuyersContactName String Name of the RamBase contact (legal entity or person).
BuyersIdentification String An identifier or name, assigned by the buyer, for the product.
ContainingNoteText String Show all received supplier invoices containing notes. Note that search will be for messages in company language, and not in user language.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Currency String Three character code following the ISO 4217 standard.
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
ImportedSupplierInvoiceId Integer Imported supplier invoice identifier.
ImportedSupplierInvoiceItemId Integer Identificator of the imported supplier invoice item (ISI).
MatchingRule String Rule which is used for RamBase product matching.
ProductDescription String Product description.
ProductId Integer RamBase product identificator.
ProductReferenceName String Name of the product.
SupplierId Integer RamBase supplier identifier.
SupplierName String The name of the supplier.
SuppliersIdentification String An identifier or name, assigned by the supplier, for the product.
SuppliersReference String The reference to the imported supplier invoice.

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

BuyersContactName String Name of the RamBase contact (legal entity or person)
BuyersIdentification String An identifier or name, assigned by the buyer, for the product
ContainingNoteText String Show all received supplier invoices containing notes. Note that search will be for messages in company language, and not in user language.
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
ImportedSupplierInvoiceId Integer Imported supplier invoice identifier
ImportedSupplierInvoiceItemId Integer Identificator of the imported supplier invoice item (ISI)
MatchingRule String Rule which is used for RamBase product matching
ProductDescription String Product description
ProductId Integer RamBase product identificator
ProductReferenceName String Name of the product
SupplierId Integer RamBase supplier identifier
SupplierName String The name of the supplier
SuppliersIdentification String An identifier or name, assigned by the supplier, for the product
SuppliersReference String The reference to the imported supplier invoice

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

Date and time of creation

>{Datetime}</CreatedAt>
5
               <ImportedSupplierInvoiceItem
ImportedSupplierInvoiceItem

Imported supplier invoice item

>
6
                    <ImportedSupplierInvoiceItemId
ImportedSupplierInvoiceItemId

Identificator of the imported supplier invoice item (ISI)

>{Integer}</ImportedSupplierInvoiceItemId>
7
                    <ImportedSupplierInvoice
ImportedSupplierInvoice

Imported supplier invoice

>
8
                         <ImportedSupplierInvoiceId
ImportedSupplierInvoiceId

Imported supplier invoice identifier

>{Integer}</ImportedSupplierInvoiceId>
9
                         <ImportedSupplierInvoiceLink
ImportedSupplierInvoiceLink

Imported supplier invoice reference

>{String}</ImportedSupplierInvoiceLink>
10
                    </ImportedSupplierInvoice>
11
                    <ImportedSupplierInvoiceItemLink
ImportedSupplierInvoiceItemLink

Imported supplier invoice item identifier

>{String}</ImportedSupplierInvoiceItemLink>
12
               </ImportedSupplierInvoiceItem>
13
               <Supplier
Supplier

Supplier reference

>
14
                    <SupplierId
SupplierId

RamBase supplier identifier

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

The name of the supplier

>{String}</Name>
16
                    <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
17
               </Supplier>
18
               <SuppliersReference
SuppliersReference

The reference to the imported supplier invoice

>{String}</SuppliersReference>
19
               <BuyersContact
BuyersContact

RamBase contact (legal entity or person)

>
20
                    <Name
Name

Name of the RamBase contact (legal entity or person)

>{String}</Name>
21
               </BuyersContact>
22
               <Product
Product

Product reference

>
23
                    <Name
Name

Name of product

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

Product description

>{String}</Description>
25
                    <SuppliersIdentification
SuppliersIdentification

An identifier or name, assigned by the supplier, for the product

>{String}</SuppliersIdentification>
26
                    <BuyersIdentification
BuyersIdentification

An identifier or name, assigned by the buyer, for the product

>{String}</BuyersIdentification>
27
                    <ProductReference
ProductReference

Product reference

>
28
                         <ProductId
ProductId

RamBase product identificator

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

Name of the product

>{String}</Name>
30
                         <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
31
                    </ProductReference>
32
                    <MatchingRule
MatchingRule

Rule which is used for RamBase product matching

Possible domain values can be found here

>{String}</MatchingRule>
33
               </Product>
34
               <Totals
Totals

Total amounts

>
35
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
36
                    <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

>{Decimal}</GrossAmount>
37
               </Totals>
38
               <Inspect>
39
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
40
               </Inspect>
41
          </Row>
42
     </Rows>
43
     <Paging
Paging

Detailed paging information for this list.

>
44
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
47
          <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>
48
          <FirstPage
FirstPage

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

>{String}</FirstPage>
49
          <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>
50
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
51
          <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>
52
          <NextPage
NextPage

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

>{String}</NextPage>
53
          <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>
54
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
56
     </Paging>
57
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
                    "importedSupplierInvoiceItem
ImportedSupplierInvoiceItem

Imported supplier invoice item

": {
7
                         "importedSupplierInvoiceItemId
ImportedSupplierInvoiceItemId

Identificator of the imported supplier invoice item (ISI)

": "{Integer}",
8
                         "importedSupplierInvoice
ImportedSupplierInvoice

Imported supplier invoice

": {
9
                              "importedSupplierInvoiceId
ImportedSupplierInvoiceId

Imported supplier invoice identifier

": "{Integer}",
10
                              "importedSupplierInvoiceLink
ImportedSupplierInvoiceLink

Imported supplier invoice reference

": "{String}"
11
                         },
12
                         "importedSupplierInvoiceItemLink
ImportedSupplierInvoiceItemLink

Imported supplier invoice item identifier

": "{String}"
13
                    },
14
                    "supplier
Supplier

Supplier reference

": {
15
                         "supplierId
SupplierId

RamBase supplier identifier

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

The name of the supplier

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

Supplier reference

": "{String}"
18
                    },
19
                    "suppliersReference
SuppliersReference

The reference to the imported supplier invoice

": "{String}",
20
                    "buyersContact
BuyersContact

RamBase contact (legal entity or person)

": {
21
                         "name
Name

Name of the RamBase contact (legal entity or person)

": "{String}"
22
                    },
23
                    "product
Product

Product reference

": {
24
                         "name
Name

Name of product

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

Product description

": "{String}",
26
                         "suppliersIdentification
SuppliersIdentification

An identifier or name, assigned by the supplier, for the product

": "{String}",
27
                         "buyersIdentification
BuyersIdentification

An identifier or name, assigned by the buyer, for the product

": "{String}",
28
                         "productReference
ProductReference

Product reference

": {
29
                              "productId
ProductId

RamBase product identificator

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

Name of the product

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

Product reference

": "{String}"
32
                         },
33
                         "matchingRule
MatchingRule

Rule which is used for RamBase product matching

Possible domain values can be found here

": "{String}"
34
                    },
35
                    "totals
Totals

Total amounts

": {
36
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
37
                         "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

": "{Decimal}"
38
                    },
39
                    "inspect": {
40
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
41
                    }
42
               }
43
          ]
44
     }
45
}

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