System APIs

GET system/reports/100635/result-set?fromPeriod={fromPeriod}&toPeriod={toPeriod}&periodView={periodView}

Resource for REP/100635

Report name	Invoice listing
Report identifier	100635
HTTP method	GET
URI	https://api.rambase.net/system/reports/100635/result-set?fromPeriod={fromPeriod}&toPeriod={toPeriod}&periodView={periodView}
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	20
Successful HTTP status code	200
API resource identifier	4686, version 27

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:

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.

fromPeriod Integer, optional	Report will list records from this period. Format: YYYYMM. Minimum: 190000, Maximum: 299999
toPeriod Integer, optional	Report will list records to this period. Format: YYYYMM. Minimum: 190000, Maximum: 299999
periodView String, optional	Quick filter on from and to period. This parameter overrides from and to period if they are specified.
$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.

AccountingPeriod Integer	Accounting period identifier. Available macros: currentPeriod(), previousPeriod()
CustomerId Integer	Customer identifier.
DepartmentId Integer	Department identifier.
EndCustomerFirstName String	First name of the end customer.
EndCustomerId Integer	The customer account for the end customer.
EndCustomerName String	Name of the end customer.
ForwardedFromItemId String	Item identifier of an source object.
ForwardedFromObjectId String	Source object identifier reference.
ForwardedFromObjectType String	Type of a source object.
IssueDate Date	Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ProductDescription String	Description of the product.
ProductName String	Name of the product.
TransactionItemId Integer	Identifier of an item.
TransactionObjectId Integer	Identifier of the document.

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

AccountingPeriod Integer	Accounting period identifier
CustomerId Integer	Customer identifier
DepartmentId Integer	Department identifier
EndCustomerFirstName String	First name of the end customer
EndCustomerId Integer	The customer account for the end customer
EndCustomerName String	Name of the end customer
IssueDate Date	Date when the document was issued.
ProductDescription String	Description of the product
ProductName String	Name of the product
TransactionItemId Integer	Identifier of an item
TransactionObjectId Integer	Identifier of the document

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:

                                        <Report>
                                    

                                             <Rows>
                                    

                                                  <Row>
                                    

<Transaction

Transaction

Document reference

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<ItemId

ItemId

Item-number of the object

>{Integer}</ItemId>

<RamBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>

<ObjectLink

ObjectLink

Filter used in the link to the related document.

>{String}</ObjectLink>

                                                       </Transaction>
                                    

<ForwardedFrom

ForwardedFrom

Forwarded from reference

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<ItemId

ItemId

Item-number of the object

>{Integer}</ItemId>

<RamBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>

<ObjectLink

ObjectLink

Filter used in the link to the related document.

>{String}</ObjectLink>

                                                       </ForwardedFrom>
                                    

<IssueDate

IssueDate

Date when the document was issued.

>{Date}</IssueDate>

<Period

Period

Accounting period identifier

>{Integer}</Period>

<Year

Year

Year of accounting period

>{Integer}</Year>

<Customer

Customer

Customer reference

<CustomerId

CustomerId

Customer identifier

>{Integer}</CustomerId>

<Name

Name

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

>{String}</Name>

<CustomerLink

CustomerLink

Customer reference

>{String}</CustomerLink>

                                                       </Customer>
                                    

<SalesDistrict

SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

>{String}</SalesDistrict>

<CustomerSalesDistrict

CustomerSalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

>{String}</CustomerSalesDistrict>

<Seller

Seller

Reference to the seller of the item

>{String}</Seller>

<CustomerSeller

CustomerSeller

Reference to the seller of the item

>{String}</CustomerSeller>

<Product

Product

Product reference

<ProductId

ProductId

Product identifier

>{Integer}</ProductId>

<Name

Name

Name of the product

>{String}</Name>

<Description

Description

Description of the product

>{String}</Description>

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                                       </Product>
                                    

<GLAccount

GLAccount

General ledger account reference

<AccountNumber

AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>

<Name

Name

Name of general ledger account

>{String}</Name>

<GeneralLedgerAccountLink

GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>

                                                       </GLAccount>
                                    

<Department

Department

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

<DepartmentId

DepartmentId

Department identifier

>{Integer}</DepartmentId>

<Name

Name

Name of department

>{String}</Name>

<DepartmentLink

DepartmentLink

Finance department reference

>{String}</DepartmentLink>

                                                       </Department>
                                    

<ProductDepartment

ProductDepartment

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

<DepartmentId

DepartmentId

Department identifier

>{Integer}</DepartmentId>

<Name

Name

Name of department

>{String}</Name>

<DepartmentLink

DepartmentLink

Finance department reference

>{String}</DepartmentLink>

                                                       </ProductDepartment>
                                    

<SellersDepartment

SellersDepartment

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

<DepartmentId

DepartmentId

Department identifier

>{Integer}</DepartmentId>

<Name

Name

Name of department

>{String}</Name>

<DepartmentLink

DepartmentLink

Finance department reference

>{String}</DepartmentLink>

                                                       </SellersDepartment>
                                    

<EndCustomer

EndCustomer

End customer reference

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

<CustomerId

CustomerId

The customer account for the end customer

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

>{Integer}</CustomerId>

<Name

Name

Name of the end customer

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

>{String}</Name>

<FirstName

FirstName

Name of the end customer

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

>{String}</FirstName>

<CustomerLink

CustomerLink

Customer reference

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

>{String}</CustomerLink>

                                                       </EndCustomer>
                                    

<Quantity

Quantity

Item quantity.

>{Decimal}</Quantity>

<ConvertedGrossPrice

ConvertedGrossPrice

Represents the price per unit before any discounting is applied.

>{Decimal}</ConvertedGrossPrice>

<ConvertedNetAmount

ConvertedNetAmount

Total net amount in company currency.

>{Decimal}</ConvertedNetAmount>

<ConvertedLandedCost

ConvertedLandedCost

Gross landed cost multiplied with quantity of the item (converted to local currencies)

>{Decimal}</ConvertedLandedCost>

<GrossMargin

GrossMargin

Gross margin of the item.

>{Decimal}</GrossMargin>

<IsImported

IsImported

Item has been imported.

>{Boolean}</IsImported>

                                                       <Inspect>
                                    

<TargetApplication

TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>

                                                       </Inspect>
                                    

                                                  </Row>
                                    

                                             </Rows>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

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

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

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

<FirstPage

FirstPage

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

>{String}</FirstPage>

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

<PreviousPage

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

>{String}</PreviousPage>

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

<NextPage

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

>{String}</NextPage>

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

<LastPage

LastPage

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

>{String}</LastPage>

<Size

Size

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

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Report>
                                    

{

                                             "report": {
                                    

                                                  "rows": [
                                    

{

"transaction

Transaction

Document reference

": {

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"objectType

ObjectType

Type of object

": "{String}",

"itemId

ItemId

Item-number of the object

": "{Integer}",

"ramBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",

"objectLink

ObjectLink

Filter used in the link to the related document.

": "{String}"

},

"forwardedFrom

ForwardedFrom

Forwarded from reference

": {

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"objectType

ObjectType

Type of object

": "{String}",

"itemId

ItemId

Item-number of the object

": "{Integer}",

"ramBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",

"objectLink

ObjectLink

Filter used in the link to the related document.

": "{String}"

},

"issueDate

IssueDate

Date when the document was issued.

": "{Date}",

"period

Period

Accounting period identifier

": "{Integer}",

"year

Year

Year of accounting period

": "{Integer}",

"customer

Customer

Customer reference

": {

"customerId

CustomerId

Customer identifier

": "{Integer}",

"name

Name

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

": "{String}",

"customerLink

CustomerLink

Customer reference

": "{String}"

},

"salesDistrict

SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

": "{String}",

"customerSalesDistrict

CustomerSalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

": "{String}",

"seller

Seller

Reference to the seller of the item

": "{String}",

"customerSeller

CustomerSeller

Reference to the seller of the item

": "{String}",

"product

Product

Product reference

": {

"productId

ProductId

Product identifier

": "{Integer}",

"name

Name

Name of the product

": "{String}",

"description

Description

Description of the product

": "{String}",

"productLink

ProductLink

Product reference

": "{String}"

},

"gLAccount

GLAccount

General ledger account reference

": {

"accountNumber

AccountNumber

The account number of the general ledger account

": "{String}",

"name

Name

Name of general ledger account

": "{String}",

"generalLedgerAccountLink

GeneralLedgerAccountLink

General ledger account reference

": "{String}"

},

"department

Department

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

": {

"departmentId

DepartmentId

Department identifier

": "{Integer}",

"name

Name

Name of department

": "{String}",

"departmentLink

DepartmentLink

Finance department reference

": "{String}"

},

"productDepartment

ProductDepartment

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

": {

"departmentId

DepartmentId

Department identifier

": "{Integer}",

"name

Name

Name of department

": "{String}",

"departmentLink

DepartmentLink

Finance department reference

": "{String}"

},

"sellersDepartment

SellersDepartment

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

": {

"departmentId

DepartmentId

Department identifier

": "{Integer}",

"name

Name

Name of department

": "{String}",

"departmentLink

DepartmentLink

Finance department reference

": "{String}"

},

"endCustomer

EndCustomer

End customer reference

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

": {

"customerId

CustomerId

The customer account for the end customer

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

": "{Integer}",

"name

Name

Name of the end customer

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

": "{String}",

"firstName

FirstName

Name of the end customer

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

": "{String}",

"customerLink

CustomerLink

Customer reference

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

": "{String}"

},

"quantity

Quantity

Item quantity.

": "{Decimal}",

"convertedGrossPrice

ConvertedGrossPrice

Represents the price per unit before any discounting is applied.

": "{Decimal}",

"convertedNetAmount

ConvertedNetAmount

Total net amount in company currency.

": "{Decimal}",

"convertedLandedCost

ConvertedLandedCost

Gross landed cost multiplied with quantity of the item (converted to local currencies)

": "{Decimal}",

"grossMargin

GrossMargin

Gross margin of the item.

": "{Decimal}",

"isImported

IsImported

Item has been imported.

": "{Boolean}",

                                                            "inspect": {
                                    

"targetApplication

TargetApplication

Application reference when inspecting a line in a report.

": "{String}"

}

}

]

}

}

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