API

Rental APIs

GET system/reports/111641/result-set?includeProcessed={includeProcessed}

Rental shipping advices

Report name Rental shipping advices with Customers reference number
Report identifier 111641
HTTP method GET
URI https://api.rambase.net/system/reports/111641/result-set?includeProcessed={includeProcessed}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5730, version 10

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.

Format:
1
1

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.

includeProcessed Boolean, optional Include rental shipping advices that has been returned, or sold.

Default: False
$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.

CustomerFirstName String Secondary name of a company or firstname of a person.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
FinanceProjectId Integer Finance project identifier.
FinanceProjectName String Name of finance project.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductUnitId String Product unit reference.
SerialNumber String Serial number.
ShippingAdviceId Integer Shipping advice identifier.
ShippingAdviceItemId Integer Shipping advice item reference.
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 the shipping advice item (0-9).

Read more about filters and sorting on how to use sortable parameters

CustomerFirstName String Secondary name of a company or firstname of a person
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
FinanceProjectId Integer Finance project identifier
FinanceProjectName String Name of finance project
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
ProductUnitId String Product unit reference
SerialNumber String Serial number
ShippingAdviceId Integer Shipping advice identifier
ShippingAdviceItemId Integer Shipping advice item reference
ShippingDate Date The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value)
Status Integer Status of the shipping advice item (0-9)

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.

Format:
1
<Report>
2
     <Rows>
3
          <Row>
4
               <Customer
Customer

Customer reference

>
5
                    <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
6
                    <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
7
                    <FirstName
FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>
8
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
9
               </Customer>
10
               <RecurringInvoicePlan
RecurringInvoicePlan

Recurring invoice plan

>
11
                    <RecurringInvoicePlanId
RecurringInvoicePlanId

Rental plan identifier

>{Integer}</RecurringInvoicePlanId>
12
                    <RecurringInvoicePlanLink
RecurringInvoicePlanLink

Recurring invoice plan refrence

>{String}</RecurringInvoicePlanLink>
13
               </RecurringInvoicePlan>
14
               <Status
Status

Status of the shipping advice item (0-9)

Possible domain values can be found here

>{Integer}</Status>
15
               <ShippingAdviceItem
ShippingAdviceItem

Shipping advice item reference

>
16
                    <ShippingAdviceItemId
ShippingAdviceItemId

Shipping advice item reference

>{Integer}</ShippingAdviceItemId>
17
                    <ShippingAdvice
ShippingAdvice

Shipping advice reference

>
18
                         <ShippingAdviceId
ShippingAdviceId

Shipping advice identifier

>{Integer}</ShippingAdviceId>
19
                         <ShippingDate
ShippingDate

The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value)

>{Date}</ShippingDate>
20
                         <ShippingAdviceLink
ShippingAdviceLink

Shipping advice item reference

>{String}</ShippingAdviceLink>
21
                    </ShippingAdvice>
22
                    <ShippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

>{String}</ShippingAdviceItemLink>
23
               </ShippingAdviceItem>
24
               <Product
Product

Product reference

>
25
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
26
                    <Name
Name

Name of the product

>{String}</Name>
27
                    <Description
Description

Description of the product

>{String}</Description>
28
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
29
               </Product>
30
               <SerialNumber
SerialNumber

Serial number

>{String}</SerialNumber>
31
               <ProductUnit
ProductUnit

Product unit reference

>
32
                    <ProductUnitId
ProductUnitId

Product unit identifier

>{Integer}</ProductUnitId>
33
                    <ProductUnitLink
ProductUnitLink

Product unit reference

>{String}</ProductUnitLink>
34
               </ProductUnit>
35
               <Project
Project

Finance project reference. One of the system/fixed account dimensions.

>
36
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
37
                    <Name
Name

Name of finance project

>{String}</Name>
38
                    <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
39
               </Project>
40
               <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

>{String}</CustomersReferenceNumber>
41
               <Inspect>
42
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
43
               </Inspect>
44
          </Row>
45
     </Rows>
46
     <Paging
Paging

Detailed paging information for this list.

>
47
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
48
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
49
          <Page
Page

Page index

>{Integer}</Page>
50
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
51
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
52
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
53
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
54
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
55
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
56
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
57
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
58
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
59
     </Paging>
60
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "customer
Customer

Customer reference

": {
6
                         "customerId
CustomerId

Customer identifier

": "{Integer}",
7
                         "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
8
                         "firstName
FirstName

Secondary name of a company or firstname of a person

": "{String}",
9
                         "customerLink
CustomerLink

Customer reference

": "{String}"
10
                    },
11
                    "recurringInvoicePlan
RecurringInvoicePlan

Recurring invoice plan

": {
12
                         "recurringInvoicePlanId
RecurringInvoicePlanId

Rental plan identifier

": "{Integer}",
13
                         "recurringInvoicePlanLink
RecurringInvoicePlanLink

Recurring invoice plan refrence

": "{String}"
14
                    },
15
                    "status
Status

Status of the shipping advice item (0-9)

Possible domain values can be found here

": "{Integer}",
16
                    "shippingAdviceItem
ShippingAdviceItem

Shipping advice item reference

": {
17
                         "shippingAdviceItemId
ShippingAdviceItemId

Shipping advice item reference

": "{Integer}",
18
                         "shippingAdvice
ShippingAdvice

Shipping advice reference

": {
19
                              "shippingAdviceId
ShippingAdviceId

Shipping advice identifier

": "{Integer}",
20
                              "shippingDate
ShippingDate

The registration date of the shipping advice/supplier return/ goods transfer, -which is the day stock was reduced (quantity and value)

": "{Date}",
21
                              "shippingAdviceLink
ShippingAdviceLink

Shipping advice item reference

": "{String}"
22
                         },
23
                         "shippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

": "{String}"
24
                    },
25
                    "product
Product

Product reference

": {
26
                         "productId
ProductId

Product identifier

": "{Integer}",
27
                         "name
Name

Name of the product

": "{String}",
28
                         "description
Description

Description of the product

": "{String}",
29
                         "productLink
ProductLink

Product reference

": "{String}"
30
                    },
31
                    "serialNumber
SerialNumber

Serial number

": "{String}",
32
                    "productUnit
ProductUnit

Product unit reference

": {
33
                         "productUnitId
ProductUnitId

Product unit identifier

": "{Integer}",
34
                         "productUnitLink
ProductUnitLink

Product unit reference

": "{String}"
35
                    },
36
                    "project
Project

Finance project reference. One of the system/fixed account dimensions.

": {
37
                         "financeProjectId
FinanceProjectId

Finance project identifier

": "{Integer}",
38
                         "name
Name

Name of finance project

": "{String}",
39
                         "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
40
                    },
41
                    "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

": "{String}",
42
                    "inspect": {
43
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
44
                    }
45
               }
46
          ]
47
     }
48
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type