Rental APIs
Get rental contract details
| HTTP method | GET |
| URI | https://api.rambase.net/rental/contracts/{rentalContractId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {rentalContractId} |
Rental contract identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 5758, version 32 |
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.
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $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. |
| $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. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
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.
RentalContractId
Rental contract identifier
>{Integer}</RentalContractId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Short description for the rental contract
>{String}</Name>Description
Detailed description for the recurring rental contract
>{String}</Description>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>CustomersReference
Customers reference. Typically a person.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{String}</CustomersReferenceNumber>RentalType
Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent
Possible domain values can be found here
>{Integer}</RentalType>InvoiceFrequency
Sets frequency at which invoice can be issued.
Possible domain values can be found here
>{Integer}</InvoiceFrequency>CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
>{Boolean}</CreateAccountAdjustmentPlan>BaseDate
A date from which invoices will start to be generated from
>{Date}</BaseDate>IsAutomaticallyIssued
"True" if invoices in this rental contract should be released automatically
>{Boolean}</IsAutomaticallyIssued>ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
>{String}</ShippingAddressAttention>ShippingAddressPhone
Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.
>{String}</ShippingAddressPhone>ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
>{String}</ShippingAddressEmail>InvoiceAddressAttention
Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.
>{String}</InvoiceAddressAttention>IsInvoicedInAdvance
True if rental contract is invoiced in advance
>{Boolean}</IsInvoicedInAdvance>BaseDateAdvanceDays
Number of days to advance invoicing from base date
>{Integer}</BaseDateAdvanceDays>EffectiveDate
Start date for the recurring contract
>{Date}</EffectiveDate>ExpirationDate
End date of the recurring contract
>{Date}</ExpirationDate>RegistrationDate
The date of registration of the contract
>{Date}</RegistrationDate>TerminationDate
The date of termination of the contract
>{Date}</TerminationDate>ClosingDate
The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed
>{Date}</ClosingDate>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>CustomerLink
Customer reference
>{String}</CustomerLink>AddressId
Reference to customer's invoice address
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</FirstName>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>AddressLink
Address reference
>{String}</AddressLink>AddressId
Reference to customer's shipping address
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</FirstName>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>ExternalReference
External address identifier. Normally defined by the customer.
>{String}</ExternalReference>AddressLink
Address reference
>{String}</AddressLink>Responsible
PID reference of sales assistant for the contract
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>Assignee
PID reference of sales assistant for the contract
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>AccountManager
PID reference of sales assistant for the contract
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>PaymentTerms
Payment terms for rental contract
Possible domain values can be found here
>{String}</PaymentTerms>VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Possible domain values can be found here
>{String}</VATHandling>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>LocationLink
Location reference
>{String}</LocationLink>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>DeliveryTermPlace
Named place related to delivery terms (Incoterms)
>{String}</DeliveryTermPlace>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>Name
Name of shipping service
>{String}</Name>CarrierId
Carrier identifier
>{Integer}</CarrierId>CarrierLink
Carrier reference
>{String}</CarrierLink>ShippingServiceLink
Shipping service reference
>{String}</ShippingServiceLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TotalAmount
Total amount estimated per rental contract
>{Decimal}</TotalAmount>DiscountAmount
Accumulated value of total discount
>{Decimal}</DiscountAmount>TotalNetAmount
Accumulated sum of total amounts after the discounts
>{Decimal}</TotalNetAmount>AccruedRevenue
Accumulated value of accrued amounts
>{Decimal}</AccruedRevenue>InvoicedAmount
Accumulated value of invoiced amounts
>{Decimal}</InvoicedAmount>ForecastedRevenue
Accumulated value of forecasted amounts
>{Decimal}</ForecastedRevenue>EarnedRevenue
Accumulated value of earned revenue of all contract items
>{Decimal}</EarnedRevenue>CountOfQuotes
Count of items in stage quote
>{Integer}</CountOfQuotes>RentalContractId
Rental contract identifier
": "{Integer}",Status
Rental contract status
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Short description for the rental contract
": "{String}",Description
Detailed description for the recurring rental contract
": "{String}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",CustomersReference
Customers reference. Typically a person.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{String}",RentalType
Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent
Possible domain values can be found here
": "{Integer}",InvoiceFrequency
Sets frequency at which invoice can be issued.
Possible domain values can be found here
": "{Integer}",CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
": "{Boolean}",BaseDate
A date from which invoices will start to be generated from
": "{Date}",IsAutomaticallyIssued
"True" if invoices in this rental contract should be released automatically
": "{Boolean}",ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
": "{String}",ShippingAddressPhone
Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.
": "{String}",ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
": "{String}",InvoiceAddressAttention
Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.
": "{String}",IsInvoicedInAdvance
True if rental contract is invoiced in advance
": "{Boolean}",BaseDateAdvanceDays
Number of days to advance invoicing from base date
": "{Integer}"EffectiveDate
Start date for the recurring contract
": "{Date}",ExpirationDate
End date of the recurring contract
": "{Date}",RegistrationDate
The date of registration of the contract
": "{Date}",TerminationDate
The date of termination of the contract
": "{Date}",ClosingDate
The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed
": "{Date}"CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",CustomerLink
Customer reference
": "{String}"AddressId
Reference to customer's invoice address
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",AddressLink
Address reference
": "{String}"AddressId
Reference to customer's shipping address
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",ExternalReference
External address identifier. Normally defined by the customer.
": "{String}",AddressLink
Address reference
": "{String}"Responsible
PID reference of sales assistant for the contract
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"Assignee
PID reference of sales assistant for the contract
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"AccountManager
PID reference of sales assistant for the contract
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"PaymentTerms
Payment terms for rental contract
Possible domain values can be found here
": "{String}"VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Possible domain values can be found here
": "{String}"LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}"LocationLink
Location reference
": "{String}"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}",DeliveryTermPlace
Named place related to delivery terms (Incoterms)
": "{String}",ShippingServiceId
Shipping service identifier
": "{Integer}",Name
Name of shipping service
": "{String}",CarrierId
Carrier identifier
": "{Integer}",CarrierLink
Carrier reference
": "{String}"ShippingServiceLink
Shipping service reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",TotalAmount
Total amount estimated per rental contract
": "{Decimal}",DiscountAmount
Accumulated value of total discount
": "{Decimal}",TotalNetAmount
Accumulated sum of total amounts after the discounts
": "{Decimal}",AccruedRevenue
Accumulated value of accrued amounts
": "{Decimal}",InvoicedAmount
Accumulated value of invoiced amounts
": "{Decimal}",ForecastedRevenue
Accumulated value of forecasted amounts
": "{Decimal}",EarnedRevenue
Accumulated value of earned revenue of all contract items
": "{Decimal}",CountOfQuotes
Count of items in stage quote
": "{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 100051 HTTP 400 | When logged in as supplier {0} you do not have access to this API resource |
| Error 100055 HTTP 403 | You have only admittance to your own objects |
| Error 100001 HTTP 404 | Address not found |