API

Finance APIs

GET system/reports/100204/result-set

Overview of payment items

Report name Payment items
Report identifier 100204
HTTP method GET
URI https://api.rambase.net/system/reports/100204/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6519, version 17

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.

Registered() Named filter Registered payments.
AccountingPeriodId Integer Accounting period.
AssigneeId Integer User identifier. Available macros: currentUser()
BankAccountId Integer Bank account identifier.
BankPaymentReference String Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector.
ConfirmationDate Date Payment confirmation date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CounterpartyIntercompanyCode String Intercompany database the customer belongs to.
CounterpartyObjectId Integer Identifier of the object.
CounterpartyObjectType String Type of object.
CountryCode String Two-character code (ISO 3166) identifying the country.
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.
CurrencyAdjustmentAmount Decimal The amount of the currency adjustment to the payment item.
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.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
DeviationAmount Decimal Payment item deviation amount.
DocumentAmount Decimal Object related amount (Invoice, payment and/or credit note).
DocumentQuantity Integer Number of related documents for payment.
GeneralLedgerPostingAmount Decimal Total GL posting amount.
InternalReference String Payment reference. E.g. sales invoice or sales order document number.
IssueDate Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Note String Payment note.
PaymentAdvanceAmount Decimal Advance/prepaid payment amount.
PaymentId Integer Payment identifier.
PaymentItemId Integer Item-/line-number of the payment.
Rate Decimal Payment Currency Rate.
RemittanceHandling String Method of payment. Default value is retrieved from the supplier or customer.
RemmitanceAdvice String Payment remmitance advice.
RemmitanceAdviceDate Date Payment remmitance advice date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ReportingCode String Payment reporting code.
ReportingText String Payment reporting text.
Status Integer Status code of the the payment item.
SupplierFirstName String Firstname/givenname if the supplier is a person.
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person).
SystemMessage String Message on payment item.
TotalAmount Decimal Total paid amount.

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

AccountingPeriodId Integer Accounting period
AssigneeId Integer User identifier
BankAccountId Integer Bank account identifier
BankPaymentReference String Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector
ConfirmationDate Date Payment confirmation date
CounterpartyIntercompanyCode String Intercompany database the customer belongs to.
CounterpartyObjectId Integer Identifier of the object
CounterpartyObjectType String Type of object
CountryCode String Two-character code (ISO 3166) identifying the country.
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
CurrencyAdjustmentAmount Decimal The amount of the currency adjustment to the payment item.
CurrencyDate Date Currency date of the transaction
CustomerFirstName String Secondary name of a company or firstname of a person
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
DeviationAmount Decimal Payment item deviation amount.
DocumentAmount Decimal Object related amount (Invoice, payment and/or credit note)
DocumentQuantity Integer Number of related documents for payment
GeneralLedgerPostingAmount Decimal Total GL posting amount
InternalReference String Payment reference. E.g. sales invoice or sales order document number.
IssueDate Date Date when the document was issued.
Note String Payment note
PaymentAdvanceAmount Decimal Advance/prepaid payment amount
PaymentId Integer Payment identifier
PaymentItemId Integer Item-/line-number of the payment.
Rate Decimal Payment Currency Rate
RemittanceHandling String Method of payment. Default value is retrieved from the supplier or customer
RemmitanceAdvice String Payment remmitance advice
RemmitanceAdviceDate Date Payment remmitance advice date
ReportingCode String Payment reporting code
ReportingText String Payment reporting text
Status Integer Status code of the the payment item.
SupplierFirstName String Firstname/givenname if the supplier is a person
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person)
SystemMessage String Message on payment item
TotalAmount Decimal Total paid amount

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 code of the the payment item.

Possible domain values can be found here

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

Item-/line-number of the payment.

>{Integer}</PaymentItemId>
6
               <CreatedAt
CreatedAt

Date and time of creation

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

>{Datetime}</CreatedAt>
7
               <Note
Note

Payment item note

>{String}</Note>
8
               <RemmitanceAdvice
RemmitanceAdvice

Payment remmitance advice

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

>{String}</RemmitanceAdvice>
9
               <RemmitanceAdviceDate
RemmitanceAdviceDate

Payment remmitance advice date

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

>{Date}</RemmitanceAdviceDate>
10
               <CountryCode
CountryCode

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

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

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

English name of country.

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

>{String}</Country>
12
               <ConfirmationDate
ConfirmationDate

Payment confirmation date

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

>{Date}</ConfirmationDate>
13
               <ReportingCode
ReportingCode

Payment reporting code

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

>{String}</ReportingCode>
14
               <ReportingText
ReportingText

Payment reporting text

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

>{String}</ReportingText>
15
               <SystemMessage
SystemMessage

Message on payment item

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

>{String}</SystemMessage>
16
               <Payment
Payment

Payment reference

>
17
                    <PaymentId
PaymentId

Payment identifier

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

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

>{String}</RemittanceHandling>
19
                    <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
20
                    <CurrencyDate
CurrencyDate

Currency date of the transaction

>{Date}</CurrencyDate>
21
                    <InternalReference
InternalReference

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

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

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

>{String}</BankPaymentReference>
23
                    <BankAccount
BankAccount

Bank account reference

>
24
                         <BankAccountId
BankAccountId

Bank account identifier

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

Name of bank account

>{String}</Name>
26
                         <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>
27
                         <AccountNumber
AccountNumber

Account number used to identify the bank account

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

Currency used for the bank account

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

Bank

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

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

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

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

Bank phone number

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

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

Address of the bank associated with the bank account

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

>
33
                                   <AddressLine1
AddressLine1

First address line

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

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

Second address line

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

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

Postalcode/Postcode/ZIP

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

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

City/town/village

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

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

English name of country.

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

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

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

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

>{String}</CountryCode>
39
                              </Address>
40
                         </Bank>
41
                         <BankAccountLink
BankAccountLink

Bank reference

>{String}</BankAccountLink>
42
                    </BankAccount>
43
                    <Assignee
Assignee

The user who has been assigned to work with this object.

>
44
                         <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
48
                    </Assignee>
49
                    <AccountingPeriod
AccountingPeriod

Accounting period reference

>
50
                         <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

>{String}</AccountingPeriodLink>
53
                    </AccountingPeriod>
54
                    <PaymentLink
PaymentLink

Payment reference

>{String}</PaymentLink>
55
               </Payment>
56
               <PaymentItemLink
PaymentItemLink

Payment item reference

>{String}</PaymentItemLink>
57
               <Counterparty
Counterparty

Customer or Supplier reference

>
58
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

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

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

Secondary name of a company or firstname of a person

>{String}</FirstName>
62
                    <ObjectLink
ObjectLink

API reference to the object

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

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
64
               </Counterparty>
65
               <Intercompany
Intercompany

Intercompany reference

>
66
                    <Code
Code

Intercompany database the customer belongs to.

>{String}</Code>
67
               </Intercompany>
68
               <JournalEntry
JournalEntry

Payable or receivable journal entry involved in the payment item

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

>
69
                    <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

>{String}</ObjectType>
71
                    <GeneralLedgerPosting
GeneralLedgerPosting

General ledger posting reference

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

>
72
                         <GeneralLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

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

>{Integer}</GeneralLedgerPostingId>
73
                         <GeneralLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

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

>{String}</GeneralLedgerPostingLink>
74
                    </GeneralLedgerPosting>
75
                    <ObjectLink
ObjectLink

API reference to the object

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

>{String}</ObjectLink>
76
               </JournalEntry>
77
               <AccountsTransaction
AccountsTransaction

Accounts receivable or payable transaction involved in the payment item

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

>
78
                    <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

>{String}</ObjectType>
80
                    <Totals
Totals

Total amounts

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

>
81
                         <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=Rows.Row.AccountsTransaction in your request URI to get this field

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

Total value added tax in object currency.

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

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

Total amount

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

>{Decimal}</TotalAmount>
84
                    </Totals>
85
                    <TotalsConverted
TotalsConverted

Totals converted to local currency

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

>
86
                         <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=Rows.Row.AccountsTransaction in your request URI to get this field

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

The exchange rate used in convertion

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

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

Value added tax amount in company currency.

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

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

Total amount in company currency.

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

>{Decimal}</TotalAmount>
90
                    </TotalsConverted>
91
                    <ObjectLink
ObjectLink

API reference to the object

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

>{String}</ObjectLink>
92
               </AccountsTransaction>
93
               <VATPosting
VATPosting

VAT posting

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

>
94
                    <VATPostingId
VATPostingId

VAT Posting identifier

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

>{Integer}</VATPostingId>
95
                    <VATPostingLink
VATPostingLink

VAT Posting reference

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

>{String}</VATPostingLink>
96
               </VATPosting>
97
               <Totals
Totals

Total amounts

>
98
                    <GeneralLedgerPostingAmount
GeneralLedgerPostingAmount

Total GL posting amount

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

>{Decimal}</GeneralLedgerPostingAmount>
99
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
100
                    <CurrencyAdjustmentAmount
CurrencyAdjustmentAmount

The amount of the currency adjustment to the payment item.

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

>{Decimal}</CurrencyAdjustmentAmount>
101
                    <DeviationAmount
DeviationAmount

Payment item deviation amount.

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

>{Decimal}</DeviationAmount>
102
                    <DocumentAmount
DocumentAmount

Object related amount (Invoice, payment and/or credit note)

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

>{Decimal}</DocumentAmount>
103
                    <DocumentQuantity
DocumentQuantity

Number of related documents for payment

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

>{Integer}</DocumentQuantity>
104
                    <PaymentAdvanceAmount
PaymentAdvanceAmount

Advance/prepaid payment amount

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

>{Decimal}</PaymentAdvanceAmount>
105
                    <Rate
Rate

Payment Currency Rate

>{Decimal}</Rate>
106
                    <TotalAmount
TotalAmount

Total paid amount

>{Decimal}</TotalAmount>
107
               </Totals>
108
               <Inspect>
109
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
110
               </Inspect>
111
          </Row>
112
     </Rows>
113
     <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

>
114
          <Totals
Totals

Total amounts

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

>
115
               <TotalAmount
TotalAmount

Total paid amount

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}</TotalAmount>
116
               <GeneralLedgerPostingAmount
GeneralLedgerPostingAmount

Total GL posting amount

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}</GeneralLedgerPostingAmount>
117
               <CurrencyAdjustmentAmount
CurrencyAdjustmentAmount

The amount of the currency adjustment to the payment item.

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

>{Decimal}</CurrencyAdjustmentAmount>
118
               <DeviationAmount
DeviationAmount

Payment item deviation amount.

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}</DeviationAmount>
119
               <DocumentAmount
DocumentAmount

Object related amount (Invoice, payment and/or credit note)

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}</DocumentAmount>
120
               <PaymentAdvanceAmount
PaymentAdvanceAmount

Advance/prepaid payment amount

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}</PaymentAdvanceAmount>
121
          </Totals>
122
     </Aggregated>
123
     <Paging
Paging

Detailed paging information for this list.

>
124
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
127
          <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>
128
          <FirstPage
FirstPage

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

>{String}</FirstPage>
129
          <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>
130
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
131
          <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>
132
          <NextPage
NextPage

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

>{String}</NextPage>
133
          <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>
134
          <LastPage
LastPage

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

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

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

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

Status code of the the payment item.

Possible domain values can be found here

": "{Integer}",
6
                    "paymentItemId
PaymentItemId

Item-/line-number of the payment.

": "{Integer}",
7
                    "createdAt
CreatedAt

Date and time of creation

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

": "{Datetime}",
8
                    "note
Note

Payment item note

": "{String}",
9
                    "remmitanceAdvice
RemmitanceAdvice

Payment remmitance advice

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

": "{String}",
10
                    "remmitanceAdviceDate
RemmitanceAdviceDate

Payment remmitance advice date

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

": "{Date}",
11
                    "countryCode
CountryCode

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

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

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

English name of country.

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

": "{String}",
13
                    "confirmationDate
ConfirmationDate

Payment confirmation date

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

": "{Date}",
14
                    "reportingCode
ReportingCode

Payment reporting code

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

": "{String}",
15
                    "reportingText
ReportingText

Payment reporting text

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

": "{String}",
16
                    "systemMessage
SystemMessage

Message on payment item

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

": "{String}",
17
                    "payment
Payment

Payment reference

": {
18
                         "paymentId
PaymentId

Payment identifier

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

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

": "{String}",
20
                         "issueDate
IssueDate

Date when the document was issued.

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

Currency date of the transaction

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

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

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

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

": "{String}",
24
                         "bankAccount
BankAccount

Bank account reference

": {
25
                              "bankAccountId
BankAccountId

Bank account identifier

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

Name of bank account

": "{String}",
27
                              "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}",
28
                              "accountNumber
AccountNumber

Account number used to identify the bank account

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

Currency used for the bank account

": "{String}",
30
                              "bank
Bank

Bank

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

": {
31
                                   "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.

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

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

Bank phone number

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

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

Address of the bank associated with the bank account

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

": {
34
                                        "addressLine1
AddressLine1

First address line

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

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

Second address line

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

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

Postalcode/Postcode/ZIP

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

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

City/town/village

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

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

English name of country.

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

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

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

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

": "{String}"
40
                                   }
41
                              },
42
                              "bankAccountLink
BankAccountLink

Bank reference

": "{String}"
43
                         },
44
                         "assignee
Assignee

The user who has been assigned to work with this object.

": {
45
                              "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
49
                         },
50
                         "accountingPeriod
AccountingPeriod

Accounting period reference

": {
51
                              "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

": "{String}"
54
                         },
55
                         "paymentLink
PaymentLink

Payment reference

": "{String}"
56
                    },
57
                    "paymentItemLink
PaymentItemLink

Payment item reference

": "{String}",
58
                    "counterparty
Counterparty

Customer or Supplier reference

": {
59
                         "objectId
ObjectId

Identifier of the object

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

Type of object

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

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

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

Secondary name of a company or firstname of a person

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

API reference to the object

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

Internal RamBase identifier of the object/item

": "{String}"
65
                    },
66
                    "intercompany
Intercompany

Intercompany reference

": {
67
                         "code
Code

Intercompany database the customer belongs to.

": "{String}"
68
                    },
69
                    "journalEntry
JournalEntry

Payable or receivable journal entry involved in the payment item

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

": {
70
                         "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

": "{String}",
72
                         "generalLedgerPosting
GeneralLedgerPosting

General ledger posting reference

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

": {
73
                              "generalLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

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

": "{Integer}",
74
                              "generalLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

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

": "{String}"
75
                         },
76
                         "objectLink
ObjectLink

API reference to the object

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

": "{String}"
77
                    },
78
                    "accountsTransaction
AccountsTransaction

Accounts receivable or payable transaction involved in the payment item

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

": {
79
                         "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

": "{String}",
81
                         "totals
Totals

Total amounts

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

": {
82
                              "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=Rows.Row.AccountsTransaction in your request URI to get this field

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

Total value added tax in object currency.

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

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

Total amount

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

": "{Decimal}"
85
                         },
86
                         "totalsConverted
TotalsConverted

Totals converted to local currency

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

": {
87
                              "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=Rows.Row.AccountsTransaction in your request URI to get this field

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

The exchange rate used in convertion

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

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

Value added tax amount in company currency.

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

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

Total amount in company currency.

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

": "{Decimal}"
91
                         },
92
                         "objectLink
ObjectLink

API reference to the object

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

": "{String}"
93
                    },
94
                    "vATPosting
VATPosting

VAT posting

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

": {
95
                         "vATPostingId
VATPostingId

VAT Posting identifier

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

": "{Integer}",
96
                         "vATPostingLink
VATPostingLink

VAT Posting reference

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

": "{String}"
97
                    },
98
                    "totals
Totals

Total amounts

": {
99
                         "generalLedgerPostingAmount
GeneralLedgerPostingAmount

Total GL posting amount

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

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

Three character code following the ISO 4217 standard

": "{String}",
101
                         "currencyAdjustmentAmount
CurrencyAdjustmentAmount

The amount of the currency adjustment to the payment item.

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

": "{Decimal}",
102
                         "deviationAmount
DeviationAmount

Payment item deviation amount.

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

": "{Decimal}",
103
                         "documentAmount
DocumentAmount

Object related amount (Invoice, payment and/or credit note)

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

": "{Decimal}",
104
                         "documentQuantity
DocumentQuantity

Number of related documents for payment

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

": "{Integer}",
105
                         "paymentAdvanceAmount
PaymentAdvanceAmount

Advance/prepaid payment amount

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

": "{Decimal}",
106
                         "rate
Rate

Payment Currency Rate

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

Total paid amount

": "{Decimal}"
108
                    },
109
                    "inspect": {
110
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
111
                    }
112
               }
113
          ],
114
          "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

": {
115
               "totals
Totals

Total amounts

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

": {
116
                    "totalAmount
TotalAmount

Total paid amount

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}",
117
                    "generalLedgerPostingAmount
GeneralLedgerPostingAmount

Total GL posting amount

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}",
118
                    "currencyAdjustmentAmount
CurrencyAdjustmentAmount

The amount of the currency adjustment to the payment item.

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

": "{Decimal}",
119
                    "deviationAmount
DeviationAmount

Payment item deviation amount.

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}",
120
                    "documentAmount
DocumentAmount

Object related amount (Invoice, payment and/or credit note)

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}",
121
                    "paymentAdvanceAmount
PaymentAdvanceAmount

Advance/prepaid payment amount

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}"
122
               }
123
          }
124
     }
125
}

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