API

Finance APIs

GET system/reports/100491/result-set?accountingPeriod={accountingPeriod}&date={date}&customerId={customerId}

Customer statement

Report name Customer statement
Report identifier 100491
HTTP method GET
URI https://api.rambase.net/system/reports/100491/result-set?accountingPeriod={accountingPeriod}&date={date}&customerId={customerId}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 20
Successful HTTP status code 200
API resource identifier 4053, version 15

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.

accountingPeriod Integer, optional Report will list records to this period. If this is specified the date parameter will be ignored.

Minimum: 190000,
Maximum: 299999
date Date, optional Report will list records to this date. If period is specified this date parameter will be ignored.
customerId Integer, optional Customer identifier

Minimum: 10000
$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.

NoReminders() Named filter No reminder flag
Reminders() Named filter Reminder flag
AccountingPeriod Integer Accounting period. Available macros: currentPeriod(), previousPeriod()
AccountsReceivableTransactionId Integer Accounts receivable transaction identifier.
Currency String Three character code following the ISO 4217 standard.
CustomerId Integer Customer identifier.
PaymentTerms String Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.
ReminderFlag Integer Reminder flag.
Status Integer Status of the accounts receivable transaction.

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

AccountingPeriod Integer Accounting period
AccountsReceivableTransactionId Integer Accounts receivable transaction identifier
Currency String Three character code following the ISO 4217 standard
CustomerId Integer Customer identifier
PaymentTerms String Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.
ReminderFlag Integer Reminder flag
Status Integer Status of the accounts receivable transaction

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

Status of the accounts receivable transaction

Possible domain values can be found here

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

Accounts receivable transaction reference

>
6
                    <AccountsReceivableTransactionId
AccountsReceivableTransactionId

Accounts receivable transaction identifier

>{Integer}</AccountsReceivableTransactionId>
7
                    <AccountsReceivableTransactionLink
AccountsReceivableTransactionLink

Accounts receivable transaction reference

>{String}</AccountsReceivableTransactionLink>
8
               </AccountsReceivableTransaction>
9
               <Source
Source

Source reference

>
10
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
12
                    <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
13
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

>{String}</ObjectLink>
15
                    <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
16
               </Source>
17
               <Customer
Customer

Customer reference

>
18
                    <CustomerId
CustomerId

Customer identifier

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

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

>{String}</Name>
20
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
21
               </Customer>
22
               <CountOfDunningJobs
CountOfDunningJobs

Count of dunning jobs for the specific accounts receivable transaction

>{Integer}</CountOfDunningJobs>
23
               <Text
Text

Descriptive text of record

>{String}</Text>
24
               <AccountingPeriod
AccountingPeriod

Accounting period

>{Integer}</AccountingPeriod>
25
               <Date
Date

Date the object was issued

>{Date}</Date>
26
               <DueDate
DueDate

Date the object is due to be paid

>{Date}</DueDate>
27
               <GrossAmount
GrossAmount

Total amount

>{Decimal}</GrossAmount>
28
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
29
               <ExchangeRate
ExchangeRate

The exchange rate used in convertion

>{Decimal}</ExchangeRate>
30
               <ConvertedGrossAmount
ConvertedGrossAmount

Amount/{CUR}

>{Decimal}</ConvertedGrossAmount>
31
               <NotDueAmount
NotDueAmount

Total amount that is not due

>{Decimal}</NotDueAmount>
32
               <OverdueAmount
OverdueAmount

Total amount of unpaid invoices which has passed due date

>{Decimal}</OverdueAmount>
33
               <Inspect>
34
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
35
               </Inspect>
36
          </Row>
37
     </Rows>
38
     <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

>
39
          <ConvertedGrossAmount
ConvertedGrossAmount

Amount/{CUR}

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}</ConvertedGrossAmount>
40
          <NotDueAmount
NotDueAmount

Total amount that is not due

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}</NotDueAmount>
41
          <OverdueAmount
OverdueAmount

Total amount of unpaid invoices which has passed due date

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}</OverdueAmount>
42
     </Aggregated>
43
     <ColumnParameters
ColumnParameters

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

>
44
          <ColumnParameter
ColumnParameter

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

>
45
               <Key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

>{String}</Key>
46
               <Value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

>{String}</Value>
47
          </ColumnParameter>
48
     </ColumnParameters>
49
     <Paging
Paging

Detailed paging information for this list.

>
50
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
53
          <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>
54
          <FirstPage
FirstPage

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

>{String}</FirstPage>
55
          <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>
56
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
57
          <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>
58
          <NextPage
NextPage

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

>{String}</NextPage>
59
          <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>
60
          <LastPage
LastPage

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

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

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

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

Status of the accounts receivable transaction

Possible domain values can be found here

": "{Integer}",
6
                    "accountsReceivableTransaction
AccountsReceivableTransaction

Accounts receivable transaction reference

": {
7
                         "accountsReceivableTransactionId
AccountsReceivableTransactionId

Accounts receivable transaction identifier

": "{Integer}",
8
                         "accountsReceivableTransactionLink
AccountsReceivableTransactionLink

Accounts receivable transaction reference

": "{String}"
9
                    },
10
                    "source
Source

Source reference

": {
11
                         "objectId
ObjectId

Identifier of the object

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

Type of object

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

Item-number of the object

": "{Integer}",
14
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

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

API reference to the item

": "{String}"
17
                    },
18
                    "customer
Customer

Customer reference

": {
19
                         "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

": "{String}"
22
                    },
23
                    "countOfDunningJobs
CountOfDunningJobs

Count of dunning jobs for the specific accounts receivable transaction

": "{Integer}",
24
                    "text
Text

Descriptive text of record

": "{String}",
25
                    "accountingPeriod
AccountingPeriod

Accounting period

": "{Integer}",
26
                    "date
Date

Date the object was issued

": "{Date}",
27
                    "dueDate
DueDate

Date the object is due to be paid

": "{Date}",
28
                    "grossAmount
GrossAmount

Total amount

": "{Decimal}",
29
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
30
                    "exchangeRate
ExchangeRate

The exchange rate used in convertion

": "{Decimal}",
31
                    "convertedGrossAmount
ConvertedGrossAmount

Amount/{CUR}

": "{Decimal}",
32
                    "notDueAmount
NotDueAmount

Total amount that is not due

": "{Decimal}",
33
                    "overdueAmount
OverdueAmount

Total amount of unpaid invoices which has passed due date

": "{Decimal}",
34
                    "inspect": {
35
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
36
                    }
37
               }
38
          ],
39
          "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

": {
40
               "convertedGrossAmount
ConvertedGrossAmount

Amount/{CUR}

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}",
41
               "notDueAmount
NotDueAmount

Total amount that is not due

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}",
42
               "overdueAmount
OverdueAmount

Total amount of unpaid invoices which has passed due date

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}"
43
          },
44
          "columnParameters
ColumnParameters

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

": [
45
               {
46
                    "key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

": "{String}",
47
                    "value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

": "{String}"
48
               }
49
          ]
50
     }
51
}

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 102738 HTTP 404 Price list not found
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