Procurement APIs
Key figures for procurement return items.
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/return-items/key-figures?groupBy={groupBy} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 3738, 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.
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.
| groupBy String, required |
Status, Supplier, Product, RegistrationDate, RegistrationMonth or RegistrationYear
Default: Status |
| $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.
| Assignee Integer | The user who has been assigned to work with this object. Available macros: currentUser() |
| ContainingNotificationMessage String | Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language. |
| ContainingNotificationTypeId Integer | Notification type identifier. |
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Currency String | Three character code following the ISO 4217 standard. |
| DepartmentId Integer | Department identifier. |
| FinanceProjectId Integer | Finance project identifier. |
| Location String | Unique abbreviation/short name of the location. |
| ManufacturerId Integer | Manufacturer identifier. |
| ManufacturerShortName String | Shortname/code of the manufacturer. |
| NetAmount Decimal | Final item amount after deducting all discounts etc. |
| NetPrice Decimal | Final price per unit after deducting all discounts etc. |
| Note String | Additional information regarding the item (free text). Might be visible to customers/suppliers. |
| ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
| ProductId Integer | Product identifier. |
| ProductName String | Name of the product. |
| ProductType String | Type of product. |
| Quantity Decimal | Quantity of the supplier return item. |
| RemainingQuantity Decimal | Remaining number of units to be forwarded. |
| Status Integer | Status of the supplier return item. |
| SupplierId Integer | RamBase supplier identifier. |
| SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person). |
| SupplierReturnId Integer | Supplier return identifier. |
| SupplierReturnItemId Integer | Supplier return item identifier. |
| SuppliersProductName String | Suppliers internal name of the product. Retrieved from the product. |
| SuppliersReferenceNumber String | Suppliers/sellers item reference number. Typically to an external system. |
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.
Key
GroupBy can be "RUT" (RentalUnit), "RUTYEARMONTH" ( RentalUnit, Year, Month) or "YEARMONTH" (Year or month)
>{String}</Key>Description
Description of the key.
>{String}</Description>Occurrences
Number of occurrences with the specified key.
>{Integer}</Occurrences>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>Key
GroupBy can be "RUT" (RentalUnit), "RUTYEARMONTH" ( RentalUnit, Year, Month) or "YEARMONTH" (Year or month)
": "{String}",Description
Description of the key.
": "{String}",Occurrences
Number of occurrences with the specified key.
": "{Integer}"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 103241 HTTP 400 | Invalid group by |