API

Rental APIs

GET rental/contracts/{rentalContractId}/items/{itemId}/invoice-periods

Get list of invoice periods per rental contract item

HTTP method GET
URI https://api.rambase.net/rental/contracts/{rentalContractId}/items/{itemId}/invoice-periods
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalContractId} Rental contract identifier
Integer, minimum 100000
- URI parameter {itemId} Rental contract item identifier
Integer, minimum 1
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6301, version 18

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"
$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.

CustomersReferenceNumber String Customer reference number for invoice period.
EndDate Date End date of invoice period. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
InvoicePeriodId Integer Rental contract invoice period id.
PlannedInvoiceDate Date Planned invoice date for period. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
StartDate Date Start date of invoice period. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status String Status of invoice period.

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

CustomersReferenceNumber String Customer reference number for invoice period
EndDate Date End date of invoice period
InvoicePeriodId Integer Rental contract invoice period id
PlannedInvoiceDate Date Planned invoice date for period
StartDate Date Start date of invoice period
Status String Status of invoice period

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
<InvoicePeriods>
2
     <InvoicePeriod>
3
          <InvoicePeriodId
InvoicePeriodId

Rental contract invoice period id

>{Integer}</InvoicePeriodId>
4
          <CreatedAt
CreatedAt

Creation date of period

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

Status of invoice period

Possible domain values can be found here

>{String}</Status>
6
          <Period>
7
               <StartDate
StartDate

Start date of invoice period

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

End date of invoice period

>{Date}</EndDate>
9
          </Period>
10
          <PlannedInvoiceDate
PlannedInvoiceDate

Planned invoice date for period

>{Date}</PlannedInvoiceDate>
11
          <CustomersReferenceNumber
CustomersReferenceNumber

Customer reference number for invoice period

>{String}</CustomersReferenceNumber>
12
          <TotalDays
TotalDays

Total no of days

>{Integer}</TotalDays>
13
          <TotalOffRentDays
TotalOffRentDays

Number of off-rent days

>{Integer}</TotalOffRentDays>
14
          <LatestBillingEntries
LatestBillingEntries

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

>
15
               <BillingEntry
BillingEntry

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

>
16
                    <BillingEntryId
BillingEntryId

Billing period item id

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

>{Integer}</BillingEntryId>
17
                    <Status
Status

Status of invoice period

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

>{String}</Status>
18
                    <Period
Period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

>
19
                         <StartDate
StartDate

Start date of invoice period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

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

End date of invoice period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

>{Date}</EndDate>
21
                    </Period>
22
                    <Totals
Totals

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

>
23
                         <TotalNetAmount
TotalNetAmount

Total amount after discount for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

>{Decimal}</TotalNetAmount>
24
                         <InvoicedAmount
InvoicedAmount

Total amount invoiced for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

>{Decimal}</InvoicedAmount>
25
                    </Totals>
26
               </BillingEntry>
27
          </LatestBillingEntries>
28
          <TotalSalesInvoices
TotalSalesInvoices

Number of sales invoices

>{Integer}</TotalSalesInvoices>
29
          <LatestSalesInvoices
LatestSalesInvoices

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

>
30
               <SalesInvoice
SalesInvoice

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

>
31
                    <SalesInvoiceId
SalesInvoiceId

Sales invoice identifier

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

>{Integer}</SalesInvoiceId>
32
                    <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

>{Datetime}</CreatedAt>
33
                    <IssueDate
IssueDate

Invoice date

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

>{Date}</IssueDate>
34
                    <Status
Status

Status of the sales invoice

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

>{String}</Status>
35
                    <SalesInvoiceLink
SalesInvoiceLink

Sales invoice reference

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

>{String}</SalesInvoiceLink>
36
               </SalesInvoice>
37
          </LatestSalesInvoices>
38
          <TotalSalesCreditNotes
TotalSalesCreditNotes

Number of sales credit notes

>{Integer}</TotalSalesCreditNotes>
39
          <LatestSalesCreditNotes
LatestSalesCreditNotes

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

>
40
               <SalesCreditNote
SalesCreditNote

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

>
41
                    <SalesCreditNoteId
SalesCreditNoteId

Sales credit note identifier

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

>{Integer}</SalesCreditNoteId>
42
                    <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

>{Datetime}</CreatedAt>
43
                    <IssueDate
IssueDate

Date when the document was issued.

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

>{Date}</IssueDate>
44
                    <Status
Status

Status of the sales invoice

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

>{String}</Status>
45
                    <SalesCreditNoteLink
SalesCreditNoteLink

Sales credit note reference

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

>{String}</SalesCreditNoteLink>
46
               </SalesCreditNote>
47
          </LatestSalesCreditNotes>
48
          <Totals>
49
               <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

Total amount for period before discount

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

Total discount amount for the period

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

Total amount after discount for the period

>{Decimal}</TotalNetAmount>
53
               <InvoicedAmount
InvoicedAmount

Total amount invoiced for the period

>{Decimal}</InvoicedAmount>
54
          </Totals>
55
          <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

>
56
               <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

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

Total amount in local currency for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

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

Total discount amount in local currency for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

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

Total amount in local currency after the discount for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

>{Decimal}</TotalNetAmount>
60
               <InvoicedAmount
InvoicedAmount

Total invoiced amount in local currency for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

>{Decimal}</InvoicedAmount>
61
          </TotalsConverted>
62
     </InvoicePeriod>
63
     <Paging
Paging

Detailed paging information for this list.

>
64
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
67
          <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>
68
          <FirstPage
FirstPage

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

>{String}</FirstPage>
69
          <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>
70
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
71
          <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>
72
          <NextPage
NextPage

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

>{String}</NextPage>
73
          <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>
74
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
76
     </Paging>
77
</InvoicePeriods>
1
{
2
     "invoicePeriods": [
3
          {
4
               "invoicePeriodId
InvoicePeriodId

Rental contract invoice period id

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

Creation date of period

": "{Datetime}",
6
               "status
Status

Status of invoice period

Possible domain values can be found here

": "{String}",
7
               "period": {
8
                    "startDate
StartDate

Start date of invoice period

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

End date of invoice period

": "{Date}"
10
               },
11
               "plannedInvoiceDate
PlannedInvoiceDate

Planned invoice date for period

": "{Date}",
12
               "customersReferenceNumber
CustomersReferenceNumber

Customer reference number for invoice period

": "{String}",
13
               "totalDays
TotalDays

Total no of days

": "{Integer}",
14
               "totalOffRentDays
TotalOffRentDays

Number of off-rent days

": "{Integer}",
15
               "latestBillingEntries
LatestBillingEntries

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

": [
16
                    {
17
                         "billingEntryId
BillingEntryId

Billing period item id

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

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

Status of invoice period

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

": "{String}",
19
                         "period
Period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

": {
20
                              "startDate
StartDate

Start date of invoice period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

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

End date of invoice period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

": "{Date}"
22
                         },
23
                         "totals
Totals

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

": {
24
                              "totalNetAmount
TotalNetAmount

Total amount after discount for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

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

Total amount invoiced for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestBillingEntries in your request URI to get this field

": "{Decimal}"
26
                         }
27
                    }
28
               ],
29
               "totalSalesInvoices
TotalSalesInvoices

Number of sales invoices

": "{Integer}",
30
               "latestSalesInvoices
LatestSalesInvoices

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

": [
31
                    {
32
                         "salesInvoiceId
SalesInvoiceId

Sales invoice identifier

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

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

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

": "{Datetime}",
34
                         "issueDate
IssueDate

Invoice date

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

": "{Date}",
35
                         "status
Status

Status of the sales invoice

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

": "{String}",
36
                         "salesInvoiceLink
SalesInvoiceLink

Sales invoice reference

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesInvoices in your request URI to get this field

": "{String}"
37
                    }
38
               ],
39
               "totalSalesCreditNotes
TotalSalesCreditNotes

Number of sales credit notes

": "{Integer}",
40
               "latestSalesCreditNotes
LatestSalesCreditNotes

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

": [
41
                    {
42
                         "salesCreditNoteId
SalesCreditNoteId

Sales credit note identifier

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

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

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

": "{Datetime}",
44
                         "issueDate
IssueDate

Date when the document was issued.

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

": "{Date}",
45
                         "status
Status

Status of the sales invoice

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

": "{String}",
46
                         "salesCreditNoteLink
SalesCreditNoteLink

Sales credit note reference

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.LatestSalesCreditNotes in your request URI to get this field

": "{String}"
47
                    }
48
               ],
49
               "totals": {
50
                    "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

Total amount for period before discount

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

Total discount amount for the period

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

Total amount after discount for the period

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

Total amount invoiced for the period

": "{Decimal}"
55
               },
56
               "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

": {
57
                    "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

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

Total amount in local currency for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

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

Total discount amount in local currency for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

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

Total amount in local currency after the discount for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

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

Total invoiced amount in local currency for the period

This field is greyed out because it is an expandable field. You have to add $expand=InvoicePeriod.TotalsConverted in your request URI to get this field

": "{Decimal}"
62
               }
63
          }
64
     ],
65
     "paging
Paging

Detailed paging information for this list.

": {
66
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
78
     }
79
}

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects