API

Sales APIs

PUT sales/invoices/{salesInvoiceId}/items/{itemId}

Stores information about sales invoice item. All amounts should be in the currency of the sales invoice.

HTTP method PUT
URI https://api.rambase.net/sales/invoices/{salesInvoiceId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesInvoiceId} Sales invoice identifier
Integer, minimum 100000
- URI parameter {itemId} Item-/line-number of the invoice
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4727, version 21

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
SalesInvoiceItem

This field is optional.

>
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
     <Quantity
Quantity

Quantity of sales invoice item

This field is optional.

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

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

This field is optional.

>{Date}</DeliveryDate>
8
     <GrossMargin
GrossMargin

Gross margin of the item. An eventual approval of GM is triggered if this percentage is lower than the highest value of minimum gross margin set up in Customer, Product and GM in COM

Minimum value: -100

Maximum value: 100

This field is optional.

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

The discount in percent for this item.

Minimum value: 0

Maximum value: 100

This field is optional.

>{Decimal}</DiscountPercent>
10
     <EndCustomer
EndCustomer

End customer

This field is optional.

>
11
          <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>{Integer}</CustomerId>
12
     </EndCustomer>
13
     <Price
Price

This field is optional.

>
14
          <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

This field is optional.

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

Discount for each unit in the item, in document currency. Will be calculated based on Discount percentage, or can be set manually.

Minimum value: 0

This field is optional.

>{Decimal}</Discount>
16
     </Price>
17
     <Product
Product

This field is optional.

>
18
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
19
     </Product>
20
     <Accounting
Accounting

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

This field is optional.

>
21
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
22
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
23
          </VATCodeDefinition>
24
     </Accounting>
25
     <Seller
Seller

Reference to the seller of the item

This field is optional.

>
26
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
27
     </Seller>
28
     <LandedCost
LandedCost

This field is optional.

>
29
          <PurchasePrice
PurchasePrice

Purchase price for each unit

Minimum value: 0

This field is optional.

>{Decimal}</PurchasePrice>
30
     </LandedCost>
31
</SalesInvoiceItem>
1
{
2
     "salesInvoiceItem
SalesInvoiceItem

This field is optional.

": {
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
          "quantity
Quantity

Quantity of sales invoice item

This field is optional.

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

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

This field is optional.

": "{Date}",
9
          "grossMargin
GrossMargin

Gross margin of the item. An eventual approval of GM is triggered if this percentage is lower than the highest value of minimum gross margin set up in Customer, Product and GM in COM

Minimum value: -100

Maximum value: 100

This field is optional.

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

The discount in percent for this item.

Minimum value: 0

Maximum value: 100

This field is optional.

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

End customer

This field is optional.

": {
12
               "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
13
          },
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}",
16
               "discount
Discount

Discount for each unit in the item, in document currency. Will be calculated based on Discount percentage, or can be set manually.

Minimum value: 0

This field is optional.

": "{Decimal}"
17
          },
18
          "product
Product

This field is optional.

": {
19
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
20
          },
21
          "accounting
Accounting

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

This field is optional.

": {
22
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
23
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
24
               }
25
          },
26
          "seller
Seller

Reference to the seller of the item

This field is optional.

": {
27
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
28
          },
29
          "landedCost
LandedCost

This field is optional.

": {
30
               "purchasePrice
PurchasePrice

Purchase price for each unit

Minimum value: 0

This field is optional.

": "{Decimal}"
31
          }
32
     }
33
}

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.
$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. 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
1

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 103439 HTTP 400 You cannot use this stock location on this location
Error 104371 HTTP 400 Purchase group must be in active status (4)
Error 109233 HTTP 400 Warehouse operators group is deactivated
Error 106383 HTTP 400 Minimum production order quantity must be a positive number if set
Error 103546 HTTP 400 Only product structures can be blocked for production
Error 107762 HTTP 400 Only product structures can auto create work orders for sub production
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 109643 HTTP 400 Safetystock cannot be greater than maximumstock
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 109539 HTTP 400 Dimension value {0} could not be used : Check its FromPeriod and ToPeriod.
Error 102486 HTTP 400 Invalid value for dimension {0}