Sales APIs
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.
CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
This field is optional.
>{String}</CustomersReferenceNumber>CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</CustomersProductName>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
>{String}</ProductDescription>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
This field is optional.
>{String}</Note>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 sales invoice item
>{Decimal}</Quantity>EndCustomer
End customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>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
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>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
This field is optional.
": "{String}",CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
": "{String}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
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 sales invoice item
": "{Decimal}",EndCustomer
End customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"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
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}"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. |
| $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.
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 101699 HTTP 400 | Picking in process on item {0}. Picking of goods must be cancelled before the operation can start |
| Error 106562 HTTP 400 | This product is blocked for sale |
| Error 106563 HTTP 400 | This product is blocked for shipping |
| Error 100199 HTTP 404 | Location is not found |
| Error 101490 HTTP 400 | Illegal Account {0}: This account has been blocked for {1}-documents |
| Error 101491 HTTP 400 | Illegal Account {0}: Check the account's FromPeriod and ToPeriod |
| 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 109539 HTTP 400 | Dimension value {0} could not be used : Check its FromPeriod and ToPeriod. |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |