API

Sales APIs

GET sales/credit-note-items

List of all sales credit note items

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

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.

AccountingPeriod Integer Accounting period. Available macros: currentPeriod(), previousPeriod()
ConvertedGrossAmount Decimal Total gross amount in company currency.
ConvertedGrossPrice Decimal Represents the price per unit before any discounting is applied.
ConvertedNetAmount Decimal Total net amount in company currency.
ConvertedNetPrice Decimal Final price per unit after deducting all discounts.
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.
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).
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
DepartmentId Integer Department identifier.
Discount Decimal The discount for the item.
DiscountPercent Decimal The discount in percent for this item.
EndCustomerFirstName String Secondary name of a company or firstname of a person.
EndCustomerId Integer Customer identifier.
EndCustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
FinanceProjectId Integer Finance project identifier.
GeneralLedgerAccountId Integer General ledger account identifier.
GeneralLedgerAccountNumber String The account number of the general ledger account.
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossMargin Decimal Gross margin of the item.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
ManufacturerId Integer Manufacturer identifier.
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal Quantity of the sales credit note item.
SalesCreditNoteId Integer Sales credit note identifier.
SalesCreditNoteItemId Integer Item-/line-number of the credit note.
Status Integer Status code of the the credit note item.
UpdatedAt Datetime Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

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

AccountingPeriod Integer Accounting period
ConvertedGrossAmount Decimal Total gross amount in company currency.
ConvertedGrossPrice Decimal Represents the price per unit before any discounting is applied.
ConvertedNetAmount Decimal Total net amount in company currency.
ConvertedNetPrice Decimal Final price per unit after deducting all discounts.
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
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)
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
DepartmentId Integer Department identifier
Discount Decimal The discount for the item.
DiscountPercent Decimal The discount in percent for this item.
EndCustomerFirstName String Secondary name of a company or firstname of a person
EndCustomerId Integer Customer identifier
EndCustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
FinanceProjectId Integer Finance project identifier
GeneralLedgerAccountId Integer General ledger account identifier
GeneralLedgerAccountNumber String The account number of the general ledger account
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossMargin Decimal Gross margin of the item.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
ManufacturerId Integer Manufacturer identifier
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
Quantity Decimal Quantity of the sales credit note item
SalesCreditNoteId Integer Sales credit note identifier
SalesCreditNoteItemId Integer Item-/line-number of the credit note
Status Integer Status code of the the credit note item
UpdatedAt Datetime Date and time of update

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
<SalesCreditNoteItems>
2
     <SalesCreditNoteItem>
3
          <SalesCreditNoteItemId
SalesCreditNoteItemId

Item-/line-number of the credit note

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

Status code of the the credit note item

Possible domain values can be found here

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

Date and time of creation

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

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

>{Integer}</LineNumber>
7
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

>{String}</CustomersReferenceNumber>
8
          <CustomersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

>{String}</CustomersProductName>
9
          <RequestedProductRevision>
10
               <Revision
Revision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

>{String}</Revision>
11
          </RequestedProductRevision>
12
          <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

>{String}</ProductDescription>
13
          <GrossMargin
GrossMargin

Gross margin of the item.

>{Decimal}</GrossMargin>
14
          <DiscountPercent
DiscountPercent

The discount in percent for this item.

>{Decimal}</DiscountPercent>
15
          <VATPercent
VATPercent

Value added tax percent

>{Decimal}</VATPercent>
16
          <Quantity
Quantity

Quantity of the sales credit note item

>{Decimal}</Quantity>
17
          <EndCustomer
EndCustomer

End customer

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

>
18
               <CustomerId
CustomerId

Customer identifier

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

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

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

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

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

Secondary name of a company or firstname of a person

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

>{String}</FirstName>
21
               <VATRegistrationNumber
VATRegistrationNumber

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

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

>{String}</VATRegistrationNumber>
22
               <CustomerLink
CustomerLink

Customer reference

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

>{String}</CustomerLink>
23
          </EndCustomer>
24
          <Price>
25
               <Currency
Currency

Three character code following the ISO 4217 standard

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

The discount for the item.

>{Decimal}</Discount>
27
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>
28
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
29
          </Price>
30
          <PriceConverted
PriceConverted

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

>
31
               <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=SalesCreditNoteItem.PriceConverted in your request URI to get this field

>{String}</Currency>
32
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

>{Decimal}</GrossPrice>
33
               <NetPrice
NetPrice

Final price per unit after deducting all discounts.

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

>{Decimal}</NetPrice>
34
          </PriceConverted>
35
          <Totals>
36
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
37
               <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

>{Decimal}</GrossAmount>
38
               <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
39
          </Totals>
40
          <TotalsConverted
TotalsConverted

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

>
41
               <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=SalesCreditNoteItem.TotalsConverted in your request URI to get this field

>{String}</Currency>
42
               <GrossAmount
GrossAmount

Total gross amount in company currency.

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

>{Decimal}</GrossAmount>
43
               <NetAmount
NetAmount

Total net amount in company currency.

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

>{Decimal}</NetAmount>
44
          </TotalsConverted>
45
          <MeasurementUnit>
46
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

>{Integer}</MeasurementUnitId>
47
               <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>
48
               <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
49
          </MeasurementUnit>
50
          <Product>
51
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
52
               <Name
Name

Name of the product

>{String}</Name>
53
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
54
               <Manufacturer>
55
                    <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
56
                    <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
57
               </Manufacturer>
58
          </Product>
59
          <LandedCost>
60
               <GrossPrice
GrossPrice

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

>{Decimal}</GrossPrice>
61
               <PurchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

>{Decimal}</PurchaseExchangeRate>
62
          </LandedCost>
63
          <LandedCostConverted
LandedCostConverted

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

>
64
               <GrossPrice
GrossPrice

Total cost (landed cost or true cost) in sales currency

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

>{Decimal}</GrossPrice>
65
          </LandedCostConverted>
66
          <Accounting
Accounting

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

>
67
               <VATCodeDefinition>
68
                    <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Description of VAT Code definition

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

>{String}</Description>
70
               </VATCodeDefinition>
71
               <GeneralLedgerAccount>
72
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

The account number of the general ledger account

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

Name of general ledger account

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

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

General ledger account reference

>{String}</GeneralLedgerAccountLink>
76
               </GeneralLedgerAccount>
77
               <Department
Department

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

>
78
                    <DepartmentId
DepartmentId

Department identifier

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

Name of department

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

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

Finance department reference

>{String}</DepartmentLink>
81
               </Department>
82
               <FinanceProject
FinanceProject

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

>
83
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

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

Finance project reference

>{String}</FinanceProjectLink>
86
               </FinanceProject>
87
               <Asset
Asset

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

>
88
                    <AssetId
AssetId

Asset identifier

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

Name of asset

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

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

Asset reference

>{String}</AssetLink>
91
               </Asset>
92
               <CustomDimensions
CustomDimensions

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

>
93
                    <Dimension
Dimension

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

>
94
                         <Value
Value

Value for this dimension defintion.

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

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

Description of the dimension value.

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

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

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

>
97
                              <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

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

Name of dimension

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

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

Dimension reference

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

>{String}</DimensionDefinitionLink>
100
                         </DimensionDefinition>
101
                    </Dimension>
102
               </CustomDimensions>
103
          </Accounting>
104
          <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
105
               <ForwardedFromItem>
106
                    <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
107
                    <Object>
108
                         <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>{String}</ObjectLink>
111
                    </Object>
112
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
114
               </ForwardedFromItem>
115
          </ForwardedFrom>
116
          <InitialSalesOrderItem
InitialSalesOrderItem

Reference to the initial/first/original sales order item in the document flow for this item.

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

>
117
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

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

>{Integer}</SalesOrderItemId>
118
               <SalesOrder
SalesOrder

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

>
119
                    <SalesOrderId
SalesOrderId

Sales order identifier

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

>{Integer}</SalesOrderId>
120
                    <RegistrationDate
RegistrationDate

Date of registration

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

>{Date}</RegistrationDate>
121
                    <SalesOrderLink
SalesOrderLink

Sales order reference

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

>{String}</SalesOrderLink>
122
               </SalesOrder>
123
               <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

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

>{String}</SalesOrderItemLink>
124
          </InitialSalesOrderItem>
125
          <HighlightedNotification
HighlightedNotification

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

>
126
               <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

>{Datetime}</CreatedAt>
129
               <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=SalesCreditNoteItem.HighlightedNotification in your request URI to get this field

>{String}</Message>
130
               <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=SalesCreditNoteItem.HighlightedNotification in your request URI to get this field

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

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

>
132
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
133
                    <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=SalesCreditNoteItem.HighlightedNotification in your request URI to get this field

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

Notification type reference

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

>{String}</NotificationTypeLink>
135
               </NotificationType>
136
               <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
137
          </HighlightedNotification>
138
          <SalesCreditNote>
139
               <SalesCreditNoteId
SalesCreditNoteId

Sales credit note identifier

>{Integer}</SalesCreditNoteId>
140
               <Customer>
141
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

>{String}</Firstname>
144
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
145
               </Customer>
146
               <SalesCreditNoteLink
SalesCreditNoteLink

Sales credit note reference

>{String}</SalesCreditNoteLink>
147
          </SalesCreditNote>
148
          <SalesCreditNoteItemLink
SalesCreditNoteItemLink

Sales credit note Item reference

>{String}</SalesCreditNoteItemLink>
149
     </SalesCreditNoteItem>
150
     <Paging
Paging

Detailed paging information for this list.

>
151
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
154
          <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>
155
          <FirstPage
FirstPage

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

>{String}</FirstPage>
156
          <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>
157
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
158
          <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>
159
          <NextPage
NextPage

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

>{String}</NextPage>
160
          <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>
161
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
163
     </Paging>
164
</SalesCreditNoteItems>
1
{
2
     "salesCreditNoteItems": [
3
          {
4
               "salesCreditNoteItemId
SalesCreditNoteItemId

Item-/line-number of the credit note

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

Status code of the the credit note item

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
7
               "lineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

": "{Integer}",
8
               "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

": "{String}",
9
               "customersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

": "{String}",
10
               "requestedProductRevision": {
11
                    "revision
Revision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

": "{String}"
12
               },
13
               "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

": "{String}",
14
               "grossMargin
GrossMargin

Gross margin of the item.

": "{Decimal}",
15
               "discountPercent
DiscountPercent

The discount in percent for this item.

": "{Decimal}",
16
               "vATPercent
VATPercent

Value added tax percent

": "{Decimal}",
17
               "quantity
Quantity

Quantity of the sales credit note item

": "{Decimal}",
18
               "endCustomer
EndCustomer

End customer

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

": {
19
                    "customerId
CustomerId

Customer identifier

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

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

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

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

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

Secondary name of a company or firstname of a person

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

": "{String}",
22
                    "vATRegistrationNumber
VATRegistrationNumber

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

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

": "{String}",
23
                    "customerLink
CustomerLink

Customer reference

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

": "{String}"
24
               },
25
               "price": {
26
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
27
                    "discount
Discount

The discount for the item.

": "{Decimal}",
28
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

": "{Decimal}",
29
                    "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"
30
               },
31
               "priceConverted
PriceConverted

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

": {
32
                    "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=SalesCreditNoteItem.PriceConverted in your request URI to get this field

": "{String}",
33
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

": "{Decimal}",
34
                    "netPrice
NetPrice

Final price per unit after deducting all discounts.

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

": "{Decimal}"
35
               },
36
               "totals": {
37
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
38
                    "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

": "{Decimal}",
39
                    "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}"
40
               },
41
               "totalsConverted
TotalsConverted

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

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

": "{String}",
43
                    "grossAmount
GrossAmount

Total gross amount in company currency.

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

": "{Decimal}",
44
                    "netAmount
NetAmount

Total net amount in company currency.

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

": "{Decimal}"
45
               },
46
               "measurementUnit": {
47
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

": "{Integer}",
48
                    "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",
49
                    "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
50
               },
51
               "product": {
52
                    "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
55
                    "manufacturer": {
56
                         "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
57
                         "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
58
                    }
59
               },
60
               "landedCost": {
61
                    "grossPrice
GrossPrice

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

": "{Decimal}",
62
                    "purchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

": "{Decimal}"
63
               },
64
               "landedCostConverted
LandedCostConverted

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

": {
65
                    "grossPrice
GrossPrice

Total cost (landed cost or true cost) in sales currency

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

": "{Decimal}"
66
               },
67
               "accounting
Accounting

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

": {
68
                    "vATCodeDefinition": {
69
                         "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Description of VAT Code definition

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

": "{String}"
71
                    },
72
                    "generalLedgerAccount": {
73
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

The account number of the general ledger account

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

Name of general ledger account

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

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

General ledger account reference

": "{String}"
77
                    },
78
                    "department
Department

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

": {
79
                         "departmentId
DepartmentId

Department identifier

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

Name of department

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

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

Finance department reference

": "{String}"
82
                    },
83
                    "financeProject
FinanceProject

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

": {
84
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

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

Finance project reference

": "{String}"
87
                    },
88
                    "asset
Asset

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

": {
89
                         "assetId
AssetId

Asset identifier

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

Name of asset

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

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

Asset reference

": "{String}"
92
                    },
93
                    "customDimensions
CustomDimensions

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

": [
94
                         {
95
                              "value
Value

Value for this dimension defintion.

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

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

Description of the dimension value.

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

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

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

": {
98
                                   "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

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

Name of dimension

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

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

Dimension reference

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

": "{String}"
101
                              }
102
                         }
103
                    ]
104
               },
105
               "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

": {
106
                    "forwardedFromItem": {
107
                         "itemId
ItemId

Identifier of the object

": "{Integer}",
108
                         "object": {
109
                              "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

": "{String}"
112
                         },
113
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}"
115
                    }
116
               },
117
               "initialSalesOrderItem
InitialSalesOrderItem

Reference to the initial/first/original sales order item in the document flow for this item.

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

": {
118
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

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

": "{Integer}",
119
                    "salesOrder
SalesOrder

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

": {
120
                         "salesOrderId
SalesOrderId

Sales order identifier

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

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

Date of registration

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

": "{Date}",
122
                         "salesOrderLink
SalesOrderLink

Sales order reference

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

": "{String}"
123
                    },
124
                    "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

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

": "{String}"
125
               },
126
               "highlightedNotification
HighlightedNotification

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

": {
127
                    "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

": "{Datetime}",
130
                    "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=SalesCreditNoteItem.HighlightedNotification in your request URI to get this field

": "{String}",
131
                    "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=SalesCreditNoteItem.HighlightedNotification in your request URI to get this field

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

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

": {
133
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

": "{String}",
134
                         "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=SalesCreditNoteItem.HighlightedNotification in your request URI to get this field

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

Notification type reference

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

": "{String}"
136
                    },
137
                    "notificationLink
NotificationLink

Notification reference

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

": "{String}"
138
               },
139
               "salesCreditNote": {
140
                    "salesCreditNoteId
SalesCreditNoteId

Sales credit note identifier

": "{Integer}",
141
                    "customer": {
142
                         "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

": "{String}",
145
                         "customerLink
CustomerLink

Customer reference

": "{String}"
146
                    },
147
                    "salesCreditNoteLink
SalesCreditNoteLink

Sales credit note reference

": "{String}"
148
               },
149
               "salesCreditNoteItemLink
SalesCreditNoteItemLink

Sales credit note Item reference

": "{String}"
150
          }
151
     ],
152
     "paging
Paging

Detailed paging information for this list.

": {
153
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
165
     }
166
}

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 102738 HTTP 404 Price list not found
Error 101420 HTTP 404 Setting definition not found