API

Rental APIs

GET rental/contracts/{rentalContractId}/items/{itemId}/calendar-days

Get list of calendar days for selected rental contract item

HTTP method GET
URI https://api.rambase.net/rental/contracts/{rentalContractId}/items/{itemId}/calendar-days
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalContractId} Rental contract identifier
Integer, minimum 100000
- URI parameter {itemId} Rental contract item identifier
Integer, minimum 1
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6018, version 20

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.

$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.

Date Date Rental calendar date of day. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DiscountPercent Decimal Discount percent for calendar day.
Quantity Decimal Rental calendar day quantity.
RecurringRateId Integer Recurring rate identifier.
RentalCalendarDayId Integer Rental calendar day id.
RentalCalendarId Integer Rental calendar id.
Status String Status of the rental calendar day.

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

Date Date Rental calendar date of day
DiscountPercent Decimal Discount percent for calendar day
Quantity Decimal Rental calendar day quantity
RecurringRateId Integer Recurring rate identifier
RentalCalendarDayId Integer Rental calendar day id
RentalCalendarId Integer Rental calendar id
Status String Status of the rental calendar day

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
<RentalCalendarDays>
2
     <RentalCalendarDay>
3
          <RentalCalendarDayId
RentalCalendarDayId

Rental calendar day id

>{Integer}</RentalCalendarDayId>
4
          <RentalCalendar>
5
               <RentalCalendarId
RentalCalendarId

Rental calendar id

>{Integer}</RentalCalendarId>
6
               <RentalCalendarLink
RentalCalendarLink

Rental calendar reference

>{String}</RentalCalendarLink>
7
          </RentalCalendar>
8
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
9
          <Status
Status

Status of the rental calendar day

Possible domain values can be found here

>{Integer}</Status>
10
          <Date
Date

Rental calendar date of day

>{Date}</Date>
11
          <Quantity
Quantity

Rental calendar day quantity

>{Integer}</Quantity>
12
          <DiscountPercent
DiscountPercent

Discount percent for calendar day

>{Decimal}</DiscountPercent>
13
          <IsOnRent
IsOnRent

Is on-rent or is off-rent

>{Boolean}</IsOnRent>
14
          <ChangeReason
ChangeReason

States the reason why the daily data were changed

>{String}</ChangeReason>
15
          <RecurringRate
RecurringRate

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

>
16
               <RecurringRateId
RecurringRateId

Recurring rate identifier

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

>{Integer}</RecurringRateId>
17
               <Status
Status

Status of recurring rate

Possible domain values can be found here

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

>{Integer}</Status>
18
               <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
19
               <RateInterval
RateInterval

Interval of recurring rate

Possible domain values can be found here

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

>{Integer}</RateInterval>
20
               <Type
Type

Type of recurring rate: 1 - Standard, 2 - Special

Possible domain values can be found here

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

>{Integer}</Type>
21
               <RecurringRateLink
RecurringRateLink

Recurring rate reference

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

>{String}</RecurringRateLink>
22
          </RecurringRate>
23
          <CurrentRateStep
CurrentRateStep

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

>
24
               <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
25
               <Rate
Rate

Value of step rate

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

>{Decimal}</Rate>
26
          </CurrentRateStep>
27
          <BillingItem>
28
               <ObjectType
ObjectType

Reference to object type that was generated basing on calendar days data

>{String}</ObjectType>
29
               <ObjectId
ObjectId

Reference to object id that was generated basing on calendar days data

>{Integer}</ObjectId>
30
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
31
               <ItemId
ItemId

Reference to object line id that was generated basing on calendar days data

>{Integer}</ItemId>
32
               <ItemLink
ItemLink

Document item reference

>{String}</ItemLink>
33
          </BillingItem>
34
          <Totals>
35
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
36
               <Amount
Amount

Amount per day

>{Decimal}</Amount>
37
               <DiscountAmount
DiscountAmount

Discount amount per day

>{Decimal}</DiscountAmount>
38
               <NetAmount
NetAmount

Amount after discount per day

>{Decimal}</NetAmount>
39
               <EstimatedRevenue
EstimatedRevenue

Estimated revenue per day

>{Decimal}</EstimatedRevenue>
40
               <ForecastedRevenue
ForecastedRevenue

Forecasted revenue per day

>{Decimal}</ForecastedRevenue>
41
               <EarnedRevenue
EarnedRevenue

Earned revenue per day

>{Decimal}</EarnedRevenue>
42
               <AccruedRevenue
AccruedRevenue

Accrued revenue per day

>{Decimal}</AccruedRevenue>
43
               <DeferredRevenue
DeferredRevenue

Deferred revenue per day

>{Decimal}</DeferredRevenue>
44
               <InvoicedAmount
InvoicedAmount

Invoiced amount per day

>{Decimal}</InvoicedAmount>
45
          </Totals>
46
          <TotalsConverted
TotalsConverted

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

>
47
               <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
48
               <Amount
Amount

Amount per day in local currency

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

>{Decimal}</Amount>
49
               <DiscountAmount
DiscountAmount

Discount amount per day in local currency

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

>{Decimal}</DiscountAmount>
50
               <NetAmount
NetAmount

Net amount per day in local currency

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

>{Decimal}</NetAmount>
51
               <EstimatedRevenue
EstimatedRevenue

Estimated revenue per day in local currency

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

>{Decimal}</EstimatedRevenue>
52
               <ForecastedRevenue
ForecastedRevenue

Forecasted revenue per day in local currency

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

>{Decimal}</ForecastedRevenue>
53
               <EarnedRevenue
EarnedRevenue

Earned revenue per day in local currency

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

>{Decimal}</EarnedRevenue>
54
               <AccruedRevenue
AccruedRevenue

Accrued revenue per day in local currency

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

>{Decimal}</AccruedRevenue>
55
               <DeferredRevenue
DeferredRevenue

Deferred revenue per day in local currency

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

>{Decimal}</DeferredRevenue>
56
               <InvoicedAmount
InvoicedAmount

Invoiced amount per day in local currency

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

>{Decimal}</InvoicedAmount>
57
          </TotalsConverted>
58
          <RentalCalendarDayLink
RentalCalendarDayLink

Rental calendar day reference

>{String}</RentalCalendarDayLink>
59
     </RentalCalendarDay>
60
     <Paging
Paging

Detailed paging information for this list.

>
61
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
64
          <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>
65
          <FirstPage
FirstPage

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

>{String}</FirstPage>
66
          <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>
67
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
68
          <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>
69
          <NextPage
NextPage

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

>{String}</NextPage>
70
          <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>
71
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
73
     </Paging>
74
</RentalCalendarDays>
1
{
2
     "rentalCalendarDays": [
3
          {
4
               "rentalCalendarDayId
RentalCalendarDayId

Rental calendar day id

": "{Integer}",
5
               "rentalCalendar": {
6
                    "rentalCalendarId
RentalCalendarId

Rental calendar id

": "{Integer}",
7
                    "rentalCalendarLink
RentalCalendarLink

Rental calendar reference

": "{String}"
8
               },
9
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
10
               "status
Status

Status of the rental calendar day

Possible domain values can be found here

": "{Integer}",
11
               "date
Date

Rental calendar date of day

": "{Date}",
12
               "quantity
Quantity

Rental calendar day quantity

": "{Integer}",
13
               "discountPercent
DiscountPercent

Discount percent for calendar day

": "{Decimal}",
14
               "isOnRent
IsOnRent

Is on-rent or is off-rent

": "{Boolean}",
15
               "changeReason
ChangeReason

States the reason why the daily data were changed

": "{String}",
16
               "recurringRate
RecurringRate

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

": {
17
                    "recurringRateId
RecurringRateId

Recurring rate identifier

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

": "{Integer}",
18
                    "status
Status

Status of recurring rate

Possible domain values can be found here

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

": "{Integer}",
19
                    "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
20
                    "rateInterval
RateInterval

Interval of recurring rate

Possible domain values can be found here

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

": "{Integer}",
21
                    "type
Type

Type of recurring rate: 1 - Standard, 2 - Special

Possible domain values can be found here

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

": "{Integer}",
22
                    "recurringRateLink
RecurringRateLink

Recurring rate reference

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

": "{String}"
23
               },
24
               "currentRateStep
CurrentRateStep

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

": {
25
                    "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
26
                    "rate
Rate

Value of step rate

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

": "{Decimal}"
27
               },
28
               "billingItem": {
29
                    "objectType
ObjectType

Reference to object type that was generated basing on calendar days data

": "{String}",
30
                    "objectId
ObjectId

Reference to object id that was generated basing on calendar days data

": "{Integer}",
31
                    "objectLink
ObjectLink

API reference to the object

": "{String}",
32
                    "itemId
ItemId

Reference to object line id that was generated basing on calendar days data

": "{Integer}",
33
                    "itemLink
ItemLink

Document item reference

": "{String}"
34
               },
35
               "totals": {
36
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
37
                    "amount
Amount

Amount per day

": "{Decimal}",
38
                    "discountAmount
DiscountAmount

Discount amount per day

": "{Decimal}",
39
                    "netAmount
NetAmount

Amount after discount per day

": "{Decimal}",
40
                    "estimatedRevenue
EstimatedRevenue

Estimated revenue per day

": "{Decimal}",
41
                    "forecastedRevenue
ForecastedRevenue

Forecasted revenue per day

": "{Decimal}",
42
                    "earnedRevenue
EarnedRevenue

Earned revenue per day

": "{Decimal}",
43
                    "accruedRevenue
AccruedRevenue

Accrued revenue per day

": "{Decimal}",
44
                    "deferredRevenue
DeferredRevenue

Deferred revenue per day

": "{Decimal}",
45
                    "invoicedAmount
InvoicedAmount

Invoiced amount per day

": "{Decimal}"
46
               },
47
               "totalsConverted
TotalsConverted

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

": {
48
                    "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
49
                    "amount
Amount

Amount per day in local currency

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

": "{Decimal}",
50
                    "discountAmount
DiscountAmount

Discount amount per day in local currency

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

": "{Decimal}",
51
                    "netAmount
NetAmount

Net amount per day in local currency

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

": "{Decimal}",
52
                    "estimatedRevenue
EstimatedRevenue

Estimated revenue per day in local currency

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

": "{Decimal}",
53
                    "forecastedRevenue
ForecastedRevenue

Forecasted revenue per day in local currency

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

": "{Decimal}",
54
                    "earnedRevenue
EarnedRevenue

Earned revenue per day in local currency

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

": "{Decimal}",
55
                    "accruedRevenue
AccruedRevenue

Accrued revenue per day in local currency

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

": "{Decimal}",
56
                    "deferredRevenue
DeferredRevenue

Deferred revenue per day in local currency

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

": "{Decimal}",
57
                    "invoicedAmount
InvoicedAmount

Invoiced amount per day in local currency

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

": "{Decimal}"
58
               },
59
               "rentalCalendarDayLink
RentalCalendarDayLink

Rental calendar day reference

": "{String}"
60
          }
61
     ],
62
     "paging
Paging

Detailed paging information for this list.

": {
63
          "pageSize
PageSize

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

": "{Integer}",
64
          "position
Position

Position of the first element in the list

": "{Integer}",
65
          "page
Page

Page index

": "{Integer}",
66
          "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}",
67
          "firstPage
FirstPage

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

": "{String}",
68
          "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}",
69
          "previousPage
PreviousPage

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

": "{String}",
70
          "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}",
71
          "nextPage
NextPage

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

": "{String}",
72
          "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}",
73
          "lastPage
LastPage

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

": "{String}",
74
          "size
Size

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

": "{Integer}"
75
     }
76
}

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 105932 HTTP 400 From quantity should be greater than 0
Error 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required