API

Sales APIs

POST sales/invoices/{salesInvoiceId}/items

Creates a new item in provided sales invoice

HTTP method POST
URI https://api.rambase.net/sales/invoices/{salesInvoiceId}/items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesInvoiceId} Sales invoice identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 4687, version 5

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
<SalesInvoiceItem>
2
     <CustomersReferenceNumber
CustomersReferenceNumber

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

This field is optional.

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

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

This field is optional.

>
{String}</CustomersProductName>
4
     <ProductDescription
ProductDescription

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

This field is optional.

>
{String}</ProductDescription>
5
     <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

>
{String}</Note>
6
     <EquivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

This field is optional.

>
{String}</EquivalentProductName>
7
     <Quantity
Quantity

Required/mandatory field

Quantity of sales invoice item

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

End customer

This field is optional.

>
9
          <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>
{Integer}</CustomerId>
10
     </EndCustomer>
11
     <Product>
12
          <ProductId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

>
{Integer}</ProductId>
13
     </Product>
14
     <Price
Price

This field is optional.

>
15
          <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

This field is optional.

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

The discount for the item.

Minimum value: 0

This field is optional.

>
{Decimal}</Discount>
17
     </Price>
18
</SalesInvoiceItem>
1
{
2
     "salesInvoiceItem": {
3
          "customersReferenceNumber
CustomersReferenceNumber

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

This field is optional.

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

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

This field is optional.

":
"{String}",
5
          "productDescription
ProductDescription

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

This field is optional.

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

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

":
"{String}",
7
          "equivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

This field is optional.

":
"{String}",
8
          "quantity
Quantity

Required/mandatory field

Quantity of sales invoice item

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

End customer

This field is optional.

":
{
10
               "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

":
"{Integer}"
11
          },
12
          "product": {
13
               "productId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

":
"{Integer}"
14
          },
15
          "price
Price

This field is optional.

":
{
16
               "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

This field is optional.

":
"{Decimal}",
17
               "discount
Discount

The discount for the item.

Minimum value: 0

This field is optional.

":
"{Decimal}"
18
          }
19
     }
20
}

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.

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

Read more about filters and sorting on how to use filter parameters and named filters.

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

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SalesInvoiceItem>
2
     <SalesInvoiceItemId
SalesInvoiceItemId

Item-/line-number of the invoice

>
{Integer}</SalesInvoiceItemId>
3
     <Status
Status

Status code of the the invoice item

Possible domain values can be found here

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

Date and time of creation

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

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

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

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

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

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

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

Name of product with equivalent behavior and attributes. Can be used for same purpose.

>
{String}</EquivalentProductName>
9
     <ProductDescription
ProductDescription

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

>
{String}</ProductDescription>
10
     <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>
{String}</Note>
11
     <GrossMargin
GrossMargin

Gross margin of the item.

>
{Decimal}</GrossMargin>
12
     <VATPercent
VATPercent

Value added tax percent

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

The discount in percent for this item.

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

Quantity of sales invoice item

>
{Decimal}</Quantity>
15
     <DeliveryDate
DeliveryDate

The date on which the supply of goods or services was made or completed.

>
{Date}</DeliveryDate>
16
     <CountryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

>
17
          <CustomerId
CustomerId

Customer identifier

>
{Integer}</CustomerId>
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
          <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>
21
          <CustomerLink
CustomerLink

Customer reference

>
{String}</CustomerLink>
22
     </CountryOfOriginCode>
23
     <RequestedProductRevision>
24
          <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>
25
     </RequestedProductRevision>
26
     <ExchangeRateFluctuation>
27
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Represents the exchange rate fluctuation amount

>
{Decimal}</Amount>
29
          <Percent
Percent

The percent of change that resulted in fluctuation price change

>
{Decimal}</Percent>
30
     </ExchangeRateFluctuation>
31
     <Price>
32
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

The discount for the item.

>
{Decimal}</Discount>
35
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>
{Decimal}</NetPrice>
36
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

Final price per unit after deducting all discounts.

>
{Decimal}</NetPrice>
39
     </Price>
40
     <Totals>
41
          <Currency
Currency

Three character code following the ISO 4217 standard

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

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

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

The items discount amount.

>
{Decimal}</DiscountAmount>
44
          <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>
{Decimal}</NetAmount>
45
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Total gross amount in company currency.

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

Total net amount in company currency.

>
{Decimal}</NetAmount>
48
     </Totals>
49
     <Seller
Seller

Reference to the seller of the item

>
50
          <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
51
          <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
52
     </Seller>
53
     <MeasurementUnit>
54
          <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

>
{String}</MeasurementUnitLink>
57
     </MeasurementUnit>
58
     <Product>
59
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>
{String}</Type>
62
          <CustomField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

>
{String}</CustomField1>
63
          <CustomField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

>
{String}</CustomField2>
64
          <Manufacturer>
65
               <ManufacturerId
ManufacturerId

Manufacturer identifier

>
{Integer}</ManufacturerId>
66
               <ShortName
ShortName

Shortname/code of the manufacturer

>
{String}</ShortName>
67
               <ManufacturerLink
ManufacturerLink

Manufacturer reference

>
{String}</ManufacturerLink>
68
          </Manufacturer>
69
          <ProductClassification>
70
               <ProductClassificationId
ProductClassificationId

Product classification identifier

>
{String}</ProductClassificationId>
71
               <ProductClassificationLink
ProductClassificationLink

Product classification reference

>
{String}</ProductClassificationLink>
72
          </ProductClassification>
73
          <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
74
     </Product>
75
     <LandedCost>
76
          <PurchaseCurrency
PurchaseCurrency

Purchase currency is the currency this product normally is purchased in. This is also the base currency used in the gross margin calculation. By default the purchase currency is retrieved from the product.

Possible domain values can be found here

>
{String}</PurchaseCurrency>
77
          <PurchasePrice
PurchasePrice

Purchase price for each unit

>
{Decimal}</PurchasePrice>
78
          <Freight
Freight

Estimated freight cost of getting each unit in stock. Used for calculating landed cost.

>
{Decimal}</Freight>
79
          <Duty
Duty

Duty cost of getting each unit in stock. Used for calculating landed cost.

>
{Decimal}</Duty>
80
          <Charge
Charge

Other costs of getting each unit in stock. Used for calculating landed cost.

>
{Decimal}</Charge>
81
          <GrossPrice
GrossPrice

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

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

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

>
{Decimal}</PurchaseExchangeRate>
83
          <IsDerivedFromUserInput
IsDerivedFromUserInput

True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments

>
{Boolean}</IsDerivedFromUserInput>
84
          <IsDerivedFromPreferredPurchasePrice
IsDerivedFromPreferredPurchasePrice

True if the landed cost for this item is derived from preferred purchase price. This means that parts (or all) of the item has not reserved goods in stock, nor incoming goods (supplier backlog or production backlog).

>
{Boolean}</IsDerivedFromPreferredPurchasePrice>
85
          <IsDerivedFromAssignedSupplierBacklog
IsDerivedFromAssignedSupplierBacklog

True if landed cost for this item is derived from assigned supplier backlog. This means that the item has reserved incoming goods (supplier backlog or production backlog).

>
{Boolean}</IsDerivedFromAssignedSupplierBacklog>
86
          <IsDerivedFromAssignedStock
IsDerivedFromAssignedStock

True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.

>
{Boolean}</IsDerivedFromAssignedStock>
87
          <DerivedFrom>
88
               <PurchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

>
{Integer}</PurchaseQuoteItemId>
89
               <PurchaseQuote>
90
                    <Database
Database

Database of the object

>
{String}</Database>
91
                    <PurchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

>
{Integer}</PurchaseQuoteId>
92
                    <PurchaseQuoteLink
PurchaseQuoteLink

Purchase quote reference

>
{String}</PurchaseQuoteLink>
93
               </PurchaseQuote>
94
               <PurchaseQuoteItemLink
PurchaseQuoteItemLink

Purchase quote item link

>
{String}</PurchaseQuoteItemLink>
95
          </DerivedFrom>
96
          <Currency
Currency

Three character code following the ISO 4217 standard

>
{String}</Currency>
97
          <PurchasePrice
PurchasePrice

Purchase price in sales currency.

>
{Decimal}</PurchasePrice>
98
          <Freight
Freight

Freigth cost in sales currency.

>
{Decimal}</Freight>
99
          <Duty
Duty

Duty costs in sales currency.

>
{Decimal}</Duty>
100
          <Charge
Charge

Other cost in sales currency

>
{Decimal}</Charge>
101
          <GrossPrice
GrossPrice

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

>
{Decimal}</GrossPrice>
102
     </LandedCost>
103
     <Accounting
Accounting

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

>
104
          <VATCodeDefinition>
105
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>
{String}</VATCode>
106
          </VATCodeDefinition>
107
          <GeneralLedgerAccount>
108
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>
{Integer}</GeneralLedgerAccountId>
109
               <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>
{String}</GeneralLedgerAccountLink>
110
          </GeneralLedgerAccount>
111
          <Department
Department

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

>
112
               <DepartmentId
DepartmentId

Department identifier

>
{Integer}</DepartmentId>
113
               <DepartmentLink
DepartmentLink

Finance department reference

>
{String}</DepartmentLink>
114
          </Department>
115
          <FinanceProject
FinanceProject

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

>
116
               <FinanceProjectId
FinanceProjectId

Finance project identifier

>
{Integer}</FinanceProjectId>
117
               <FinanceProjectLink
FinanceProjectLink

Finance project reference

>
{String}</FinanceProjectLink>
118
          </FinanceProject>
119
          <Asset
Asset

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

>
120
               <AssetId
AssetId

Asset identifier

>
{Integer}</AssetId>
121
               <AssetLink
AssetLink

Asset reference

>
{String}</AssetLink>
122
               <Dimension>
123
                    <Value
Value

Value for this dimension defintion.

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

Description of the dimension value.

>
{String}</Description>
125
                    <DimensionDefinition>
126
                         <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

Name of dimension

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

Dimension reference

>
{String}</DimensionDefinitionLink>
129
                    </DimensionDefinition>
130
               </Dimension>
131
          </Asset>
132
     </Accounting>
133
     <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
134
          <ForwardedFromItem>
135
               <ItemId
ItemId

Identifier of the object

>
{Integer}</ItemId>
136
               <Object>
137
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>
{String}</ObjectLink>
140
               </Object>
141
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>
{String}</ItemLink>
143
          </ForwardedFromItem>
144
          <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>
{Integer}</SalesOrderItemId>
145
          <SalesOrder>
146
               <SalesOrderId
SalesOrderId

Sales order identifier

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

Date of registration

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

Sales order reference

>
{String}</SalesOrderLink>
149
          </SalesOrder>
150
          <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>
{String}</SalesOrderItemLink>
151
          <NotificationId
NotificationId

Notification identifier

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

Status of the notification

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

Date and time of creation

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

The message from the notification definition, expanded with parameters.

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

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

>
{String}</TranslatedMessage>
156
          <NotificationType>
157
               <NotificationTypeId
NotificationTypeId

Notification type identifier

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

Notification type reference

>
{String}</NotificationTypeLink>
160
          </NotificationType>
161
          <NotificationLink
NotificationLink

Notification reference

>
{String}</NotificationLink>
162
          <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

>
{Integer}</ProjectOrderItemId>
163
          <ProjectOrderItemLink
ProjectOrderItemLink

Reference to the project order item.

>
{String}</ProjectOrderItemLink>
164
          <ProjectOrderId
ProjectOrderId

Project order identifier

>
{Integer}</ProjectOrderId>
165
          <ProjectOrderLink
ProjectOrderLink

Project order reference

>
{String}</ProjectOrderLink>
166
          <RecurringInvoicePeriodId
RecurringInvoicePeriodId

Recurring invoice period identifier

>
{Integer}</RecurringInvoicePeriodId>
167
          <Period>
168
               <StartDate
StartDate

Start date of an invoice period.

>
{Date}</StartDate>
169
               <EndDate
EndDate

End date of an invoice period

>
{Date}</EndDate>
170
          </Period>
171
          <RecurringInvoicePeriodLink
RecurringInvoicePeriodLink

Recurring invoice period reference

>
{Docref-customlink}</RecurringInvoicePeriodLink>
172
     </ForwardedFrom>
173
</SalesInvoiceItem>
1
{
2
     "salesInvoiceItem": {
3
          "salesInvoiceItemId
SalesInvoiceItemId

Item-/line-number of the invoice

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

Status code of the the invoice item

Possible domain values can be found here

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

Date and time of creation

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

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

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

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

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

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

":
"{String}",
9
          "equivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

":
"{String}",
10
          "productDescription
ProductDescription

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

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

Additional information regarding the item (free text). Might be visible to customers/suppliers.

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

Gross margin of the item.

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

Value added tax percent

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

The discount in percent for this item.

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

Quantity of sales invoice item

":
"{Decimal}",
16
          "deliveryDate
DeliveryDate

The date on which the supply of goods or services was made or completed.

":
"{Date}",
17
          "countryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

":
{
18
               "customerId
CustomerId

Customer identifier

":
"{Integer}",
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
               "vATRegistrationNumber
VATRegistrationNumber

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

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

Customer reference

":
"{String}"
23
          },
24
          "requestedProductRevision": {
25
               "revision
Revision

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

":
"{String}"
26
          },
27
          "exchangeRateFluctuation": {
28
               "currency
Currency

Three character code following the ISO 4217 standard

":
"{String}",
29
               "amount
Amount

Represents the exchange rate fluctuation amount

":
"{Decimal}",
30
               "percent
Percent

The percent of change that resulted in fluctuation price change

":
"{Decimal}"
31
          },
32
          "price": {
33
               "currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

":
"{Decimal}",
35
               "discount
Discount

The discount for the item.

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

Final price per unit after deducting all discounts etc.

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

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

Final price per unit after deducting all discounts.

":
"{Decimal}"
40
          },
41
          "totals": {
42
               "currency
Currency

Three character code following the ISO 4217 standard

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

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

":
"{Decimal}",
44
               "discountAmount
DiscountAmount

The items discount amount.

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

Final item amount after deducting all discounts etc.

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

Three character code following the ISO 4217 standard

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

Total gross amount in company currency.

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

Total net amount in company currency.

":
"{Decimal}"
49
          },
50
          "seller
Seller

Reference to the seller of the item

":
{
51
               "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
52
               "employeeLink
EmployeeLink

Employee reference

":
"{String}"
53
          },
54
          "measurementUnit": {
55
               "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

":
"{String}"
58
          },
59
          "product": {
60
               "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

":
"{String}",
63
               "customField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

":
"{String}",
64
               "customField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

":
"{String}",
65
               "manufacturer": {
66
                    "manufacturerId
ManufacturerId

Manufacturer identifier

":
"{Integer}",
67
                    "shortName
ShortName

Shortname/code of the manufacturer

":
"{String}",
68
                    "manufacturerLink
ManufacturerLink

Manufacturer reference

":
"{String}"
69
               },
70
               "productClassification": {
71
                    "productClassificationId
ProductClassificationId

Product classification identifier

":
"{String}",
72
                    "productClassificationLink
ProductClassificationLink

Product classification reference

":
"{String}"
73
               },
74
               "productLink
ProductLink

Product reference

":
"{String}"
75
          },
76
          "landedCost": {
77
               "purchaseCurrency
PurchaseCurrency

Purchase currency is the currency this product normally is purchased in. This is also the base currency used in the gross margin calculation. By default the purchase currency is retrieved from the product.

Possible domain values can be found here

":
"{String}",
78
               "purchasePrice
PurchasePrice

Purchase price for each unit

":
"{Decimal}",
79
               "freight
Freight

Estimated freight cost of getting each unit in stock. Used for calculating landed cost.

":
"{Decimal}",
80
               "duty
Duty

Duty cost of getting each unit in stock. Used for calculating landed cost.

":
"{Decimal}",
81
               "charge
Charge

Other costs of getting each unit in stock. Used for calculating landed cost.

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

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

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

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

":
"{Decimal}",
84
               "isDerivedFromUserInput
IsDerivedFromUserInput

True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments

":
"{Boolean}",
85
               "isDerivedFromPreferredPurchasePrice
IsDerivedFromPreferredPurchasePrice

True if the landed cost for this item is derived from preferred purchase price. This means that parts (or all) of the item has not reserved goods in stock, nor incoming goods (supplier backlog or production backlog).

":
"{Boolean}",
86
               "isDerivedFromAssignedSupplierBacklog
IsDerivedFromAssignedSupplierBacklog

True if landed cost for this item is derived from assigned supplier backlog. This means that the item has reserved incoming goods (supplier backlog or production backlog).

":
"{Boolean}",
87
               "isDerivedFromAssignedStock
IsDerivedFromAssignedStock

True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.

":
"{Boolean}",
88
               "derivedFrom": {
89
                    "purchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

":
"{Integer}",
90
                    "purchaseQuote": {
91
                         "database
Database

Database of the object

":
"{String}",
92
                         "purchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

":
"{Integer}",
93
                         "purchaseQuoteLink
PurchaseQuoteLink

Purchase quote reference

":
"{String}"
94
                    },
95
                    "purchaseQuoteItemLink
PurchaseQuoteItemLink

Purchase quote item link

":
"{String}"
96
               },
97
               "currency
Currency

Three character code following the ISO 4217 standard

":
"{String}",
98
               "purchasePrice
PurchasePrice

Purchase price in sales currency.

":
"{Decimal}",
99
               "freight
Freight

Freigth cost in sales currency.

":
"{Decimal}",
100
               "duty
Duty

Duty costs in sales currency.

":
"{Decimal}",
101
               "charge
Charge

Other cost in sales currency

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

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

":
"{Decimal}"
103
          },
104
          "accounting
Accounting

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

":
{
105
               "vATCodeDefinition": {
106
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

":
"{String}"
107
               },
108
               "generalLedgerAccount": {
109
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

":
"{Integer}",
110
                    "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

":
"{String}"
111
               },
112
               "department
Department

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

":
{
113
                    "departmentId
DepartmentId

Department identifier

":
"{Integer}",
114
                    "departmentLink
DepartmentLink

Finance department reference

":
"{String}"
115
               },
116
               "financeProject
FinanceProject

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

":
{
117
                    "financeProjectId
FinanceProjectId

Finance project identifier

":
"{Integer}",
118
                    "financeProjectLink
FinanceProjectLink

Finance project reference

":
"{String}"
119
               },
120
               "asset
Asset

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

":
{
121
                    "assetId
AssetId

Asset identifier

":
"{Integer}",
122
                    "assetLink
AssetLink

Asset reference

":
"{String}",
123
                    "dimension": {
124
                         "value
Value

Value for this dimension defintion.

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

Description of the dimension value.

":
"{String}",
126
                         "dimensionDefinition": {
127
                              "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

Name of dimension

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

Dimension reference

":
"{String}"
130
                         }
131
                    }
132
               }
133
          },
134
          "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

":
{
135
               "forwardedFromItem": {
136
                    "itemId
ItemId

Identifier of the object

":
"{Integer}",
137
                    "object": {
138
                         "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

":
"{String}"
141
                    },
142
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

":
"{String}"
144
               },
145
               "salesOrderItemId
SalesOrderItemId

Sales order item identifier

":
"{Integer}",
146
               "salesOrder": {
147
                    "salesOrderId
SalesOrderId

Sales order identifier

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

Date of registration

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

Sales order reference

":
"{String}"
150
               },
151
               "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

":
"{String}",
152
               "notificationId
NotificationId

Notification identifier

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

Status of the notification

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

Date and time of creation

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

The message from the notification definition, expanded with parameters.

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

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

":
"{String}",
157
               "notificationType": {
158
                    "notificationTypeId
NotificationTypeId

Notification type identifier

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

Notification type reference

":
"{String}"
161
               },
162
               "notificationLink
NotificationLink

Notification reference

":
"{String}",
163
               "projectOrderItemId
ProjectOrderItemId

Project order item identifier

":
"{Integer}",
164
               "projectOrderItemLink
ProjectOrderItemLink

Reference to the project order item.

":
"{String}",
165
               "projectOrderId
ProjectOrderId

Project order identifier

":
"{Integer}",
166
               "projectOrderLink
ProjectOrderLink

Project order reference

":
"{String}",
167
               "recurringInvoicePeriodId
RecurringInvoicePeriodId

Recurring invoice period identifier

":
"{Integer}",
168
               "period": {
169
                    "startDate
StartDate

Start date of an invoice period.

":
"{Date}",
170
                    "endDate
EndDate

End date of an invoice period

":
"{Date}"
171
               },
172
               "recurringInvoicePeriodLink
RecurringInvoicePeriodLink

Recurring invoice period reference

":
"{Docref-customlink}"
173
          }
174
     }
175
}

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 101746 HTTP 404 Product structure not found. Id: {0}
Error 102633 HTTP 404 Product structure cost element not found
Error 102746 HTTP 400 The parameter value can not be more than {0}
Error 105250 HTTP 400 Cleanup time on product structure operation must be greater than 0
Error 105679 HTTP 400 Production resource does not allow to add manhours
Error 108137 HTTP 400 Standard ManhourRate is not set for Resource
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}