Rental APIs
Append rental contract item
| HTTP method | POST |
| URI | https://api.rambase.net/rental/contracts/{rentalContractId}/items |
| 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 | 201 |
| API resource identifier | 5775, version 15 |
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.
Quantity
Required/mandatory field
Number of units ordered
Minimum value: 0
>{Integer}</Quantity>Period
This field is optional.
>EffectiveDate
Start date for the recurring contract item
This field is optional.
>{Date}</EffectiveDate>ExpirationDate
End date for the recurring contract item
This field is optional.
>{Date}</ExpirationDate>RecurringRate
This field is optional.
>RecurringRateId
Recurring rate identifier
Minimum value: 100000
This field is optional.
>{Integer}</RecurringRateId>Product
This field is optional.
>ProductId
Product identifier
Minimum value: 10000
This field is optional.
>{Integer}</ProductId>Quantity
Required/mandatory field
Number of units ordered
Minimum value: 0
": "{Integer}",Period
This field is optional.
": {EffectiveDate
Start date for the recurring contract item
This field is optional.
": "{Date}",ExpirationDate
End date for the recurring contract item
This field is optional.
": "{Date}"RecurringRate
This field is optional.
": {RecurringRateId
Recurring rate identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Product
This field is optional.
": {ProductId
Product identifier
Minimum value: 10000
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $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] |
| $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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RentalContractItemId
Rental contract item identifier
>{Integer}</RentalContractItemId>LineNumber
Line- or sequence number of the item
>{Integer}</LineNumber>CreatedAt
Date of item creation
>{Datetime}</CreatedAt>RentalContractVersionId
Rental contract version identifier
>{Integer}</RentalContractVersionId>Version
Rental contract item version
>{Integer}</Version>Revision
Rental contract item revision
>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>RentalContractVersionLink
Rentlal contract version reference
>{String}</RentalContractVersionLink>RentalContractQuoteId
Rental contract quote identifier
>{Integer}</RentalContractQuoteId>Name
Quote name
>{String}</Name>IsActive
Indicates whether version is active one
>{Boolean}</IsActive>Status
Status with regard to the stage of the item
Possible domain values can be found here
>{String}</Status>Type
Item type: 1- Subscription, 2 - Rental
Possible domain values can be found here
>{Integer}</Type>Note
Note for contract item
>{String}</Note>InternalNote
Internal note for the contract item
>{String}</InternalNote>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
>{String}</CustomersReferenceNumber>RentalContractItemId
Rental contract item identifier
>{Integer}</RentalContractItemId>VATPercent
Value added tax percent
>{Decimal}</VATPercent>RateChangeType
Change type of recurring rate (FIXED, MANUAL, AUTO). Defines if and how the recurring rate can be updated.
Possible domain values can be found here
>{Integer}</RateChangeType>CustomerId
Customer identifier
>{Integer}</CustomerId>CustomerLink
Customer reference
>{String}</CustomerLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>Quantity
Number of units ordered
>{Integer}</Quantity>DiscountPercent
The discount in percent for this item.
>{Decimal}</DiscountPercent>RecurringRateId
Recurring rate identifier
>{Integer}</RecurringRateId>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>RateInterval
Interval of recurring rate
Possible domain values can be found here
>{Integer}</RateInterval>Type
Type of recurring rate: 1 - Standard, 2 - Special
Possible domain values can be found here
>{Integer}</Type>NumberOfRateSteps
Number of rate steps
>{Integer}</NumberOfRateSteps>RecurringRateLink
Recurring rate reference
>{String}</RecurringRateLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Rate
Value of step rate
>{Decimal}</Rate>EffectiveDate
Start date for the recurring contract item
>{Date}</EffectiveDate>ExpirationDate
End date for the recurring contract item
>{Date}</ExpirationDate>TerminationDate
Termination date of item
>{Date}</TerminationDate>AverageRatePerDay
Average rate per day
>AddressId
Address identifier
>{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>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>ShippingServiceLink
Shipping service reference
>{String}</ShippingServiceLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TotalAmount
Total amount
>{Decimal}</TotalAmount>DiscountAmount
Total discount
>{Decimal}</DiscountAmount>TotalNetAmount
Total amount after discount
>{Decimal}</TotalNetAmount>AccruedRevenue
Total accrued amount for contract item
>{Decimal}</AccruedRevenue>InvoicedAmount
Invoiced amount for contract item
>{Decimal}</InvoicedAmount>ForecastedRevenue
Total forecasted revenue for contract item
>{Decimal}</ForecastedRevenue>EarnedRevenue
Total earned revenue for contract item
>{Decimal}</EarnedRevenue>DeferredRevenue
Total deferred revenue of rental contract item
>{Decimal}</DeferredRevenue>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TotalAmount
Total amount for contract item in company currency
>{Decimal}</TotalAmount>DiscountAmount
Total discount in local currency
>{Decimal}</DiscountAmount>TotalNetAmount
Total amount in local currency after the discount
>{Decimal}</TotalNetAmount>AccruedRevenue
Total accrued revenue for contract item in company currency.
>{Decimal}</AccruedRevenue>InvoicedAmount
Invoiced amount for contract item in company currency.
>{Decimal}</InvoicedAmount>ForecastedRevenue
Total forecasted revenue for contract item in company currency.
>{Decimal}</ForecastedRevenue>EarnedRevenue
Total earned revenue in local currency
>{Decimal}</EarnedRevenue>DeferredRevenue
Total deferred revenue for rental contract item in company currency.
>{Decimal}</DeferredRevenue>Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>VATPercent
Value added tax percent
>{Decimal}</VATPercent>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>Department
The department related to the item. One of the system/fixed account dimensions.
>DepartmentId
Department identifier
>{Integer}</DepartmentId>DepartmentLink
Finance department reference
>{String}</DepartmentLink>FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>Asset
The asset related to the item. One of the system/fixed account dimensions.
>AssetId
Asset identifier
>{Integer}</AssetId>AssetLink
Asset reference
>{String}</AssetLink>Quantity
Quantity change range from min to max
>Min
Minimum quantity
>{Integer}</Min>Max
Maximum quantity
>{Integer}</Max>Current
Rental calendar day quantity
>{Integer}</Current>NumberOfChanges
Number of changes
>{Integer}</NumberOfChanges>NumberOfChanges
Number of recurring rates used by rental contract item
>{Integer}</NumberOfChanges>RecurringRateId
Recurring rate identifier
>{Integer}</RecurringRateId>RecurringRateLink
Recurring rate reference
>{String}</RecurringRateLink>Min
Minimum discount per centage
>{Decimal}</Min>Max
Maximum discount percentage
>{Decimal}</Max>Current
Discount percent for calendar day
>{Decimal}</Current>NumberOfChanges
Number of changes
>{Integer}</NumberOfChanges>RentalContractItemId
Rental contract item identifier
": "{Integer}",LineNumber
Line- or sequence number of the item
": "{Integer}",CreatedAt
Date of item creation
": "{Datetime}",RentalContractVersionId
Rental contract version identifier
": "{Integer}",Version
Rental contract item version
": "{Integer}",Revision
Rental contract item revision
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"RentalContractVersionLink
Rentlal contract version reference
": "{String}"RentalContractQuoteId
Rental contract quote identifier
": "{Integer}",Name
Quote name
": "{String}"IsActive
Indicates whether version is active one
": "{Boolean}",Status
Status with regard to the stage of the item
Possible domain values can be found here
": "{String}",Type
Item type: 1- Subscription, 2 - Rental
Possible domain values can be found here
": "{Integer}",Note
Note for contract item
": "{String}",InternalNote
Internal note for the contract item
": "{String}",CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
": "{String}",RentalContractItemId
Rental contract item identifier
": "{Integer}"VATPercent
Value added tax percent
": "{Decimal}",RateChangeType
Change type of recurring rate (FIXED, MANUAL, AUTO). Defines if and how the recurring rate can be updated.
Possible domain values can be found here
": "{Integer}",CustomerId
Customer identifier
": "{Integer}",CustomerLink
Customer reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}"Quantity
Number of units ordered
": "{Integer}",DiscountPercent
The discount in percent for this item.
": "{Decimal}",RecurringRateId
Recurring rate identifier
": "{Integer}",Status
Status of recurring rate
Possible domain values can be found here
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",RateInterval
Interval of recurring rate
Possible domain values can be found here
": "{Integer}",Type
Type of recurring rate: 1 - Standard, 2 - Special
Possible domain values can be found here
": "{Integer}",NumberOfRateSteps
Number of rate steps
": "{Integer}",RecurringRateLink
Recurring rate reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",Rate
Value of step rate
": "{Decimal}"EffectiveDate
Start date for the recurring contract item
": "{Date}",ExpirationDate
End date for the recurring contract item
": "{Date}",TerminationDate
Termination date of item
": "{Date}"AverageRatePerDay
Average rate per day
": {AddressId
Address identifier
": "{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}",ShippingServiceId
Shipping service identifier
": "{Integer}",ShippingServiceLink
Shipping service reference
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",TotalAmount
Total amount
": "{Decimal}",DiscountAmount
Total discount
": "{Decimal}",TotalNetAmount
Total amount after discount
": "{Decimal}",AccruedRevenue
Total accrued amount for contract item
": "{Decimal}",InvoicedAmount
Invoiced amount for contract item
": "{Decimal}",ForecastedRevenue
Total forecasted revenue for contract item
": "{Decimal}",EarnedRevenue
Total earned revenue for contract item
": "{Decimal}",DeferredRevenue
Total deferred revenue of rental contract item
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",TotalAmount
Total amount for contract item in company currency
": "{Decimal}",DiscountAmount
Total discount in local currency
": "{Decimal}",TotalNetAmount
Total amount in local currency after the discount
": "{Decimal}",AccruedRevenue
Total accrued revenue for contract item in company currency.
": "{Decimal}",InvoicedAmount
Invoiced amount for contract item in company currency.
": "{Decimal}",ForecastedRevenue
Total forecasted revenue for contract item in company currency.
": "{Decimal}",EarnedRevenue
Total earned revenue in local currency
": "{Decimal}",DeferredRevenue
Total deferred revenue for rental contract item in company currency.
": "{Decimal}"Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
": {VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}",VATPercent
Value added tax percent
": "{Decimal}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"Department
The department related to the item. One of the system/fixed account dimensions.
": {DepartmentId
Department identifier
": "{Integer}",DepartmentLink
Finance department reference
": "{String}"FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
": {FinanceProjectId
Finance project identifier
": "{Integer}",FinanceProjectLink
Finance project reference
": "{String}"Asset
The asset related to the item. One of the system/fixed account dimensions.
": {AssetId
Asset identifier
": "{Integer}",AssetLink
Asset reference
": "{String}"Quantity
Quantity change range from min to max
": {Min
Minimum quantity
": "{Integer}",Max
Maximum quantity
": "{Integer}",Current
Rental calendar day quantity
": "{Integer}",NumberOfChanges
Number of changes
": "{Integer}"NumberOfChanges
Number of recurring rates used by rental contract item
": "{Integer}",RecurringRateId
Recurring rate identifier
": "{Integer}",RecurringRateLink
Recurring rate reference
": "{String}"Min
Minimum discount per centage
": "{Decimal}",Max
Maximum discount percentage
": "{Decimal}",Current
Discount percent for calendar day
": "{Decimal}",NumberOfChanges
Number of changes
": "{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 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 |
| Error 108386 HTTP 400 | Rental calendar already exists for selected item |
| Error 100345 HTTP 400 | Location is required |
| Error 108514 HTTP 400 | Invalid invoice frequency |
| Error 108635 HTTP 400 | Effective date cannot be later then effective date of any contract item |
| Error 108421 HTTP 400 | The effective date cannot be later than the expiration date |
| Error 108735 HTTP 400 | Expiration date of a contract cannot be earlier then expiration date of any of its quotes |
| Error 108674 HTTP 400 | Termination date cannot be earlier then the effective date |
| Error 108675 HTTP 400 | Termination date cannot be later then the expiration date |
| Error 108672 HTTP 400 | Closing date cannot be earlier then the effective date |
| Error 108673 HTTP 400 | Closing date cannot be later then the expiration date |
| Error 104971 HTTP 400 | The start date cannot be later than the end date |
| Error 108262 HTTP 404 | Recurring rate not found |
| Error 108691 HTTP 400 | Recurring rate is not active |
| Error 108018 HTTP 400 | Currency mismatch |
| Error 108016 HTTP 400 | Product id mismatch |
| Error 108824 HTTP 400 | Cannot apply recurring rate as it is not valid for selected period |
| Error 108671 HTTP 400 | The effective date cannot be changed because earlier days have already been invoiced |
| Error 108684 HTTP 400 | The expiration date cannot be changed because later days have already been invoiced |
| Error 108677 HTTP 400 | Expected delivery date cannot be earlier than the effective date |
| Error 108678 HTTP 400 | Expected collection date cannot be earlier than the effective date |
| Error 108679 HTTP 400 | Expected collection date cannot be earlier then expected delivery date |
| Error 108680 HTTP 400 | Collection date cannot be earlier then the effective date |
| Error 108681 HTTP 400 | Collection date cannot be earlier then the expected delivery date |
| Error 108683 HTTP 400 | Termination date must be earlier then the expiration date |