API

Rental APIs

GET rental/contracts/{rentalContractId}/invoice-periods/{invoicePeriodId}

Get rental contract invoice period

HTTP method GET
URI https://api.rambase.net/rental/contracts/{rentalContractId}/invoice-periods/{invoicePeriodId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalContractId} Rental contract identifier
Integer, minimum 100000
- URI parameter {invoicePeriodId} Rental contract invoice period id
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 6978, version 9

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

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.

Format:
1
<InvoicePeriod>
2
     <InvoicePeriodId
InvoicePeriodId

Rental contract invoice period id

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

Creation date of period

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

Status of invoice period

Possible domain values can be found here

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

Start date of invoice period

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

End date of invoice period

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

Planned invoice date for period

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

Customer reference number for invoice period

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

Total number of days

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

Number of off-rent days

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

Number of billing period entries

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

This field is greyed out because it is an expandable field. You have to add $expand=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=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=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=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=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=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=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=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=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=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=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=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=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=LatestSalesInvoices in your request URI to get this field

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

Date when the document was issued.

This field is greyed out because it is an expandable field. You have to add $expand=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=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=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=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=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=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=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=LatestSalesCreditNotes in your request URI to get this field

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

Status of the sales credit note

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=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=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
          <InvoiceableAmount
InvoiceableAmount

Total amount to be invoiced for the period

>{Decimal}</InvoiceableAmount>
55
          <ProformaAmount
ProformaAmount

Amount of the pro forma invoice for the given period

>{Decimal}</ProformaAmount>
56
          <PendingPaymentAmount
PendingPaymentAmount

Amount from invoices pending payment for the given invoice period

>{Decimal}</PendingPaymentAmount>
57
          <PaidAmount
PaidAmount

Amount from invoices paid for the given invoice period

>{Decimal}</PaidAmount>
58
          <CreditedAmount
CreditedAmount

Amount of the credit note for the given period

>{Decimal}</CreditedAmount>
59
     </Totals>
60
     <TotalsConverted
TotalsConverted

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

>
61
          <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=TotalsConverted in your request URI to get this field

>{String}</Currency>
62
          <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=TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
63
          <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=TotalsConverted in your request URI to get this field

>{Decimal}</DiscountAmount>
64
          <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=TotalsConverted in your request URI to get this field

>{Decimal}</TotalNetAmount>
65
          <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=TotalsConverted in your request URI to get this field

>{Decimal}</InvoicedAmount>
66
          <InvoiceableAmount
InvoiceableAmount

Total amount to be invoiced in local currency for the period

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

>{Decimal}</InvoiceableAmount>
67
     </TotalsConverted>
68
</InvoicePeriod>
1
{
2
     "invoicePeriod": {
3
          "invoicePeriodId
InvoicePeriodId

Rental contract invoice period id

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

Creation date of period

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

Status of invoice period

Possible domain values can be found here

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

Start date of invoice period

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

End date of invoice period

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

Planned invoice date for period

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

Customer reference number for invoice period

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

Total number of days

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

Number of off-rent days

": "{Integer}",
14
          "totalBillingEntries
TotalBillingEntries

Number of billing period entries

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

This field is greyed out because it is an expandable field. You have to add $expand=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=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=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=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=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=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=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=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=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=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=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=LatestSalesInvoices in your request URI to get this field

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

Date when the document was issued.

This field is greyed out because it is an expandable field. You have to add $expand=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=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=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=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=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=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=LatestSalesCreditNotes in your request URI to get this field

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

Status of the sales credit note

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=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=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
               "invoiceableAmount
InvoiceableAmount

Total amount to be invoiced for the period

": "{Decimal}",
56
               "proformaAmount
ProformaAmount

Amount of the pro forma invoice for the given period

": "{Decimal}",
57
               "pendingPaymentAmount
PendingPaymentAmount

Amount from invoices pending payment for the given invoice period

": "{Decimal}",
58
               "paidAmount
PaidAmount

Amount from invoices paid for the given invoice period

": "{Decimal}",
59
               "creditedAmount
CreditedAmount

Amount of the credit note for the given period

": "{Decimal}"
60
          },
61
          "totalsConverted
TotalsConverted

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

": {
62
               "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=TotalsConverted in your request URI to get this field

": "{String}",
63
               "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=TotalsConverted in your request URI to get this field

": "{Decimal}",
64
               "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=TotalsConverted in your request URI to get this field

": "{Decimal}",
65
               "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=TotalsConverted in your request URI to get this field

": "{Decimal}",
66
               "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=TotalsConverted in your request URI to get this field

": "{Decimal}",
67
               "invoiceableAmount
InvoiceableAmount

Total amount to be invoiced in local currency for the period

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

": "{Decimal}"
68
          }
69
     }
70
}

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 100001 HTTP 404 Address not found