API

Sales APIs

GET sales/credit-notes

List of sales credit notes

HTTP method GET
URI https://api.rambase.net/sales/credit-notes
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 200
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 409, version 25

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"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$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.

InfoNotification() Named filter Sales credit notes with notifications of category I (Information)
MyCreditNotes() Named filter Sales credit notes assigned to this user
PendingRegistration() Named filter Sales credit notes which are not yet registered
AccountingPeriod Integer Accounting period. Available macros: currentPeriod(), previousPeriod()
AccountManager Integer Reference to the employee who is responsible for the management of sales, and relationship with the customer. Available macros: currentUser()
Assignee Integer User identifier.
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId String Notification type identifier.
ConvertedSubTotalAmount Decimal Total amount of the object in company currency, excluding VAT.
ConvertedTotalAmount Decimal The total amount in company currency, including VAT.
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.
CustomerId Integer Customer identifier.
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
ExternalReference String External sales credit note reference/identifier. Can be used in external systems.
FeeAmount Decimal Fee amount in transaction document's currency.
Firstname String Secondary name of a company or firstname of a person.
FreightAmount Decimal Freight amount in transaction document's currency.
InterCompanyCode String Intercompany database the customer belongs to.
IsCorrectionInvoice Boolean Indicates if an credit note is marked as a correction invoice.
Name String Name of customer (name of company or surname/familyname/lastname of a person).
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SalesCreditNoteId Integer Sales credit note identifier.
SellersReferenceNumber String Sellers reference number..
Status String Status of the sales credit note.
SubTotalAmount Decimal Total amount of the object in object currency, excluding VAT.
TotalAmount Decimal The total amount in object currency, including VAT.
VATAmount Decimal Total value added tax in object currency.
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

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

AccountingPeriod Integer Accounting period
AccountManager Integer Reference to the employee who is responsible for the management of sales, and relationship with the customer.
Assignee Integer User identifier
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId String Notification type identifier
ConvertedSubTotalAmount Decimal Total amount of the object in company currency, excluding VAT.
ConvertedTotalAmount Decimal The total amount in company currency, including VAT.
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
CustomerId Integer Customer identifier
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
ExternalReference String External sales credit note reference/identifier. Can be used in external systems.
FeeAmount Decimal Fee amount in transaction document's currency
Firstname String Secondary name of a company or firstname of a person
FreightAmount Decimal Freight amount in transaction document's currency
InterCompanyCode String Intercompany database the customer belongs to.
IsCorrectionInvoice Boolean Indicates if an credit note is marked as a correction invoice
Name String Name of customer (name of company or surname/familyname/lastname of a person)
RegistrationDate Date Date of registration
SalesCreditNoteId Integer Sales credit note identifier
SellersReferenceNumber String Sellers reference number.
Status String Status of the sales credit note
SubTotalAmount Decimal Total amount of the object in object currency, excluding VAT.
TotalAmount Decimal The total amount in object currency, including VAT
VATAmount Decimal Total value added tax in object currency.
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

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
<SalesCreditNotes>
2
     <SalesCreditNote>
3
          <SalesCreditNoteId
SalesCreditNoteId

Sales credit note identifier

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

Status of the sales credit note

Possible domain values can be found here

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

Date and time of creation

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

Date of registration

>{Date}</RegistrationDate>
7
          <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
8
          <SellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

>{String}</SellersReferenceNumber>
9
          <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
10
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
11
          <ExternalReference
ExternalReference

External sales credit note reference/identifier. Can be used in external systems.

>{String}</ExternalReference>
12
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
13
          <CreditReason
CreditReason

Field used to specify the reason for the credit

>{String}</CreditReason>
14
          <AccountingPeriod>
15
               <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

>{String}</AccountingPeriodLink>
18
          </AccountingPeriod>
19
          <Assignee
Assignee

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

>
20
               <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
24
          </Assignee>
25
          <Customer>
26
               <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
27
               <Name
Name

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

>{String}</Name>
28
               <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
29
               <Intercompany>
30
                    <Code
Code

Intercompany database the customer belongs to.

>{String}</Code>
31
               </Intercompany>
32
               <Sales>
33
                    <AccountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

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

>
34
                         <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
35
                         <LastName
LastName

Last name of employee

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

>{String}</LastName>
36
                         <FirstName
FirstName

First name of employee

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

>{String}</FirstName>
37
                         <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
38
                    </AccountManager>
39
               </Sales>
40
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
41
          </Customer>
42
          <Totals>
43
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Freight amount in transaction document's currency

>{Decimal}</FreightAmount>
45
               <FeeAmount
FeeAmount

Fee amount in transaction document's currency

>{Decimal}</FeeAmount>
46
               <SubTotalAmount
SubTotalAmount

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

>{Decimal}</SubTotalAmount>
47
               <VATAmount
VATAmount

Total value added tax in object currency.

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

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
49
          </Totals>
50
          <TotalsConverted
TotalsConverted

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

>
51
               <Currency
Currency

Currency used in conversion. Default is company accounting 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=SalesCreditNote.TotalsConverted in your request URI to get this field

>{String}</Currency>
52
               <SubTotalAmount
SubTotalAmount

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

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

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

The total amount in company currency, including VAT.

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

>{Decimal}</TotalAmount>
54
          </TotalsConverted>
55
          <VATDetails>
56
               <VATEntity>
57
                    <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

>{String}</VATRegistrationNumber>
58
               </VATEntity>
59
          </VATDetails>
60
          <HighlightedNotification
HighlightedNotification

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

>
61
               <NotificationId
NotificationId

Notification identifier

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

>{Integer}</NotificationId>
62
               <Status
Status

Status of the notification

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

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

Date and time of creation

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

>{Datetime}</CreatedAt>
64
               <Message
Message

The message from the notification definition, expanded with parameters.

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

>{String}</Message>
65
               <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

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

>{String}</TranslatedMessage>
66
               <NotificationType
NotificationType

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

>
67
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
68
                    <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

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

>{String}</Category>
69
                    <NotificationTypeLink
NotificationTypeLink

Notification type reference

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

>{String}</NotificationTypeLink>
70
               </NotificationType>
71
               <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
72
          </HighlightedNotification>
73
          <SalesCreditNoteLink
SalesCreditNoteLink

Sales credit note reference

>{String}</SalesCreditNoteLink>
74
     </SalesCreditNote>
75
     <Paging
Paging

Detailed paging information for this list.

>
76
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
79
          <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>
80
          <FirstPage
FirstPage

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

>{String}</FirstPage>
81
          <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>
82
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
83
          <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>
84
          <NextPage
NextPage

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

>{String}</NextPage>
85
          <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>
86
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
88
     </Paging>
89
</SalesCreditNotes>
1
{
2
     "salesCreditNotes": [
3
          {
4
               "salesCreditNoteId
SalesCreditNoteId

Sales credit note identifier

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

Status of the sales credit note

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
7
               "registrationDate
RegistrationDate

Date of registration

": "{Date}",
8
               "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
9
               "sellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

": "{String}",
10
               "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
11
               "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
12
               "externalReference
ExternalReference

External sales credit note reference/identifier. Can be used in external systems.

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
14
               "creditReason
CreditReason

Field used to specify the reason for the credit

": "{String}",
15
               "accountingPeriod": {
16
                    "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

": "{String}"
19
               },
20
               "assignee
Assignee

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

": {
21
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
25
               },
26
               "customer": {
27
                    "customerId
CustomerId

Customer identifier

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

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

": "{String}",
29
                    "firstname
Firstname

Secondary name of a company or firstname of a person

": "{String}",
30
                    "intercompany": {
31
                         "code
Code

Intercompany database the customer belongs to.

": "{String}"
32
                    },
33
                    "sales": {
34
                         "accountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

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

": {
35
                              "employeeId
EmployeeId

Employee identifier

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

": "{Integer}",
36
                              "lastName
LastName

Last name of employee

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

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

First name of employee

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

": "{String}",
38
                              "employeeLink
EmployeeLink

Employee reference

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

": "{String}"
39
                         }
40
                    },
41
                    "customerLink
CustomerLink

Customer reference

": "{String}"
42
               },
43
               "totals": {
44
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
45
                    "freightAmount
FreightAmount

Freight amount in transaction document's currency

": "{Decimal}",
46
                    "feeAmount
FeeAmount

Fee amount in transaction document's currency

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

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

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

Total value added tax in object currency.

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

The total amount in object currency, including VAT

": "{Decimal}"
50
               },
51
               "totalsConverted
TotalsConverted

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

": {
52
                    "currency
Currency

Currency used in conversion. Default is company accounting 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=SalesCreditNote.TotalsConverted in your request URI to get this field

": "{String}",
53
                    "subTotalAmount
SubTotalAmount

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

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

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

The total amount in company currency, including VAT.

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

": "{Decimal}"
55
               },
56
               "vATDetails": {
57
                    "vATEntity": {
58
                         "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

": "{String}"
59
                    }
60
               },
61
               "highlightedNotification
HighlightedNotification

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

": {
62
                    "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

": "{Datetime}",
65
                    "message
Message

The message from the notification definition, expanded with parameters.

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

": "{String}",
66
                    "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

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

": "{String}",
67
                    "notificationType
NotificationType

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

": {
68
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

": "{String}",
69
                         "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

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

": "{String}",
70
                         "notificationTypeLink
NotificationTypeLink

Notification type reference

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

": "{String}"
71
                    },
72
                    "notificationLink
NotificationLink

Notification reference

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

": "{String}"
73
               },
74
               "salesCreditNoteLink
SalesCreditNoteLink

Sales credit note reference

": "{String}"
75
          }
76
     ],
77
     "paging
Paging

Detailed paging information for this list.

": {
78
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
90
     }
91
}

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 100147 HTTP 404 Notification type not found