API

Finance APIs

GET finance/payments/{paymentId}/items/{itemId}/transactions

List of documents related to specific payment item

HTTP method GET
URI https://api.rambase.net/finance/payments/{paymentId}/items/{itemId}/transactions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {paymentId} Payment identifier
Integer, minimum 100000
- URI parameter {itemId} Item-/line-number of the payment.
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 6573, version 7

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.

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

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

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
<Transactions>
2
     <Transaction>
3
          <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

>
4
               <VATCodeDefinition>
5
                    <VATCodeDefinitionId
VATCodeDefinitionId

VAT code identifier

>{Integer}</VATCodeDefinitionId>
6
                    <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
7
                    <Description
Description

Description of VAT Code definition

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

>{String}</Description>
8
                    <VATCodeDefinitionLink
VATCodeDefinitionLink

VAT code reference

>{String}</VATCodeDefinitionLink>
9
               </VATCodeDefinition>
10
               <GeneralLedgerAccount>
11
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
12
                    <AccountNumber
AccountNumber

The account number of the general ledger account

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

Name of general ledger account

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

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

General ledger account reference

>{String}</GeneralLedgerAccountLink>
15
               </GeneralLedgerAccount>
16
               <Department
Department

The department related to the item. One of the system/fixed account dimensions.

>
17
                    <DepartmentId
DepartmentId

Department identifier

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

Name of department

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

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

Finance department reference

>{String}</DepartmentLink>
20
               </Department>
21
               <FinanceProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

>
22
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

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

Finance project reference

>{String}</FinanceProjectLink>
25
               </FinanceProject>
26
               <Asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

>
27
                    <AssetId
AssetId

Asset identifier

>{Integer}</AssetId>
28
                    <Name
Name

Name of asset

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

>{String}</Name>
29
                    <AssetLink
AssetLink

Asset reference

>{String}</AssetLink>
30
               </Asset>
31
               <CustomDimensions
CustomDimensions

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

>
32
                    <Dimension
Dimension

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

>
33
                         <Value
Value

Value for this dimension defintion.

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

>{String}</Value>
34
                         <Description
Description

Description of the dimension value.

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

>{String}</Description>
35
                         <DimensionDefinition
DimensionDefinition

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

>
36
                              <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

>{Integer}</DimensionDefinitionId>
37
                              <Name
Name

Name of dimension

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

>{String}</Name>
38
                              <DimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

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

>{String}</DimensionDefinitionLink>
39
                         </DimensionDefinition>
40
                    </Dimension>
41
               </CustomDimensions>
42
          </Accounting>
43
          <AccountsTransaction>
44
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
46
               <Status
Status

Status of the accounts receivable transaction

Possible domain values can be found here

>{String}</Status>
47
               <TranslatedDescription
TranslatedDescription

Description of the accounts receivable transaction.

>{String}</TranslatedDescription>
48
               <Type
Type

Type of transaction

Possible domain values can be found here

>{String}</Type>
49
               <DueDate
DueDate

Date the object is due to be paid

>{Date}</DueDate>
50
               <Source>
51
                    <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
52
                    <SellersPaymentReference
SellersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

>{String}</SellersPaymentReference>
53
                    <Reference>
54
                         <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
56
                         <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
57
                         <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
58
                         <ItemType
ItemType

Type of item

>{String}</ItemType>
59
                         <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
60
                         <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
61
                    </Reference>
62
               </Source>
63
               <Totals>
64
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
65
                    <VATAmount
VATAmount

Total value added tax in object currency.

>{Decimal}</VATAmount>
66
                    <TotalAmount
TotalAmount

Total amount

>{Decimal}</TotalAmount>
67
                    <PaymentAmount
PaymentAmount

Amount which is used for the linked payment

>{Decimal}</PaymentAmount>
68
               </Totals>
69
               <TotalsConverted
TotalsConverted

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

>
70
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

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

The exchange rate used in convertion

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

>{Decimal}</ExchangeRate>
72
                    <VATAmount
VATAmount

Value added tax amount in payment currency

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

>{Decimal}</VATAmount>
73
                    <TotalAmount
TotalAmount

Total amount in payment currency

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

>{Decimal}</TotalAmount>
74
                    <PaymentAmount
PaymentAmount

Amount which is used for the linked payment in payment currency

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

>{Decimal}</PaymentAmount>
75
               </TotalsConverted>
76
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
77
          </AccountsTransaction>
78
     </Transaction>
79
     <Paging
Paging

Detailed paging information for this list.

>
80
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
83
          <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>
84
          <FirstPage
FirstPage

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

>{String}</FirstPage>
85
          <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>
86
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
87
          <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>
88
          <NextPage
NextPage

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

>{String}</NextPage>
89
          <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>
90
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
92
     </Paging>
93
</Transactions>
1
{
2
     "transactions": [
3
          {
4
               "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

": {
5
                    "vATCodeDefinition": {
6
                         "vATCodeDefinitionId
VATCodeDefinitionId

VAT code identifier

": "{Integer}",
7
                         "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Description of VAT Code definition

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

": "{String}",
9
                         "vATCodeDefinitionLink
VATCodeDefinitionLink

VAT code reference

": "{String}"
10
                    },
11
                    "generalLedgerAccount": {
12
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
13
                         "accountNumber
AccountNumber

The account number of the general ledger account

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

Name of general ledger account

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

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

General ledger account reference

": "{String}"
16
                    },
17
                    "department
Department

The department related to the item. One of the system/fixed account dimensions.

": {
18
                         "departmentId
DepartmentId

Department identifier

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

Name of department

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

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

Finance department reference

": "{String}"
21
                    },
22
                    "financeProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

": {
23
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

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

Finance project reference

": "{String}"
26
                    },
27
                    "asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

": {
28
                         "assetId
AssetId

Asset identifier

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

Name of asset

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

": "{String}",
30
                         "assetLink
AssetLink

Asset reference

": "{String}"
31
                    },
32
                    "customDimensions
CustomDimensions

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

": [
33
                         {
34
                              "value
Value

Value for this dimension defintion.

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

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

Description of the dimension value.

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

": "{String}",
36
                              "dimensionDefinition
DimensionDefinition

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

": {
37
                                   "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

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

Name of dimension

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

": "{String}",
39
                                   "dimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

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

": "{String}"
40
                              }
41
                         }
42
                    ]
43
               },
44
               "accountsTransaction": {
45
                    "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
47
                    "status
Status

Status of the accounts receivable transaction

Possible domain values can be found here

": "{String}",
48
                    "translatedDescription
TranslatedDescription

Description of the accounts receivable transaction.

": "{String}",
49
                    "type
Type

Type of transaction

Possible domain values can be found here

": "{String}",
50
                    "dueDate
DueDate

Date the object is due to be paid

": "{Date}",
51
                    "source": {
52
                         "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
53
                         "sellersPaymentReference
SellersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

": "{String}",
54
                         "reference": {
55
                              "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

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

Identifier of the object

": "{Integer}",
59
                              "itemType
ItemType

Type of item

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

API reference to the item

": "{String}",
61
                              "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
62
                         }
63
                    },
64
                    "totals": {
65
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
66
                         "vATAmount
VATAmount

Total value added tax in object currency.

": "{Decimal}",
67
                         "totalAmount
TotalAmount

Total amount

": "{Decimal}",
68
                         "paymentAmount
PaymentAmount

Amount which is used for the linked payment

": "{Decimal}"
69
                    },
70
                    "totalsConverted
TotalsConverted

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

": {
71
                         "currency
Currency

Three character code following the ISO 4217 standard

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

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

The exchange rate used in convertion

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

": "{Decimal}",
73
                         "vATAmount
VATAmount

Value added tax amount in payment currency

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

": "{Decimal}",
74
                         "totalAmount
TotalAmount

Total amount in payment currency

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

": "{Decimal}",
75
                         "paymentAmount
PaymentAmount

Amount which is used for the linked payment in payment currency

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

": "{Decimal}"
76
                    },
77
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
78
               }
79
          }
80
     ],
81
     "paging
Paging

Detailed paging information for this list.

": {
82
          "pageSize
PageSize

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

": "{Integer}",
83
          "position
Position

Position of the first element in the list

": "{Integer}",
84
          "page
Page

Page index

": "{Integer}",
85
          "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}",
86
          "firstPage
FirstPage

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

": "{String}",
87
          "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}",
88
          "previousPage
PreviousPage

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

": "{String}",
89
          "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}",
90
          "nextPage
NextPage

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

": "{String}",
91
          "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}",
92
          "lastPage
LastPage

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

": "{String}",
93
          "size
Size

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

": "{Integer}"
94
     }
95
}

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 101420 HTTP 404 Setting definition not found