GET rental/orders/{rentalOrderId}

Rental order details for provided identifier

Note: Log in to check if your API client have access to run this resource
Version: 1
Success HTTP Status Code: 200

Uri parameters

{rentalOrderId} Integer Rental order identifier

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

$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page 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.

Format:
1
<RentalOrder>
2
     <RentalOrderId
RentalOrderId

Rental order identifier

>
{Integer}</RentalOrderId>
3
     <Status
Status

Status of rental order

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

Reference to the sales order where an invoice plan was created

>
5
          <SalesOrderId
SalesOrderId

Sales order identifier

>
{Integer}</SalesOrderId>
6
          <SalesOrderLink
SalesOrderLink

Sales order reference

>
{String}</SalesOrderLink>
7
     </AdvanceInvoicePlanSource>
8
</RentalOrder>
1
{
2
     "rentalOrder": {
3
          "rentalOrderId
RentalOrderId

Rental order identifier

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

Status of rental order

":
"{Integer}",
5
          "advanceInvoicePlanSource
AdvanceInvoicePlanSource

Reference to the sales order where an invoice plan was created

":
{
6
               "salesOrderId
SalesOrderId

Sales order identifier

":
"{Integer}",
7
               "salesOrderLink
SalesOrderLink

Sales order reference

":
"{String}"
8
          }
9
     }
10
}

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 102103 HTTP 404 Rental order not found
Error 100232 HTTP 404 Sales order not found
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 102120 HTTP 404 Delivery project not found
Error 101814 HTTP 404 Employee not found
Error 100031 HTTP 404 Customer not found
Error 101304 HTTP 404 Carrier not found
Error 101119 HTTP 404 Shipping Service document not found
Error 102738 HTTP 404 Price list not found