Logistics APIs
Key figures for shipping advices.
| HTTP method | GET |
| URI | https://api.rambase.net/logistics/shipping-advices/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 | 3411, version 7 |
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, optional |
ShippingDate, ShippingMonth, ShippingYear, Status or Customer
Default: Customer |
| $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.
| AccountManager Integer | Employee identifier. Available macros: currentUser() |
| Assignee Integer | User identifier. Available macros: currentUser() |
| AssigneeName String | Firstname and name of the user. |
| 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. |
| CustomerId Integer | Customer identifier. |
| CustomersReference String | Customers reference. Typically a person. |
| CustomersReferenceNumber String | Customers reference number. E.g. the internal sales order id the customer use in their own system. |
| DeliveryTerms String | Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer. |
| FeeAmount Decimal | Fee amount in transaction document's currency. |
| Firstname String | Secondary name of a company or firstname of a person. |
| FreightAmount Decimal | Freight amount in transaction document's currency. |
| GrossMargin Decimal | Gross margin of sale, calculated as an average of gross margin of all items at the time items are created and when the document is registered. Will not be recalculated if gross margin in items change afterwards. |
|
InvoiceAddress. City String |
City/town/village. |
|
InvoiceAddress. CountryCode String |
Two-character code (ISO 3166) identifying the country. |
|
InvoiceAddress. PostalCode String |
Postalcode/Postcode/ZIP. |
| Location String | Unique abbreviation/short name of the location. |
| Name String | Name of customer (name of company or surname/familyname/lastname of a person). |
| NetWeight Decimal | The net weight of object (excluding packing meterial) in kilograms. |
| Note String | Additional information regarding the object (free text). This note might be visible to customers/suppliers. |
| PaymentTerms String | Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field. |
| Priority Integer | Priority of the shipment. |
| SalesAssistant Integer | Employee identifier. Available macros: currentUser() |
| SellersReferenceNumber String | Sellers reference number.. |
|
ShippingAddress. CountryCode String |
Country code of shipment destination. |
| ShippingAdviceId Integer | Shipping advice identifier. |
| ShippingDate Date | The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value). Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Status Integer | Status of shipping advice. |
| SubTotalAmount Decimal | Total amount of the object in object currency, excluding VAT. |
| TotalAmount Decimal | The total amount in object currency, including VAT. |
| Type String | Type of shipping advice. Gives an indication of what this shipping advice is based on or forwarded from. |
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.
Currency
Three character code following the ISO 4217 standard
>{String}</Currency>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>TotalAmount
Final item amount after deducting all discounts etc.
>{Decimal}</TotalAmount>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>Currency
Three character code following the ISO 4217 standard
": "{String}",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}",TotalAmount
Final item amount after deducting all discounts etc.
": "{Decimal}"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 |