Proper Docs home page
Search...
⌘K
Support
Platform
Platform
Search...
Navigation
Recurring bill items
The recurring bill item object
Documentation
API reference
API reference
Introduction
Authentication
Errors
Logs
Pagination
Versioning
Resources
Tenancies
Leases
Bills
Pending bills
Payments
Payouts
Recurring bill items
The recurring bill item object
GET
List recurring bill items
POST
Create recurring bill item
One time bill items
Transactions
Products
Contacts
Rent adjustment
Categories
On this page
Attributes
Recurring bill items
The recurring bill item object
Attributes
id
string
The unique identifier for the recurring bill item
ownerId
string
The identifier for the owner associated with the recurring bill item
leaseId
string
The identifier for the lease associated with the recurring bill item
created
date
The creation date and time of the recurring bill item in ISO 8601 format
modified
date
The last modification date and time of the recurring bill item in ISO 8601 format
productKey
string
The key or identifier for the product or service billed (e.g., “key:rent”)
startedOn
date
First due date for the recurring bill item in ISO 8601 format
cancelledOn
date
The date in ISO 8601 format on which recurring bill item is stopped from being billed
endedOn
date
The date in ISO 8601 format on which recurring bill item ends billing
billingCycle
object
Show child attributes
timeUnit
string
Time unit based on which the billing cycle is calculated (“Month”)
periodLength
integer
The number of time units in the billing cycle (e.g., 1 month, 3 months)
start
integer
Index of a month when the billing cycle starts (e.g., 1 for January)
amountRecords
array
Show child attributes
id
string
The unique identifier for the amount record
value
object
The amount charged for the recurring bill item
Show child attributes
currency
string
The currency code for the recurring bill item amount (e.g., “DKK”)
amount
number
The amount of the recurring bill item amount (e.g., 100.00)
start
date
The date in ISO 8601 format from which the amount is valid
vatRecords
array
Show child attributes
id
string
The unique identifier for the VAT Record
value
object
The VAT details for the recurring bill item
Show child attributes
taxMode
string
The tax mode for the VAT (e.g., “Exempt”, “Exclusive”)
taxRate
number
The tax rate for the VAT (e.g., 0.25)
start
date
The date in ISO 8601 format from which the VAT is valid
descriptionRecords
array
Show child attributes
id
string
The unique identifier for the description record
value
string
The content of the description that is going to be put on the bill
start
date
The date in ISO 8601 format from which the description is valid
quantityRecords
array
Show child attributes
id
string
The unique identifier for the quantity record
value
Number
The quantity of items that is going to be put on the bill
start
date
The date in ISO 8601 format from which the quantity is valid
List payouts
List recurring bill items
Assistant
Responses are generated using AI and may contain mistakes.