Procurement APIs
Get list of purchase order candidates for linking to supplier invoice
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/invoices/{supplierInvoiceId}/items/{itemId}/applicable-backlog-items |
| 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 | 5274, version 15 |
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.
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.
| $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] |
| $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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
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.
PendingInvoiceQuantity
Remaining quantity that has not been invoiced. Will decrease when the purchase order get invoiced. Note that purchase order can get invoiced for none or part of the items.
>{Decimal}</PendingInvoiceQuantity>ApplicableInvoiceQuantity
Purchase order item quantity linked to invoice
>{Decimal}</ApplicableInvoiceQuantity>ApplicableGoodsReceptionItems
Number of goods reception items that are possible candiates for linking to this purchase order candidate.
>{Integer}</ApplicableGoodsReceptionItems>HasValidQuantity
Condition to point out if order item can be linked to invoice item
>{Boolean}</HasValidQuantity>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Price from last transaction coming from order.
>{Decimal}</NetPrice>ItemId
Item-number of the object
>{Integer}</ItemId>Status
Status of the item/object.
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>ConfirmedDate
Confirmed delivery date
>{Date}</ConfirmedDate>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Quantity
Number of units purchased
>{Decimal}</Quantity>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
>{Date}</RequestedDeliveryDate>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>RegistrationDate
Date of registration
>{Date}</RegistrationDate>SuppliersReference
Suppliers/sellers reference. Typically a person.
>{String}</SuppliersReference>SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>Type
Type of purchase order
>{String}</Type>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>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>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>PendingInvoiceQuantity
Remaining quantity that has not been invoiced. Will decrease when the purchase order get invoiced. Note that purchase order can get invoiced for none or part of the items.
": "{Decimal}",ApplicableInvoiceQuantity
Purchase order item quantity linked to invoice
": "{Decimal}",ApplicableGoodsReceptionItems
Number of goods reception items that are possible candiates for linking to this purchase order candidate.
": "{Integer}",HasValidQuantity
Condition to point out if order item can be linked to invoice item
": "{Boolean}",Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Price from last transaction coming from order.
": "{Decimal}"ItemId
Item-number of the object
": "{Integer}",Status
Status of the item/object.
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",ConfirmedDate
Confirmed delivery date
": "{Date}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Quantity
Number of units purchased
": "{Decimal}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
": "{String}",RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
": "{Date}",Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",RegistrationDate
Date of registration
": "{Date}",SuppliersReference
Suppliers/sellers reference. Typically a person.
": "{String}",SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
": "{String}",Type
Type of purchase order
": "{String}",LocationId
Location identifier
": "{Integer}",Name
Name of location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"ObjectLink
API reference to the object
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ItemLink
API reference to the item
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 100027 HTTP 400 | Missing mandatory parameter {0} |
| Error 101420 HTTP 404 | Setting definition not found |