Procurement APIs
Send in no parameters to remove link to backlog item.
Send in backlog item to link.
Can send in goods reception item to link to that in addition to the backlog item(Need to also specify backlog item in this case). This is an API operation. Read the documentation pages for more information about API operations.
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/invoices/{supplierInvoiceId}/items/{itemId}/api-operations/101446/instances |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {supplierInvoiceId} |
Supplier invoice identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Item-/linenumber of supplier invoice
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 5335, version 3 |
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.
Parameters
This field is optional.
>ProcurementBacklogItem
Purchase order item this invoice item is created for
This field is optional.
>ItemId
Item-number of the object
Minimum value: 1
This field is optional.
>{Integer}</ItemId>Object
This field is optional.
>ObjectId
Identifier of the object
Minimum value: 100000
This field is optional.
>{Integer}</ObjectId>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>GoodsReceptionItem
The preceding/previous/source item.
This field is optional.
>GoodsReceptionItemId
Item-/line-number of the goods reception
Minimum value: 1
This field is optional.
>{Integer}</GoodsReceptionItemId>GoodsReception
This field is optional.
>GoodsReceptionId
Goods reception identifier
Minimum value: 10000
This field is optional.
>{Integer}</GoodsReceptionId>Parameters
This field is optional.
": {ProcurementBacklogItem
Purchase order item this invoice item is created for
This field is optional.
": {ItemId
Item-number of the object
Minimum value: 1
This field is optional.
": "{Integer}",Object
This field is optional.
": {ObjectId
Identifier of the object
Minimum value: 100000
This field is optional.
": "{Integer}",ObjectType
Type of object
This field is optional.
": "{String}"GoodsReceptionItem
The preceding/previous/source item.
This field is optional.
": {GoodsReceptionItemId
Item-/line-number of the goods reception
Minimum value: 1
This field is optional.
": "{Integer}",GoodsReception
This field is optional.
": {GoodsReceptionId
Goods reception identifier
Minimum value: 10000
This field is optional.
": "{Integer}"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] |
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.
OperationInstanceId
Operation instance identifier
>{Integer}</OperationInstanceId>Status
Status of the instance, 2 = started, 7 = error, 9 = finished
>{Integer}</Status>CreatedAt
Date and time the operation instance was created
>{Datetime}</CreatedAt>CreatedBy
Reference to the creator
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>ObjectId
Identifier of the object
>{String}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ApiOprationId
Api operation identifiers
>{Integer}</ApiOprationId>ApiOperationLink
Api operation reference
>{String}</ApiOperationLink>ObjectId
Identifier of the object
>{String}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
>{String}</Message>TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
>{String}</TranslatedMessage>StackTrace
Stack trace for details about the error
>{String}</StackTrace>ErrorMessage
Contains a reference to the error message, if an error occured
>ErrorMessageId
Error message identifier
>{Integer}</ErrorMessageId>ErrorMessageLink
Error message reference
>{String}</ErrorMessageLink>Index
Error Key
>{Integer}</Index>Value
Value of the error parameter
>{String}</Value>Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
>{String}</Message>TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
>{String}</TranslatedMessage>StackTrace
Stack trace for details about the error
>{String}</StackTrace>ErrorMessage
Contains a reference to the error message, if an error occured
>ErrorMessageId
Error message identifier
>{Integer}</ErrorMessageId>ErrorMessageLink
Error message reference
>{String}</ErrorMessageLink>Index
Error Key
>{Integer}</Index>Value
Value of the error parameter
>{String}</Value>Key
Key of the result value
>{String}</Key>Value
Value of the result value
>{String}</Value>SystemJob
Contains a reference to the system job, if a system job was started
>ObjectId
{OIN.ObjectId}
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>PercentComplete
Percent complete
>{Integer}</PercentComplete>ObjectLink
API reference to the object
>{String}</ObjectLink>OperationInstanceLink
Operation instance reference
>{String}</OperationInstanceLink>OperationInstanceId
Operation instance identifier
": "{Integer}",Status
Status of the instance, 2 = started, 7 = error, 9 = finished
": "{Integer}",CreatedAt
Date and time the operation instance was created
": "{Datetime}",CreatedBy
Reference to the creator
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"ObjectId
Identifier of the object
": "{String}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"ApiOprationId
Api operation identifiers
": "{Integer}",ApiOperationLink
Api operation reference
": "{String}"ObjectId
Identifier of the object
": "{String}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
": "{String}",TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
": "{String}",StackTrace
Stack trace for details about the error
": "{String}",ErrorMessage
Contains a reference to the error message, if an error occured
": {ErrorMessageId
Error message identifier
": "{Integer}",ErrorMessageLink
Error message reference
": "{String}"Index
Error Key
": "{Integer}",Value
Value of the error parameter
": "{String}"Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
": "{String}",TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
": "{String}",StackTrace
Stack trace for details about the error
": "{String}",ErrorMessage
Contains a reference to the error message, if an error occured
": {ErrorMessageId
Error message identifier
": "{Integer}",ErrorMessageLink
Error message reference
": "{String}"Index
Error Key
": "{Integer}",Value
Value of the error parameter
": "{String}"Key
Key of the result value
": "{String}",Value
Value of the result value
": "{String}"SystemJob
Contains a reference to the system job, if a system job was started
": {ObjectId
{OIN.ObjectId}
": "{Integer}",ObjectType
Type of object
": "{String}",PercentComplete
Percent complete
": "{Integer}",ObjectLink
API reference to the object
": "{String}"OperationInstanceLink
Operation instance 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 100009 HTTP 400 | Missing required input arguments |
| Error 105969 HTTP 400 | Start date is required |
| Error 105970 HTTP 400 | End date is required |
| Error 102189 HTTP 400 | Missing mandatory parameter for goods reception item id |
| Error 103243 HTTP 400 | Reserved quantity can not be negative. |
| Error 103682 HTTP 400 | The purchase order response item needs to be registered (status higher than 1) before quantity can be reserved. |
| Error 103849 HTTP 400 | Reserved quantity can not exceed remaining quantity. |
| Error 103244 HTTP 400 | Reserved quantity can not exceed available quantity. |
| Error 106477 HTTP 400 | Project order identifier is not defined |
| Error 106478 HTTP 400 | Project order item identifier is not defined |
| Error 108107 HTTP 400 | Linking is allowed only for registered (status 4) and paused (status 5) project order items |
| Error 108104 HTTP 400 | Linking is allowed only for project order items with category 'Expenses' |
| Error 108106 HTTP 400 | Linking is not allowed for project order item which is based on expense log |
| Error 108351 HTTP 400 | Type of rental contract item not found |
| Error 108856 HTTP 400 | Rate change type not found |
| Error 108352 HTTP 400 | Stage of rental contract item not found |
| Error 108474 HTTP 400 | Quote reference is required for quote item |
| Error 101040 HTTP 400 | Quantity must be filled in to create a new item |
| Error 108670 HTTP 400 | Discount percentage must be a number between 0 and 100 |
| Error 105743 HTTP 400 | Start date is required |
| Error 104971 HTTP 400 | The start date cannot be later than the end date |
| Error 103491 HTTP 400 | Invalid expiration date |
| Error 108679 HTTP 400 | Expected check-in date cannot be earlier then expected check-out date |
| Error 108262 HTTP 404 | Recurring rate not found |
| Error 108691 HTTP 400 | Recurring rate is not active |
| Error 108018 HTTP 400 | Currency mismatch |
| Error 108016 HTTP 400 | Product id mismatch |
| Error 108824 HTTP 400 | Cannot apply recurring rate as it is not valid for selected period |
| Error 108671 HTTP 400 | The effective date cannot be changed because earlier days have already been invoiced |
| Error 108684 HTTP 400 | The expiration date cannot be changed because later days have already been invoiced |
| Error 108683 HTTP 400 | Termination date must be earlier then the expiration date |
| Error 109306 HTTP 400 | Shipping details can only be updated until an item is shipped |
| Error 109315 HTTP 400 | Rental unit is not available within given period |