API

Finance APIs

GET finance/payments

List of payments

HTTP method GET
URI https://api.rambase.net/finance/payments
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 509, version 42

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.

ClearingPayments() Named filter Clearing payments
CustomerPayments() Named filter Customer payments
MixedPayments() Named filter Mixed payments
MyPayments() Named filter Payments created by current user.
PaymentsWithMessages() Named filter Payments with items that has system message
PaymentWithDeviation() Named filter Payments with items that has deviation
Pending() Named filter Payments pending registration.
Registered() Named filter Registered payments.
SupplierPayments() Named filter Supplier payments
AssigneeFirstName String First name of the user.
AssigneeId Integer Employee identifier. Available macros: currentUser()
AssigneeName String Name of the user.
BankAccountAccountNumber String Account number used to identify the bank account.
BankAccountCurrency String Currency used for the bank account.
BankAccountIBAN String The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.
BankAccountId Integer Bank account identifier.
BankAccountName String Name of bank account.
BankAddressLine1 String First address line.
BankAddressLine2 String Second address line.
BankCity String City/town/village.
BankCountryCode String Two-character code (ISO 3166) identifying the country.
BankPaymentReference String Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector.
BankPhone String Bank phone number.
BankPostalCode String Postalcode/Postcode/ZIP.
BankStatementAccountingPeriodId Integer Accounting period identifier.
BankStatementReference String Bank statement reference.
BankStatementSortIndex Integer Sorting index of bank statement.
BankSWIFTCode String The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments..
CounterpartyId Integer Identifier of the object.
CounterpartyIntercompanyCode String Intercompany database the customer belongs to.
CounterpartyObjectType String Type of object.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Currency String Three character code following the ISO 4217 standard.
CurrencyDate Date Currency date of the transaction. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerFirstName String Secondary name of a company or firstname of a person.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
GeneralLedgerAccountId Integer General ledger account identifier.
GeneralLedgerAccountName String Name of general ledger account.
GeneralLedgerAccountNumber String The account number of the general ledger account.
InternalReference String Payment reference. E.g. sales invoice or sales order document number.
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
PaymentId Integer Payment identifier.
Period Integer Accounting period.
Rate Decimal Exchange rate of the currency.
ReceiveDate Datetime Date when the payment was received from the bank. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RemittanceHandling String Method of payment. Default value is retrieved from the supplier or customer.
SendDate Date Date when the payment was send to the bank or in PAM the payment created. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SendNumber String Send number.
Status Integer Status of payment.
SubTotalAmount Decimal Total amount of the object in object currency, excluding VAT.
SupplierFirstName String Firstname/givenname if the supplier is a person.
SupplierId Integer RamBase supplier identifier.
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person).
Term String Terms of payment. Defaut value is retrieved from the customer or supplier.
TotalAmount Decimal Total amount.
Type String Type of counterparty with whom the payment is related.

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

AssigneeFirstName String First name of the user
AssigneeId Integer Employee identifier
AssigneeName String Name of the user
BankAccountAccountNumber String Account number used to identify the bank account
BankAccountCurrency String Currency used for the bank account
BankAccountIBAN String The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.
BankAccountId Integer Bank account identifier
BankAccountName String Name of bank account
BankAddressLine1 String First address line
BankAddressLine2 String Second address line
BankCity String City/town/village
BankCountryCode String Two-character code (ISO 3166) identifying the country.
BankPaymentReference String Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector
BankPhone String Bank phone number
BankPostalCode String Postalcode/Postcode/ZIP
BankStatementAccountingPeriodId Integer Accounting period identifier
BankStatementReference String Bank statement reference
BankStatementSortIndex Integer Sorting index of bank statement
BankSWIFTCode String The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.
CounterpartyId Integer Identifier of the object
CounterpartyIntercompanyCode String Intercompany database the customer belongs to.
CounterpartyObjectType String Type of object
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
CurrencyDate Date Currency date of the transaction
CustomerFirstName String Secondary name of a company or firstname of a person
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
GeneralLedgerAccountId Integer General ledger account identifier
GeneralLedgerAccountName String Name of general ledger account
GeneralLedgerAccountNumber String The account number of the general ledger account
InternalReference String Payment reference. E.g. sales invoice or sales order document number.
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
PaymentId Integer Payment identifier
Period Integer Accounting period
Rate Decimal Exchange rate of the currency
ReceiveDate Datetime Date when the payment was received from the bank
RegistrationDate Date Date of registration
RemittanceHandling String Method of payment. Default value is retrieved from the supplier or customer
SendDate Date Date when the payment was send to the bank or in PAM the payment created
SendNumber String Send number
Status Integer Status of payment
SubTotalAmount Decimal Total amount of the object in object currency, excluding VAT.
SupplierFirstName String Firstname/givenname if the supplier is a person
SupplierId Integer RamBase supplier identifier
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person)
Term String Terms of payment. Defaut value is retrieved from the customer or supplier
TotalAmount Decimal Total amount
Type String Type of counterparty with whom the payment is related

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
<Payments>
2
     <Payment>
3
          <PaymentId
PaymentId

Payment identifier

>{Integer}</PaymentId>
4
          <RemittanceHandling
RemittanceHandling

Method of payment. Default value is retrieved from the supplier or customer

>{String}</RemittanceHandling>
5
          <Term
Term

Terms of payment. Defaut value is retrieved from the customer or supplier

>{String}</Term>
6
          <Type
Type

Type of counterparty with whom the payment is related

Possible domain values can be found here

>{String}</Type>
7
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
8
          <Status
Status

Status of payment

Possible domain values can be found here

>{Integer}</Status>
9
          <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
10
          <CurrencyDate
CurrencyDate

Currency date of the transaction

>{Date}</CurrencyDate>
11
          <SendDate
SendDate

Date when the payment was send to the bank or in PAM the payment created

>{Date}</SendDate>
12
          <InternalReference
InternalReference

Payment reference. E.g. sales invoice or sales order document number.

>{String}</InternalReference>
13
          <BankPaymentReference
BankPaymentReference

Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector

>{String}</BankPaymentReference>
14
          <SendNumber
SendNumber

Send number

>{String}</SendNumber>
15
          <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

>{String}</Note>
16
          <HasDeviationOnItem
HasDeviationOnItem

If the payment has items with deviations

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

>{Boolean}</HasDeviationOnItem>
17
          <HasSystemMessageOnItem
HasSystemMessageOnItem

If the pay has messages on items

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

>{Boolean}</HasSystemMessageOnItem>
18
          <IsBankStatementExcluded
IsBankStatementExcluded

In case of pay with excluded bank statement

>{Boolean}</IsBankStatementExcluded>
19
          <NumberOfCounterparties
NumberOfCounterparties

Number of unique counterparties this payment has

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

>{Integer}</NumberOfCounterparties>
20
          <NumberOfBankStatementTransactions
NumberOfBankStatementTransactions

Number of unique bank statement transactions this payment has

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

>{Integer}</NumberOfBankStatementTransactions>
21
          <BankAccount>
22
               <BankAccountId
BankAccountId

Bank account identifier

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

Name of bank account

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

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

>{String}</IBAN>
25
               <AccountNumber
AccountNumber

Account number used to identify the bank account

>{String}</AccountNumber>
26
               <Currency
Currency

Currency used for the bank account

>{String}</Currency>
27
               <BankAccountLink
BankAccountLink

Bank reference

>{String}</BankAccountLink>
28
               <Bank>
29
                    <SWIFTCode
SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

>{String}</SWIFTCode>
30
                    <Phone
Phone

Bank phone number

>{String}</Phone>
31
                    <Address
Address

Address of the bank associated with the bank account

>
32
                         <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

>{String}</City>
36
                         <Country
Country

English name of country.

>{String}</Country>
37
                         <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
38
                    </Address>
39
               </Bank>
40
          </BankAccount>
41
          <FirstCounterparty
FirstCounterparty

The customer or supplier involved in the payment item

>
42
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
44
               <Name
Name

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

>{String}</Name>
45
               <FirstName
FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>
46
               <Intercompany>
47
                    <Code
Code

Intercompany database the customer belongs to.

>{String}</Code>
48
               </Intercompany>
49
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
50
          </FirstCounterparty>
51
          <GeneralLedgerAccount
GeneralLedgerAccount

Finance account associated with the bank account

>
52
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

The account number of the general ledger account

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

Name of general ledger account

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

General ledger account reference

>{String}</GeneralLedgerAccountLink>
56
          </GeneralLedgerAccount>
57
          <FirstBankStatementTransaction>
58
               <TransactionId
TransactionId

Transaction identifier of the bank statement

>{Integer}</TransactionId>
59
               <BankStatement>
60
                    <BankStatementId
BankStatementId

Bank statement identifier

>{Integer}</BankStatementId>
61
                    <SortIndex
SortIndex

Sorting index of bank statement

>{Integer}</SortIndex>
62
                    <AccountingPeriod>
63
                         <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

>{String}</AccountingPeriodLink>
66
                    </AccountingPeriod>
67
                    <BankStatementLink
BankStatementLink

Bank statement reference

>{String}</BankStatementLink>
68
               </BankStatement>
69
               <TransactionLink
TransactionLink

Bank statement transaction reference

>{String}</TransactionLink>
70
          </FirstBankStatementTransaction>
71
          <AccountingPeriod>
72
               <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

>{String}</AccountingPeriodLink>
75
          </AccountingPeriod>
76
          <Assignee>
77
               <UserId
UserId

User identifier

>{Integer}</UserId>
78
               <Name
Name

Name of the user

>{String}</Name>
79
               <FirstName
FirstName

First name of the user

>{String}</FirstName>
80
               <UserLink
UserLink

User reference

>{String}</UserLink>
81
          </Assignee>
82
          <Totals>
83
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
84
               <Rate
Rate

Exchange rate of the currency

>{Decimal}</Rate>
85
               <SubTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

>{Decimal}</SubTotalAmount>
86
               <TotalAmount
TotalAmount

Total amount

>{Decimal}</TotalAmount>
87
          </Totals>
88
     </Payment>
89
     <Paging
Paging

Detailed paging information for this list.

>
90
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
93
          <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>
94
          <FirstPage
FirstPage

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

>{String}</FirstPage>
95
          <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>
96
          <PreviousPage
PreviousPage

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

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

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

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

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

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

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

>{Integer}</Size>
102
     </Paging>
103
</Payments>
1
{
2
     "payments": [
3
          {
4
               "paymentId
PaymentId

Payment identifier

": "{Integer}",
5
               "remittanceHandling
RemittanceHandling

Method of payment. Default value is retrieved from the supplier or customer

": "{String}",
6
               "term
Term

Terms of payment. Defaut value is retrieved from the customer or supplier

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

Type of counterparty with whom the payment is related

Possible domain values can be found here

": "{String}",
8
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
9
               "status
Status

Status of payment

Possible domain values can be found here

": "{Integer}",
10
               "registrationDate
RegistrationDate

Date of registration

": "{Date}",
11
               "currencyDate
CurrencyDate

Currency date of the transaction

": "{Date}",
12
               "sendDate
SendDate

Date when the payment was send to the bank or in PAM the payment created

": "{Date}",
13
               "internalReference
InternalReference

Payment reference. E.g. sales invoice or sales order document number.

": "{String}",
14
               "bankPaymentReference
BankPaymentReference

Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector

": "{String}",
15
               "sendNumber
SendNumber

Send number

": "{String}",
16
               "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

": "{String}",
17
               "hasDeviationOnItem
HasDeviationOnItem

If the payment has items with deviations

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

": "{Boolean}",
18
               "hasSystemMessageOnItem
HasSystemMessageOnItem

If the pay has messages on items

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

": "{Boolean}",
19
               "isBankStatementExcluded
IsBankStatementExcluded

In case of pay with excluded bank statement

": "{Boolean}",
20
               "numberOfCounterparties
NumberOfCounterparties

Number of unique counterparties this payment has

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

": "{Integer}",
21
               "numberOfBankStatementTransactions
NumberOfBankStatementTransactions

Number of unique bank statement transactions this payment has

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

": "{Integer}",
22
               "bankAccount": {
23
                    "bankAccountId
BankAccountId

Bank account identifier

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

Name of bank account

": "{String}",
25
                    "iBAN
IBAN

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

": "{String}",
26
                    "accountNumber
AccountNumber

Account number used to identify the bank account

": "{String}",
27
                    "currency
Currency

Currency used for the bank account

": "{String}",
28
                    "bankAccountLink
BankAccountLink

Bank reference

": "{String}",
29
                    "bank": {
30
                         "sWIFTCode
SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

": "{String}",
31
                         "phone
Phone

Bank phone number

": "{String}",
32
                         "address
Address

Address of the bank associated with the bank account

": {
33
                              "addressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

English name of country.

": "{String}",
38
                              "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}"
39
                         }
40
                    }
41
               },
42
               "firstCounterparty
FirstCounterparty

The customer or supplier involved in the payment item

": {
43
                    "objectId
ObjectId

Identifier of the object

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

Type of object

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

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

": "{String}",
46
                    "firstName
FirstName

Secondary name of a company or firstname of a person

": "{String}",
47
                    "intercompany": {
48
                         "code
Code

Intercompany database the customer belongs to.

": "{String}"
49
                    },
50
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
51
               },
52
               "generalLedgerAccount
GeneralLedgerAccount

Finance account associated with the bank account

": {
53
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

The account number of the general ledger account

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

Name of general ledger account

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

General ledger account reference

": "{String}"
57
               },
58
               "firstBankStatementTransaction": {
59
                    "transactionId
TransactionId

Transaction identifier of the bank statement

": "{Integer}",
60
                    "bankStatement": {
61
                         "bankStatementId
BankStatementId

Bank statement identifier

": "{Integer}",
62
                         "sortIndex
SortIndex

Sorting index of bank statement

": "{Integer}",
63
                         "accountingPeriod": {
64
                              "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

": "{String}"
67
                         },
68
                         "bankStatementLink
BankStatementLink

Bank statement reference

": "{String}"
69
                    },
70
                    "transactionLink
TransactionLink

Bank statement transaction reference

": "{String}"
71
               },
72
               "accountingPeriod": {
73
                    "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

": "{String}"
76
               },
77
               "assignee": {
78
                    "userId
UserId

User identifier

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

Name of the user

": "{String}",
80
                    "firstName
FirstName

First name of the user

": "{String}",
81
                    "userLink
UserLink

User reference

": "{String}"
82
               },
83
               "totals": {
84
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
85
                    "rate
Rate

Exchange rate of the currency

": "{Decimal}",
86
                    "subTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

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

Total amount

": "{Decimal}"
88
               }
89
          }
90
     ],
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}",
93
          "position
Position

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
104
     }
105
}

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: