API

Finance APIs

GET system/reports/100065/result-set

Customer billing by item

Report name Customer Billing - by Item
Report identifier 100065
HTTP method GET
URI https://api.rambase.net/system/reports/100065/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 20
Successful HTTP status code 200
API resource identifier 5902, version 16

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.

AccountingPeriod Integer Accounting period.
City String City/town/village.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
DepartmentId Integer Department identifier.
FinanceProjectId Integer Finance project identifier.
GrossMargin Decimal Gross margin of the item.
IssueDate Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ManufacturerId Integer Manufacturer identifier.
ManufacturerShortName String Shortname/code of the manufacturer.
PostalCode String Postalcode/Postcode/ZIP.
ProductId Integer Product identifier.
ProductName String Name of the product.
Quantity Decimal Quantity of sales invoice item.
SellerId Integer Employee identifier. Available macros: currentUser()

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

AccountingPeriod Integer Accounting period
City String City/town/village
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
DepartmentId Integer Department identifier
FinanceProjectId Integer Finance project identifier
GrossMargin Decimal Gross margin of the item.
IssueDate Date Date when the document was issued.
ManufacturerId Integer Manufacturer identifier
ManufacturerShortName String Shortname/code of the manufacturer
PostalCode String Postalcode/Postcode/ZIP
ProductId Integer Product identifier
ProductName String Name of the product
Quantity Decimal Quantity of sales invoice item
SellerId Integer Employee identifier

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

General ledger account reference

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

>
20
                    <AccountNumber
AccountNumber

The account number of the general ledger account

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

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

Name of general ledger account

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

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

General ledger account reference

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

>{String}</GeneralLedgerAccountLink>
23
               </GLAccount>
24
               <Customer
Customer

Customer reference

>
25
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

>{String}</CustomerLink>
29
               </Customer>
30
               <Quantity
Quantity

Quantity of sales invoice item

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

Product reference

>
32
                    <ProductId
ProductId

Product identifier

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

Name of the product

>{String}</Name>
34
                    <Manufacturer
Manufacturer

Manufacturer reference

>
35
                         <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
36
                         <ShortName
ShortName

Shortname/code of the manufacturer

>{String}</ShortName>
37
                         <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
38
                    </Manufacturer>
39
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
40
               </Product>
41
               <GrossMargin
GrossMargin

Gross margin of the item.

>{Decimal}</GrossMargin>
42
               <TotalsConverted
TotalsConverted

Totals converted to local currency

>
43
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

Total net amount in company currency.

>{Decimal}</NetAmount>
45
                    <LandedCost
LandedCost

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

>{Decimal}</LandedCost>
46
                    <GrossMarginAmount
GrossMarginAmount

Gross margin amount calculated (net amount - landed cost)

>{Decimal}</GrossMarginAmount>
47
               </TotalsConverted>
48
               <InvoiceAddress
InvoiceAddress

Invoice address reference

>
49
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
50
                    <City
City

City/town/village

>{String}</City>
51
               </InvoiceAddress>
52
               <ShippingAddress
ShippingAddress

Shipping address reference

>
53
                    <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
55
                    <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
56
                    <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
57
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
58
                    <City
City

City/town/village

>{String}</City>
59
                    <Region
Region

Region/province/state

>{String}</Region>
60
                    <Country
Country

English name of country.

>{String}</Country>
61
               </ShippingAddress>
62
               <Seller
Seller

Reference to the seller of the item

>
63
                    <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
64
                    <FirstName
FirstName

First name of employee

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

Last name of employee

>{String}</LastName>
66
                    <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
67
               </Seller>
68
               <Department
Department

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

>
69
                    <DepartmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

>{String}</DepartmentLink>
72
               </Department>
73
               <FinanceProject
FinanceProject

Finance project reference. One of the system/fixed account dimensions.

>
74
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
75
                    <Name
Name

Name of finance project

>{String}</Name>
76
                    <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
77
               </FinanceProject>
78
               <Inspect>
79
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
80
                    <Filter
Filter

Filter used when inspecting a line in a report.

>{String}</Filter>
81
               </Inspect>
82
          </Row>
83
     </Rows>
84
     <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

>
85
          <GrossMargin
GrossMargin

Gross margin of the 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}</GrossMargin>
86
          <TotalsConverted
TotalsConverted

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

>
87
               <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>
88
               <LandedCost
LandedCost

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

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}</LandedCost>
89
          </TotalsConverted>
90
     </Aggregated>
91
     <Paging
Paging

Detailed paging information for this list.

>
92
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
95
          <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>
96
          <FirstPage
FirstPage

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

>{String}</FirstPage>
97
          <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>
98
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
99
          <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>
100
          <NextPage
NextPage

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

>{String}</NextPage>
101
          <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>
102
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
104
     </Paging>
105
</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
                    "gLAccount
GLAccount

General ledger account reference

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

": {
21
                         "accountNumber
AccountNumber

The account number of the general ledger account

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

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

Name of general ledger account

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

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

General ledger account reference

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

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

Customer reference

": {
26
                         "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
30
                    },
31
                    "quantity
Quantity

Quantity of sales invoice item

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

Product reference

": {
33
                         "productId
ProductId

Product identifier

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

Name of the product

": "{String}",
35
                         "manufacturer
Manufacturer

Manufacturer reference

": {
36
                              "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
37
                              "shortName
ShortName

Shortname/code of the manufacturer

": "{String}",
38
                              "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
39
                         },
40
                         "productLink
ProductLink

Product reference

": "{String}"
41
                    },
42
                    "grossMargin
GrossMargin

Gross margin of the item.

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

Totals converted to local currency

": {
44
                         "currency
Currency

Three character code following the ISO 4217 standard

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

Total net amount in company currency.

": "{Decimal}",
46
                         "landedCost
LandedCost

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

": "{Decimal}",
47
                         "grossMarginAmount
GrossMarginAmount

Gross margin amount calculated (net amount - landed cost)

": "{Decimal}"
48
                    },
49
                    "invoiceAddress
InvoiceAddress

Invoice address reference

": {
50
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
51
                         "city
City

City/town/village

": "{String}"
52
                    },
53
                    "shippingAddress
ShippingAddress

Shipping address reference

": {
54
                         "name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",
56
                         "addressLine1
AddressLine1

First address line

": "{String}",
57
                         "addressLine2
AddressLine2

Second address line

": "{String}",
58
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
59
                         "city
City

City/town/village

": "{String}",
60
                         "region
Region

Region/province/state

": "{String}",
61
                         "country
Country

English name of country.

": "{String}"
62
                    },
63
                    "seller
Seller

Reference to the seller of the item

": {
64
                         "employeeId
EmployeeId

Employee identifier

": "{Integer}",
65
                         "firstName
FirstName

First name of employee

": "{String}",
66
                         "lastName
LastName

Last name of employee

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

Employee reference

": "{String}"
68
                    },
69
                    "department
Department

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

": {
70
                         "departmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

": "{String}"
73
                    },
74
                    "financeProject
FinanceProject

Finance project reference. One of the system/fixed account dimensions.

": {
75
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

": "{String}",
77
                         "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
78
                    },
79
                    "inspect": {
80
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}",
81
                         "filter
Filter

Filter used when inspecting a line in a report.

": "{String}"
82
                    }
83
               }
84
          ],
85
          "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

": {
86
               "grossMargin
GrossMargin

Gross margin of the 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}",
87
               "totalsConverted
TotalsConverted

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

": {
88
                    "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}",
89
                    "landedCost
LandedCost

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

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}"
90
               }
91
          }
92
     }
93
}

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