Sales APIs
Creates a new item in provided sales credit note
| HTTP method | POST |
| URI | https://api.rambase.net/sales/credit-notes/{salesCreditNoteId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesCreditNoteId} |
Sales credit note identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 4823, version 2 |
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.
CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</CustomersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
>{String}</EquivalentProductName>Quantity
Required/mandatory field
Quantity of the sales credit note item
>{Decimal}</Quantity>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>Price
This field is optional.
>GrossPrice
Represents the price per unit before any discounting is applied.
This field is optional.
>{Decimal}</GrossPrice>Discount
The discount for the item.
Minimum value: 0
This field is optional.
>{Decimal}</Discount>CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
": "{String}",EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
": "{String}",Quantity
Required/mandatory field
Quantity of the sales credit note item
": "{Decimal}",ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"Price
This field is optional.
": {GrossPrice
Represents the price per unit before any discounting is applied.
This field is optional.
": "{Decimal}",Discount
The discount for the item.
Minimum value: 0
This field is optional.
": "{Decimal}"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.
SalesCreditNoteItemId
Item-/line-number of the credit note
>{Integer}</SalesCreditNoteItemId>Status
Status code of the the credit note item
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
>{Integer}</LineNumber>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
>{String}</CustomersReferenceNumber>CustomersProductName
Customers internal name of the product. Retrieved from the product.
>{String}</CustomersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
>{String}</EquivalentProductName>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
>{String}</Note>GrossMargin
Gross margin of the item.
>{Decimal}</GrossMargin>VATPercent
Value added tax percent
>{Decimal}</VATPercent>DiscountPercent
The discount in percent for this item.
>{Decimal}</DiscountPercent>Quantity
Quantity of the sales credit note item
>{Decimal}</Quantity>DeliveryDate
The date on which the supply of goods or services was made or completed.
>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
>{String}</VATRegistrationNumber>CustomerLink
Customer reference
>{String}</CustomerLink>Revision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
>{String}</Revision>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Amount
Represents the exchange rate fluctuation amount
>{Decimal}</Amount>Percent
The percent of change that resulted in fluctuation price change
>{Decimal}</Percent>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>Discount
The discount for the item.
>{Decimal}</Discount>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>NetPrice
Final price per unit after deducting all discounts.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossAmount
Represents the item amount before any discounts etc. is applied.
>{Decimal}</GrossAmount>DiscountAmount
The items discount amount.
>{Decimal}</DiscountAmount>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossAmount
Total gross amount in company currency.
>{Decimal}</GrossAmount>NetAmount
Total net amount in company currency.
>{Decimal}</NetAmount>Seller
Reference to the seller of the item
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField1>CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField2>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>ProductLink
Product reference
>{String}</ProductLink>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>PurchasePrice
Purchase price for each unit
>{Decimal}</PurchasePrice>Freight
Estimated freight cost of getting each unit in stock. Used for calculating landed cost.
>{Decimal}</Freight>Duty
Duty cost of getting each unit in stock. Used for calculating landed cost.
>{Decimal}</Duty>Charge
Other costs of getting each unit in stock. Used for calculating landed cost.
>{Decimal}</Charge>GrossPrice
Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.
>{Decimal}</GrossPrice>PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
>{Decimal}</PurchaseExchangeRate>IsDerivedFromUserInput
True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments
>{Boolean}</IsDerivedFromUserInput>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>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>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>PurchaseQuoteItemId
Purchase quote item identifier
>{Integer}</PurchaseQuoteItemId>Database
Database of the object
>{String}</Database>PurchaseQuoteId
Purchase quote identifier
>{Integer}</PurchaseQuoteId>PurchaseQuoteLink
Purchase quote reference
>{String}</PurchaseQuoteLink>PurchaseQuoteItemLink
Purchase quote item link
>{String}</PurchaseQuoteItemLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>PurchasePrice
Purchase price in sales currency.
>{Decimal}</PurchasePrice>Freight
Freigth cost in sales currency.
>{Decimal}</Freight>Duty
Duty costs in sales currency.
>{Decimal}</Duty>Charge
Other cost in sales currency
>{Decimal}</Charge>GrossPrice
Total cost (landed cost or true cost) in sales currency
>{Decimal}</GrossPrice>Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>Department
The department related to the item. One of the system/fixed account dimensions.
>DepartmentId
Department identifier
>{Integer}</DepartmentId>DepartmentLink
Finance department reference
>{String}</DepartmentLink>FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>Asset
The asset related to the item. One of the system/fixed account dimensions.
>AssetId
Asset identifier
>{Integer}</AssetId>AssetLink
Asset reference
>{String}</AssetLink>Value
Value for this dimension defintion.
>{String}</Value>Description
Description of the dimension value.
>{String}</Description>DimensionDefinitionId
Dimension identifier
>{Integer}</DimensionDefinitionId>Name
Name of dimension
>{String}</Name>DimensionDefinitionLink
Dimension reference
>{String}</DimensionDefinitionLink>ForwardedFrom
The preceding/previous/source item.
>ItemId
Identifier of the object
>{Integer}</ItemId>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ItemLink
API reference to the item
>{String}</ItemLink>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>RegistrationDate
Date of registration
>{Date}</RegistrationDate>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>NotificationId
Notification identifier
>{Integer}</NotificationId>Status
Status of the notification
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Message
The message from the notification definition, expanded with parameters.
>{String}</Message>TranslatedMessage
The translated message from the notification definition, expanded with parameters.
>{String}</TranslatedMessage>NotificationTypeId
Notification type identifier
>{String}</NotificationTypeId>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>NotificationTypeLink
Notification type reference
>{String}</NotificationTypeLink>NotificationLink
Notification reference
>{String}</NotificationLink>ProjectOrderItemId
Project order item identifier
>{Integer}</ProjectOrderItemId>ProjectOrderItemLink
Reference to the project order item.
>{String}</ProjectOrderItemLink>ProjectOrderId
Project order identifier
>{Integer}</ProjectOrderId>ProjectOrderLink
Project order reference
>{String}</ProjectOrderLink>SalesCreditNoteItemId
Item-/line-number of the credit note
": "{Integer}",Status
Status code of the the credit note item
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
": "{Integer}",CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
": "{String}",CustomersProductName
Customers internal name of the product. Retrieved from the product.
": "{String}",EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
": "{String}",GrossMargin
Gross margin of the item.
": "{Decimal}",VATPercent
Value added tax percent
": "{Decimal}",DiscountPercent
The discount in percent for this item.
": "{Decimal}",Quantity
Quantity of the sales credit note item
": "{Decimal}",DeliveryDate
The date on which the supply of goods or services was made or completed.
": {CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
": "{String}",CustomerLink
Customer reference
": "{String}"Revision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",Amount
Represents the exchange rate fluctuation amount
": "{Decimal}",Percent
The percent of change that resulted in fluctuation price change
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",Discount
The discount for the item.
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",GrossAmount
Represents the item amount before any discounts etc. is applied.
": "{Decimal}",DiscountAmount
The items discount amount.
": "{Decimal}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",GrossAmount
Total gross amount in company currency.
": "{Decimal}",NetAmount
Total net amount in company currency.
": "{Decimal}"Seller
Reference to the seller of the item
": {EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"ProductLink
Product reference
": "{String}"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}",PurchasePrice
Purchase price for each unit
": "{Decimal}",Freight
Estimated freight cost of getting each unit in stock. Used for calculating landed cost.
": "{Decimal}",Duty
Duty cost of getting each unit in stock. Used for calculating landed cost.
": "{Decimal}",Charge
Other costs of getting each unit in stock. Used for calculating landed cost.
": "{Decimal}",GrossPrice
Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.
": "{Decimal}",PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
": "{Decimal}",IsDerivedFromUserInput
True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments
": "{Boolean}",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}",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}",IsDerivedFromAssignedStock
True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.
": "{Boolean}",PurchaseQuoteItemId
Purchase quote item identifier
": "{Integer}",Database
Database of the object
": "{String}",PurchaseQuoteId
Purchase quote identifier
": "{Integer}",PurchaseQuoteLink
Purchase quote reference
": "{String}"PurchaseQuoteItemLink
Purchase quote item link
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",PurchasePrice
Purchase price in sales currency.
": "{Decimal}",Freight
Freigth cost in sales currency.
": "{Decimal}",Duty
Duty costs in sales currency.
": "{Decimal}",Charge
Other cost in sales currency
": "{Decimal}",GrossPrice
Total cost (landed cost or true cost) in sales currency
": "{Decimal}"Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
": {VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"Department
The department related to the item. One of the system/fixed account dimensions.
": {DepartmentId
Department identifier
": "{Integer}",DepartmentLink
Finance department reference
": "{String}"FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
": {FinanceProjectId
Finance project identifier
": "{Integer}",FinanceProjectLink
Finance project reference
": "{String}"Asset
The asset related to the item. One of the system/fixed account dimensions.
": {AssetId
Asset identifier
": "{Integer}",AssetLink
Asset reference
": "{String}",Value
Value for this dimension defintion.
": "{String}",Description
Description of the dimension value.
": "{String}",DimensionDefinitionId
Dimension identifier
": "{Integer}",Name
Name of dimension
": "{String}",DimensionDefinitionLink
Dimension reference
": "{String}"ForwardedFrom
The preceding/previous/source item.
": {ItemId
Identifier of the object
": "{Integer}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ItemLink
API reference to the item
": "{String}"SalesOrderItemId
Sales order item identifier
": "{Integer}",SalesOrderId
Sales order identifier
": "{Integer}",RegistrationDate
Date of registration
": "{Date}",SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemLink
Reference to the sales order item.
": "{String}",NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Message
The message from the notification definition, expanded with parameters.
": "{String}",TranslatedMessage
The translated message from the notification definition, expanded with parameters.
": "{String}",NotificationTypeId
Notification type identifier
": "{String}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",NotificationTypeLink
Notification type reference
": "{String}"NotificationLink
Notification reference
": "{String}",ProjectOrderItemId
Project order item identifier
": "{Integer}",ProjectOrderItemLink
Reference to the project order item.
": "{String}",ProjectOrderId
Project order identifier
": "{Integer}",ProjectOrderLink
Project order reference
": "{String}"
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 102696 HTTP 404 | Formula definition not found |
| Error 105224 HTTP 400 | Runtime on product structure operation must be greater than 0 |
| Error 105251 HTTP 400 | Setup time on product structure operation must be greater 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} |