API

Finance APIs

GET finance/payment-items

List of payment items

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

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
PaymentsWithMessage() Named filter Payments with items that has system message
PaymentWithDeviation() Named filter Payments with items that has deviation
SupplierPayments() Named filter Supplier payments
AssigneeId Integer Employee identifier. Available macros: currentUser()
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.
ConfirmationDate Date Payment confirmation date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CounterpartyId Integer Identifier of the object.
CounterpartyIntercompanyCode String Intercompany database the customer belongs to.
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.
CustomerId Integer Customer identifier.
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.
IssueDate Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
PaymentAdvanceAmount Decimal Advance/prepaid payment amount.
PaymentId Integer Payment identifier.
PaymentItemId Integer Item-/line-number of the payment.
Period Integer Accounting period.
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.
SendNumber String Send number.
Status Integer Status of payment.
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).
SystemMessage String Message on payment item.
TotalAmount Decimal Total paid amount.

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

AssigneeId Integer Employee identifier
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
ConfirmationDate Date Payment confirmation date
CounterpartyId Integer Identifier of the object
CounterpartyIntercompanyCode String Intercompany database the customer belongs to.
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
CustomerId Integer Customer identifier
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
IssueDate Date Date when the document was issued.
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
PaymentAdvanceAmount Decimal Advance/prepaid payment amount
PaymentId Integer Payment identifier
PaymentItemId Integer Item-/line-number of the payment.
Period Integer Accounting period
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
SendNumber String Send number
Status Integer Status of payment
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)
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
<PaymentItems>
2
     <PaymentItem>
3
          <PaymentItemId
PaymentItemId

Item-/line-number of the payment.

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

Status code of the the payment item.

Possible domain values can be found here

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

Date and time of creation

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

Payment item note

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

Payment remmitance advice

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

Payment remmitance advice date

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

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

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

English name of country.

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

Payment confirmation date

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

Payment reporting code

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

Payment reporting text

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

Message on payment item

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

The customer or supplier involved in the payment item

>
16
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

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

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

Secondary name of a company or firstname of a person

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

API reference to the object

>{String}</ObjectLink>
21
          </Counterparty>
22
          <Intercompany>
23
               <Code
Code

Intercompany database the customer belongs to.

>{String}</Code>
24
          </Intercompany>
25
          <JournalEntry
JournalEntry

Payable or receivable journal entry involved in the payment item

>
26
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
28
               <GeneralLedgerPosting>
29
                    <GeneralLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

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

General ledger posting reference

>{String}</GeneralLedgerPostingLink>
31
               </GeneralLedgerPosting>
32
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
33
          </JournalEntry>
34
          <AccountsTransaction
AccountsTransaction

Accounts receivable or payable transaction involved in the payment item

>
35
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
37
               <Totals>
38
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

Total value added tax in object currency.

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

Total amount

>{Decimal}</TotalAmount>
41
               </Totals>
42
               <TotalsConverted
TotalsConverted

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

>
43
                    <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=PaymentItem.AccountsTransaction.TotalsConverted in your request URI to get this field

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

The exchange rate used in convertion

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

>{Decimal}</ExchangeRate>
45
                    <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=PaymentItem.AccountsTransaction.TotalsConverted in your request URI to get this field

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

Total amount in company currency.

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

>{Decimal}</TotalAmount>
47
               </TotalsConverted>
48
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
49
          </AccountsTransaction>
50
          <VATPosting>
51
               <VATPostingId
VATPostingId

VAT Posting identifier

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

VAT Posting reference

>{String}</VATPostingLink>
53
          </VATPosting>
54
          <Totals>
55
               <GeneralLedgerPostingAmount
GeneralLedgerPostingAmount

Total GL posting amount

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

Three character code following the ISO 4217 standard

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

The amount of the currency adjustment to the payment item.

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

Payment item deviation amount.

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

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

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

Number of related documents for payment

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

Advance/prepaid payment amount

>{Decimal}</PaymentAdvanceAmount>
62
               <TotalAmount
TotalAmount

Total paid amount

>{Decimal}</TotalAmount>
63
          </Totals>
64
          <Payment>
65
               <PaymentId
PaymentId

Payment identifier

>{Integer}</PaymentId>
66
               <SendNumber
SendNumber

Send number

>{String}</SendNumber>
67
               <BankAccount>
68
                    <BankAccountId
BankAccountId

Bank account identifier

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

Name of bank account

>{String}</Name>
70
                    <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>
71
                    <BankAccountLink
BankAccountLink

Bank reference

>{String}</BankAccountLink>
72
               </BankAccount>
73
               <AccountingPeriod>
74
                    <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

>{String}</AccountingPeriodLink>
77
               </AccountingPeriod>
78
               <PaymentLink
PaymentLink

Payment reference

>{String}</PaymentLink>
79
          </Payment>
80
          <PaymentItemLink
PaymentItemLink

Payment item reference

>{String}</PaymentItemLink>
81
     </PaymentItem>
82
     <Paging
Paging

Detailed paging information for this list.

>
83
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
86
          <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>
87
          <FirstPage
FirstPage

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

>{String}</FirstPage>
88
          <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>
89
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
90
          <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>
91
          <NextPage
NextPage

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

>{String}</NextPage>
92
          <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>
93
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
95
     </Paging>
96
</PaymentItems>
1
{
2
     "paymentItems": [
3
          {
4
               "paymentItemId
PaymentItemId

Item-/line-number of the payment.

": "{Integer}",
5
               "status
Status

Status code of the the payment item.

Possible domain values can be found here

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

Date and time of creation

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

Payment item note

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

Payment remmitance advice

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

Payment remmitance advice date

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

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

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

English name of country.

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

Payment confirmation date

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

Payment reporting code

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

Payment reporting text

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

Message on payment item

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

The customer or supplier involved in the payment item

": {
17
                    "objectId
ObjectId

Identifier of the object

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

Type of object

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

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

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

Secondary name of a company or firstname of a person

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

API reference to the object

": "{String}"
22
               },
23
               "intercompany": {
24
                    "code
Code

Intercompany database the customer belongs to.

": "{String}"
25
               },
26
               "journalEntry
JournalEntry

Payable or receivable journal entry involved in the payment item

": {
27
                    "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
29
                    "generalLedgerPosting": {
30
                         "generalLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

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

General ledger posting reference

": "{String}"
32
                    },
33
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
34
               },
35
               "accountsTransaction
AccountsTransaction

Accounts receivable or payable transaction involved in the payment item

": {
36
                    "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
38
                    "totals": {
39
                         "currency
Currency

Three character code following the ISO 4217 standard

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

Total value added tax in object currency.

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

Total amount

": "{Decimal}"
42
                    },
43
                    "totalsConverted
TotalsConverted

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

": {
44
                         "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=PaymentItem.AccountsTransaction.TotalsConverted in your request URI to get this field

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

The exchange rate used in convertion

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

": "{Decimal}",
46
                         "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=PaymentItem.AccountsTransaction.TotalsConverted in your request URI to get this field

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

Total amount in company currency.

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

": "{Decimal}"
48
                    },
49
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
50
               },
51
               "vATPosting": {
52
                    "vATPostingId
VATPostingId

VAT Posting identifier

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

VAT Posting reference

": "{String}"
54
               },
55
               "totals": {
56
                    "generalLedgerPostingAmount
GeneralLedgerPostingAmount

Total GL posting amount

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

Three character code following the ISO 4217 standard

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

The amount of the currency adjustment to the payment item.

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

Payment item deviation amount.

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

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

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

Number of related documents for payment

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

Advance/prepaid payment amount

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

Total paid amount

": "{Decimal}"
64
               },
65
               "payment": {
66
                    "paymentId
PaymentId

Payment identifier

": "{Integer}",
67
                    "sendNumber
SendNumber

Send number

": "{String}",
68
                    "bankAccount": {
69
                         "bankAccountId
BankAccountId

Bank account identifier

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

Name of bank account

": "{String}",
71
                         "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}",
72
                         "bankAccountLink
BankAccountLink

Bank reference

": "{String}"
73
                    },
74
                    "accountingPeriod": {
75
                         "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

": "{String}"
78
                    },
79
                    "paymentLink
PaymentLink

Payment reference

": "{String}"
80
               },
81
               "paymentItemLink
PaymentItemLink

Payment item reference

": "{String}"
82
          }
83
     ],
84
     "paging
Paging

Detailed paging information for this list.

": {
85
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
97
     }
98
}

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: