API

Rental APIs

GET system/reports/114855/result-set?customerId={customerId}&rentalContractId={rentalContractId}&plannedInvoiceDateFrom={plannedInvoiceDateFrom}&plannedInvoiceDateTo={plannedInvoiceDateTo}&onlyCurrentMonth={onlyCurrentMonth}&notInvoiced={notInvoiced}

Report of all billing entries

Report name Billing entries
Report identifier 114855
HTTP method GET
URI https://api.rambase.net/system/reports/114855/result-set?customerId={customerId}&rentalContractId={rentalContractId}&plannedInvoiceDateFrom={plannedInvoiceDateFrom}&plannedInvoiceDateTo={plannedInvoiceDateTo}&onlyCurrentMonth={onlyCurrentMonth}&notInvoiced={notInvoiced}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6359, version 5

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.

customerId Integer, optional Customer identifier

Minimum: 10000
rentalContractId Integer, optional Rental contract identifier

Minimum: 100000
plannedInvoiceDateFrom Date, optional Planned invoice date from
plannedInvoiceDateTo Date, optional Planned invoice date to
onlyCurrentMonth Boolean, optional Include only periods items planned to be invoiced in current month
notInvoiced Boolean, optional Include only not invoiced billing period items
$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.

Currency String Recurring invoice plan currency.
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.
PeriodEndDate Date Billing period item end date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PeriodStartDate Date Billing period item start date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PlannedInvoiceDate 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()
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
Quantity Integer Billing period item quantity.
RentalContractId Integer Rental contract identifier.
Status Integer Status of billing period item.

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

Currency String Recurring invoice plan currency
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.
PeriodEndDate Date Billing period item end date
PeriodStartDate Date Billing period item start date
PlannedInvoiceDate Date A date from which invoices will start to be generated from
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
Quantity Integer Billing period item quantity
RentalContractId Integer Rental contract identifier
Status Integer Status of billing period item

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
<Report>
2
     <Rows>
3
          <Row>
4
               <Status
Status

Status of billing period item

Possible domain values can be found here

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

Rental constract item

>
6
                    <RentalContract
RentalContract

Rental contract

>
7
                         <RentalContractId
RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>
8
                         <Name
Name

Short description for the rental contract

>{String}</Name>
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
                         <Customer
Customer

Customer reference

>
12
                              <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

>{String}</CustomerLink>
16
                         </Customer>
17
                    </RentalContract>
18
                    <RentalContractItemId
RentalContractItemId

Rental contract item identifier

>{Integer}</RentalContractItemId>
19
                    <RentalContractItemLink
RentalContractItemLink

Rental contract item reference

>{String}</RentalContractItemLink>
20
               </RentalContractItem>
21
               <Product
Product

Product reference

>
22
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
23
                    <Name
Name

Name of the product

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

Description of the product

>{String}</Description>
25
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
26
               </Product>
27
               <Quantity
Quantity

Billing period item quantity

>{Integer}</Quantity>
28
               <CurrentRateStep
CurrentRateStep

Current price step identifier

>
29
                    <Currency
Currency

Rental contract currency

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

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

Value of step rate

>{Decimal}</Rate>
31
                    <RateInterval
RateInterval

Interval of recurring rate

Possible domain values can be found here

>{String}</RateInterval>
32
                    <RecurringRateLink
RecurringRateLink

Recurring rate reference

>{Integer}</RecurringRateLink>
33
               </CurrentRateStep>
34
               <Totals
Totals

Total amounts

>
35
                    <Currency
Currency

Rental contract currency

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

Total amount for period before discount

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

Total discount amount for the billing period item

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

Total amount after discount for the billing period item

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

Total amount invoiced for the billing period item

>{Decimal}</InvoicedAmount>
40
               </Totals>
41
               <Period
Period

Billing entry from date to date

>
42
                    <StartDate
StartDate

Billing period item start date

>{Date}</StartDate>
43
                    <EndDate
EndDate

Billing period item end date

>{Date}</EndDate>
44
               </Period>
45
               <PlannedInvoiceDate
PlannedInvoiceDate

Planned invoiced date

>{Date}</PlannedInvoiceDate>
46
               <InvoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

>{String}</InvoiceFrequency>
47
          </Row>
48
     </Rows>
49
     <Paging
Paging

Detailed paging information for this list.

>
50
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
53
          <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>
54
          <FirstPage
FirstPage

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

>{String}</FirstPage>
55
          <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>
56
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
57
          <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>
58
          <NextPage
NextPage

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

>{String}</NextPage>
59
          <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>
60
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
62
     </Paging>
63
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Status of billing period item

Possible domain values can be found here

": "{Integer}",
6
                    "rentalContractItem
RentalContractItem

Rental constract item

": {
7
                         "rentalContract
RentalContract

Rental contract

": {
8
                              "rentalContractId
RentalContractId

Rental contract identifier

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

Short description for the rental contract

": "{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
                              "customer
Customer

Customer reference

": {
13
                                   "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
17
                              }
18
                         },
19
                         "rentalContractItemId
RentalContractItemId

Rental contract item identifier

": "{Integer}",
20
                         "rentalContractItemLink
RentalContractItemLink

Rental contract item reference

": "{String}"
21
                    },
22
                    "product
Product

Product reference

": {
23
                         "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

": "{String}",
26
                         "productLink
ProductLink

Product reference

": "{String}"
27
                    },
28
                    "quantity
Quantity

Billing period item quantity

": "{Integer}",
29
                    "currentRateStep
CurrentRateStep

Current price step identifier

": {
30
                         "currency
Currency

Rental contract currency

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

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

Value of step rate

": "{Decimal}",
32
                         "rateInterval
RateInterval

Interval of recurring rate

Possible domain values can be found here

": "{String}",
33
                         "recurringRateLink
RecurringRateLink

Recurring rate reference

": "{Integer}"
34
                    },
35
                    "totals
Totals

Total amounts

": {
36
                         "currency
Currency

Rental contract currency

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

Total amount for period before discount

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

Total discount amount for the billing period item

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

Total amount after discount for the billing period item

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

Total amount invoiced for the billing period item

": "{Decimal}"
41
                    },
42
                    "period
Period

Billing entry from date to date

": {
43
                         "startDate
StartDate

Billing period item start date

": "{Date}",
44
                         "endDate
EndDate

Billing period item end date

": "{Date}"
45
                    },
46
                    "plannedInvoiceDate
PlannedInvoiceDate

Planned invoiced date

": "{Date}",
47
                    "invoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

": "{String}"
48
               }
49
          ]
50
     }
51
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type