API

Rental APIs

GET rental/contracts

Get list of rental contracts

HTTP method GET
URI https://api.rambase.net/rental/contracts
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 5757, version 17

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"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$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.

ActiveOpen() Named filter Contracts in status between 1 and 4
ContainsRentalItems() Named filter Contracts containing rental items
ContainsSubscrItems() Named filter Contracts containing subscription items
ItemCheckInDateSoon() Named filter Contracts containing items with expected check in date within next 7 days
ItemCheckOutDateSoon() Named filter Contracts containing items with expected check out date within next 7 days
Rental() Named filter Contracts containing only rental items
Subscription() Named filter Contracts containing only subscription items
BaseDate Date A date from which invoices will start to be generated from. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ClosingDate Date The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
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.
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).
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.
EffectiveDate Date Start date for the recurring contract. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ExpirationDate Date End date of the recurring contract. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
InvoiceFrequency Integer Sets frequency at which invoice can be issued.
IsAutomaticallyIssued Boolean "True" if invoices in this rental contract should be released automatically.
IsInvoicedInAdvance Boolean True if rental contract is invoiced in advance.
Name String Short description for the rental contract.
RentalContractId Integer Rental contract identifier.
RentalType Integer Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent.
ResponsibleFirstName String First name of the user.
ResponsibleName String Name of the user.
Status Integer Rental contract status.
TerminationDate Date The date of termination of the contract. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

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

BaseDate Date A date from which invoices will start to be generated from
ClosingDate Date The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
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)
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.
EffectiveDate Date Start date for the recurring contract
ExpirationDate Date End date of the recurring contract
InvoiceFrequency Integer Sets frequency at which invoice can be issued.
IsAutomaticallyIssued Boolean "True" if invoices in this rental contract should be released automatically
IsInvoicedInAdvance Boolean True if rental contract is invoiced in advance
Name String Short description for the rental contract
RentalContractId Integer Rental contract identifier
RentalType Integer Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent
ResponsibleFirstName String First name of the user
ResponsibleName String Name of the user
Status Integer Rental contract status
TerminationDate Date The date of termination of the contract

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
<RentalContracts>
2
     <RentalContract>
3
          <RentalContractId
RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>
4
          <Status
Status

Rental contract status

Possible domain values can be found here

>{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <Name
Name

Short description for the rental contract

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

Detailed description for the recurring rental contract

>{String}</Description>
8
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
9
          <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
10
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
11
          <RentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Possible domain values can be found here

>{Integer}</RentalType>
12
          <InvoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Possible domain values can be found here

>{Integer}</InvoiceFrequency>
13
          <BaseDate
BaseDate

A date from which invoices will start to be generated from

>{Date}</BaseDate>
14
          <IsAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

>{Boolean}</IsAutomaticallyIssued>
15
          <AdvanceInvoicing>
16
               <IsInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

>{Boolean}</IsInvoicedInAdvance>
17
               <BaseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

>{Integer}</BaseDateAdvanceDays>
18
          </AdvanceInvoicing>
19
          <Period>
20
               <EffectiveDate
EffectiveDate

Start date for the recurring contract

>{Date}</EffectiveDate>
21
               <ExpirationDate
ExpirationDate

End date of the recurring contract

>{Date}</ExpirationDate>
22
               <RegistrationDate
RegistrationDate

The date of registration of the contract

>{Date}</RegistrationDate>
23
               <TerminationDate
TerminationDate

The date of termination of the contract

>{Date}</TerminationDate>
24
               <ClosingDate
ClosingDate

The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed

>{Date}</ClosingDate>
25
          </Period>
26
          <Customer>
27
               <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

>{String}</CustomerLink>
31
          </Customer>
32
          <Payment>
33
               <PaymentTerms
PaymentTerms

Payment terms for rental contract

Possible domain values can be found here

>{String}</PaymentTerms>
34
          </Payment>
35
          <InvoiceAddress>
36
               <AddressId
AddressId

Reference to customer's invoice address

>{Integer}</AddressId>
37
          </InvoiceAddress>
38
          <Responsible
Responsible

PID reference of sales assistant for the contract

>
39
               <UserId
UserId

User identifier

>{Integer}</UserId>
40
               <Name
Name

Name of the user

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

First name of the user

>{String}</FirstName>
42
               <UserLink
UserLink

User reference

>{String}</UserLink>
43
          </Responsible>
44
          <Assignee
Assignee

PID reference of sales assistant for the contract

>
45
               <UserId
UserId

User identifier

>{Integer}</UserId>
46
               <Name
Name

Name of the user

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

First name of the user

>{String}</FirstName>
48
               <UserLink
UserLink

User reference

>{String}</UserLink>
49
          </Assignee>
50
          <AccountManager
AccountManager

PID reference of sales assistant for the contract

>
51
               <UserId
UserId

User identifier

>{Integer}</UserId>
52
               <Name
Name

Name of the user

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

First name of the user

>{String}</FirstName>
54
               <UserLink
UserLink

User reference

>{String}</UserLink>
55
          </AccountManager>
56
          <Location>
57
               <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
58
          </Location>
59
          <Shipment>
60
               <DeliveryTerms
DeliveryTerms

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.

Possible domain values can be found here

>{String}</DeliveryTerms>
61
               <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

>{String}</DeliveryTermPlace>
62
               <ShippingService>
63
                    <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
64
                    <Name
Name

Name of shipping service

>{String}</Name>
65
               </ShippingService>
66
          </Shipment>
67
          <Totals>
68
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
69
               <TotalAmount
TotalAmount

Total amount estimated per rental contract

>{Decimal}</TotalAmount>
70
               <DiscountAmount
DiscountAmount

Accumulated value of total discount

>{Decimal}</DiscountAmount>
71
               <TotalNetAmount
TotalNetAmount

Accumulated sum of total amounts after the discounts

>{Decimal}</TotalNetAmount>
72
               <AccruedRevenue
AccruedRevenue

Accumulated value of accrued amounts

>{Decimal}</AccruedRevenue>
73
               <InvoicedAmount
InvoicedAmount

Accumulated value of invoiced amounts

>{Decimal}</InvoicedAmount>
74
               <ForecastedRevenue
ForecastedRevenue

Accumulated value of forecasted amounts

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

Accumulated value of earned revenue of all contract items

>{Decimal}</EarnedRevenue>
76
               <CountOfQuotes
CountOfQuotes

Count of items in stage quote

>{Integer}</CountOfQuotes>
77
          </Totals>
78
     </RentalContract>
79
     <Paging
Paging

Detailed paging information for this list.

>
80
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
83
          <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>
84
          <FirstPage
FirstPage

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

>{String}</FirstPage>
85
          <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>
86
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
87
          <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>
88
          <NextPage
NextPage

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

>{String}</NextPage>
89
          <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>
90
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
92
     </Paging>
93
</RentalContracts>
1
{
2
     "rentalContracts": [
3
          {
4
               "rentalContractId
RentalContractId

Rental contract identifier

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

Rental contract status

Possible domain values can be found here

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

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

Short description for the rental contract

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

Detailed description for the recurring rental contract

": "{String}",
9
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
10
               "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
11
               "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
12
               "rentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Possible domain values can be found here

": "{Integer}",
13
               "invoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Possible domain values can be found here

": "{Integer}",
14
               "baseDate
BaseDate

A date from which invoices will start to be generated from

": "{Date}",
15
               "isAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

": "{Boolean}",
16
               "advanceInvoicing": {
17
                    "isInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

": "{Boolean}",
18
                    "baseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

": "{Integer}"
19
               },
20
               "period": {
21
                    "effectiveDate
EffectiveDate

Start date for the recurring contract

": "{Date}",
22
                    "expirationDate
ExpirationDate

End date of the recurring contract

": "{Date}",
23
                    "registrationDate
RegistrationDate

The date of registration of the contract

": "{Date}",
24
                    "terminationDate
TerminationDate

The date of termination of the contract

": "{Date}",
25
                    "closingDate
ClosingDate

The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed

": "{Date}"
26
               },
27
               "customer": {
28
                    "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
32
               },
33
               "payment": {
34
                    "paymentTerms
PaymentTerms

Payment terms for rental contract

Possible domain values can be found here

": "{String}"
35
               },
36
               "invoiceAddress": {
37
                    "addressId
AddressId

Reference to customer's invoice address

": "{Integer}"
38
               },
39
               "responsible
Responsible

PID reference of sales assistant for the contract

": {
40
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
43
                    "userLink
UserLink

User reference

": "{String}"
44
               },
45
               "assignee
Assignee

PID reference of sales assistant for the contract

": {
46
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
49
                    "userLink
UserLink

User reference

": "{String}"
50
               },
51
               "accountManager
AccountManager

PID reference of sales assistant for the contract

": {
52
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
55
                    "userLink
UserLink

User reference

": "{String}"
56
               },
57
               "location": {
58
                    "locationId
LocationId

Location identifier

": "{Integer}"
59
               },
60
               "shipment": {
61
                    "deliveryTerms
DeliveryTerms

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.

Possible domain values can be found here

": "{String}",
62
                    "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

": "{String}",
63
                    "shippingService": {
64
                         "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

": "{String}"
66
                    }
67
               },
68
               "totals": {
69
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
70
                    "totalAmount
TotalAmount

Total amount estimated per rental contract

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

Accumulated value of total discount

": "{Decimal}",
72
                    "totalNetAmount
TotalNetAmount

Accumulated sum of total amounts after the discounts

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

Accumulated value of accrued amounts

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

Accumulated value of invoiced amounts

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

Accumulated value of forecasted amounts

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

Accumulated value of earned revenue of all contract items

": "{Decimal}",
77
                    "countOfQuotes
CountOfQuotes

Count of items in stage quote

": "{Integer}"
78
               }
79
          }
80
     ],
81
     "paging
Paging

Detailed paging information for this list.

": {
82
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
94
     }
95
}

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 101814 HTTP 404 Employee not found