API

Finance APIs

GET system/reports/113772/result-set?accountingPeriod={accountingPeriod}

Totals from account groups related to PRO structure, by project : PRO_INCOME + PRO_OTHERINCOME + PRO_MATERIAL + PRO_OTHERCOSTOFGOODS + PRO_WAGES + PRO_OTHEREXPENSES

Report name Finance Projects : Totals from account groups related to PRO structure
Report identifier 113772
HTTP method GET
URI https://api.rambase.net/system/reports/113772/result-set?accountingPeriod={accountingPeriod}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6035, version 3

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 accounting period. Previous accounting period will be default if not specified.

Minimum: 190000,
Maximum: 299999
$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.

AccountingLineId Integer Accounting line identifier of the general ledger posting.
AssetId Integer Asset identifier.
Category String Category of general ledger posting.
CountOfJournalEntries Integer Count of journal entries which are linked to general ledger posting.
CreatedByUserId Integer User identifier.
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.
GeneralLedgerPostingId Integer General ledger posting identifier.
LastUpdateDate Date Last update date of general ledger posting. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Note String Remark of the general ledger posting.
Status String Status of general ledger posting.
TransactionDate Date Transaction date of general ledger posting. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Type String Type of general ledger posting.
VATCode String Code that determines VAT rules used for VAT calculations.
VATPostingId Integer VAT Posting identifier.

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

FinanceProjectId Integer Finance project 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
               <FinanceProject
FinanceProject

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

>
5
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

Finance project reference

>{String}</FinanceProjectLink>
8
               </FinanceProject>
9
               <AccountingPeriod
AccountingPeriod

Accounting period reference

>
10
                    <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

>{String}</AccountingPeriodLink>
13
               </AccountingPeriod>
14
               <PeriodAmounts
PeriodAmounts

Total amounts for period

>
15
                    <Income
Income

InvoicedAmount + OtherIncome

>{Decimal}</Income>
16
                    <OtherIncome
OtherIncome

Field from finance linked to PRO by PRO.PRJNO.

User must exclude the GL accounts that are used for invoices that are created based on the customer orders (COAs) that are linked to the PRO.

>{Decimal}</OtherIncome>
17
                    <MaterialCost
MaterialCost

SUMACCRUEDMATERIALCOST

>{Decimal}</MaterialCost>
18
                    <CostOfGoods
CostOfGoods

Field from finance linked to PRO by PRO.PRJNO.

'Other cost of goods' for a delivery project are 'material' costs that are not already included based on accumulated values for material/parts that are linked to the included COA items or via work orders (PWOs) that are linked to the COA items and connected sub PWOs. So other cost of goods must exclude the general ledger (GL) accounts that are connected to inventory flow.

>{Decimal}</CostOfGoods>
19
                    <SalaryCost
SalaryCost

Field from finance linked to PRO by PRO.PRJNO.

Project wages is project labour cost that is not already added via the logged work at the included work orders (PWOs), example: Engineering cost.
To be connected to PRS by a dedicated ACG.

>{Decimal}</SalaryCost>
20
                    <OtherCost
OtherCost

Field from finance linked to PRO by PRO.PRJNO.

>{Decimal}</OtherCost>
21
               </PeriodAmounts>
22
               <YearToDateAmounts
YearToDateAmounts

Total amounts year to date

>
23
                    <Income
Income

InvoicedAmount + OtherIncome

>{Decimal}</Income>
24
                    <OtherIncome
OtherIncome

Field from finance linked to PRO by PRO.PRJNO.

User must exclude the GL accounts that are used for invoices that are created based on the customer orders (COAs) that are linked to the PRO.

>{Decimal}</OtherIncome>
25
                    <MaterialCost
MaterialCost

SUMACCRUEDMATERIALCOST

>{Decimal}</MaterialCost>
26
                    <CostOfGoods
CostOfGoods

Field from finance linked to PRO by PRO.PRJNO.

'Other cost of goods' for a delivery project are 'material' costs that are not already included based on accumulated values for material/parts that are linked to the included COA items or via work orders (PWOs) that are linked to the COA items and connected sub PWOs. So other cost of goods must exclude the general ledger (GL) accounts that are connected to inventory flow.

>{Decimal}</CostOfGoods>
27
                    <SalaryCost
SalaryCost

Field from finance linked to PRO by PRO.PRJNO.

Project wages is project labour cost that is not already added via the logged work at the included work orders (PWOs), example: Engineering cost.
To be connected to PRS by a dedicated ACG.

>{Decimal}</SalaryCost>
28
                    <OtherCost
OtherCost

Field from finance linked to PRO by PRO.PRJNO.

>{Decimal}</OtherCost>
29
               </YearToDateAmounts>
30
               <TotalAmounts
TotalAmounts

Total amounts

>
31
                    <Income
Income

InvoicedAmount + OtherIncome

>{Decimal}</Income>
32
                    <OtherIncome
OtherIncome

Field from finance linked to PRO by PRO.PRJNO.

User must exclude the GL accounts that are used for invoices that are created based on the customer orders (COAs) that are linked to the PRO.

>{Decimal}</OtherIncome>
33
                    <MaterialCost
MaterialCost

SUMACCRUEDMATERIALCOST

>{Decimal}</MaterialCost>
34
                    <CostOfGoods
CostOfGoods

Field from finance linked to PRO by PRO.PRJNO.

'Other cost of goods' for a delivery project are 'material' costs that are not already included based on accumulated values for material/parts that are linked to the included COA items or via work orders (PWOs) that are linked to the COA items and connected sub PWOs. So other cost of goods must exclude the general ledger (GL) accounts that are connected to inventory flow.

>{Decimal}</CostOfGoods>
35
                    <SalaryCost
SalaryCost

Field from finance linked to PRO by PRO.PRJNO.

Project wages is project labour cost that is not already added via the logged work at the included work orders (PWOs), example: Engineering cost.
To be connected to PRS by a dedicated ACG.

>{Decimal}</SalaryCost>
36
                    <OtherCost
OtherCost

Field from finance linked to PRO by PRO.PRJNO.

>{Decimal}</OtherCost>
37
               </TotalAmounts>
38
               <Inspect>
39
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

>{String}</Filter>
41
               </Inspect>
42
          </Row>
43
     </Rows>
44
     <Paging
Paging

Detailed paging information for this list.

>
45
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

>{Integer}</Size>
57
     </Paging>
58
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "financeProject
FinanceProject

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

": {
6
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

Finance project reference

": "{String}"
9
                    },
10
                    "accountingPeriod
AccountingPeriod

Accounting period reference

": {
11
                         "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

": "{String}"
14
                    },
15
                    "periodAmounts
PeriodAmounts

Total amounts for period

": {
16
                         "income
Income

InvoicedAmount + OtherIncome

": "{Decimal}",
17
                         "otherIncome
OtherIncome

Field from finance linked to PRO by PRO.PRJNO.

User must exclude the GL accounts that are used for invoices that are created based on the customer orders (COAs) that are linked to the PRO.

": "{Decimal}",
18
                         "materialCost
MaterialCost

SUMACCRUEDMATERIALCOST

": "{Decimal}",
19
                         "costOfGoods
CostOfGoods

Field from finance linked to PRO by PRO.PRJNO.

'Other cost of goods' for a delivery project are 'material' costs that are not already included based on accumulated values for material/parts that are linked to the included COA items or via work orders (PWOs) that are linked to the COA items and connected sub PWOs. So other cost of goods must exclude the general ledger (GL) accounts that are connected to inventory flow.

": "{Decimal}",
20
                         "salaryCost
SalaryCost

Field from finance linked to PRO by PRO.PRJNO.

Project wages is project labour cost that is not already added via the logged work at the included work orders (PWOs), example: Engineering cost.
To be connected to PRS by a dedicated ACG.

": "{Decimal}",
21
                         "otherCost
OtherCost

Field from finance linked to PRO by PRO.PRJNO.

": "{Decimal}"
22
                    },
23
                    "yearToDateAmounts
YearToDateAmounts

Total amounts year to date

": {
24
                         "income
Income

InvoicedAmount + OtherIncome

": "{Decimal}",
25
                         "otherIncome
OtherIncome

Field from finance linked to PRO by PRO.PRJNO.

User must exclude the GL accounts that are used for invoices that are created based on the customer orders (COAs) that are linked to the PRO.

": "{Decimal}",
26
                         "materialCost
MaterialCost

SUMACCRUEDMATERIALCOST

": "{Decimal}",
27
                         "costOfGoods
CostOfGoods

Field from finance linked to PRO by PRO.PRJNO.

'Other cost of goods' for a delivery project are 'material' costs that are not already included based on accumulated values for material/parts that are linked to the included COA items or via work orders (PWOs) that are linked to the COA items and connected sub PWOs. So other cost of goods must exclude the general ledger (GL) accounts that are connected to inventory flow.

": "{Decimal}",
28
                         "salaryCost
SalaryCost

Field from finance linked to PRO by PRO.PRJNO.

Project wages is project labour cost that is not already added via the logged work at the included work orders (PWOs), example: Engineering cost.
To be connected to PRS by a dedicated ACG.

": "{Decimal}",
29
                         "otherCost
OtherCost

Field from finance linked to PRO by PRO.PRJNO.

": "{Decimal}"
30
                    },
31
                    "totalAmounts
TotalAmounts

Total amounts

": {
32
                         "income
Income

InvoicedAmount + OtherIncome

": "{Decimal}",
33
                         "otherIncome
OtherIncome

Field from finance linked to PRO by PRO.PRJNO.

User must exclude the GL accounts that are used for invoices that are created based on the customer orders (COAs) that are linked to the PRO.

": "{Decimal}",
34
                         "materialCost
MaterialCost

SUMACCRUEDMATERIALCOST

": "{Decimal}",
35
                         "costOfGoods
CostOfGoods

Field from finance linked to PRO by PRO.PRJNO.

'Other cost of goods' for a delivery project are 'material' costs that are not already included based on accumulated values for material/parts that are linked to the included COA items or via work orders (PWOs) that are linked to the COA items and connected sub PWOs. So other cost of goods must exclude the general ledger (GL) accounts that are connected to inventory flow.

": "{Decimal}",
36
                         "salaryCost
SalaryCost

Field from finance linked to PRO by PRO.PRJNO.

Project wages is project labour cost that is not already added via the logged work at the included work orders (PWOs), example: Engineering cost.
To be connected to PRS by a dedicated ACG.

": "{Decimal}",
37
                         "otherCost
OtherCost

Field from finance linked to PRO by PRO.PRJNO.

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

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

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

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