Resources
- Tenancies
- Leases
- Bills
- Pending bills
- Payments
- Payouts
- Recurring bill items
- One time bill items
- Transactions
- Products
- Contacts
- Rent adjustment
- Categories
Create recurring bill item
curl --request POST \
--url https://api.helloproper.com/recurring-bill-items \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"leaseId": "<string>",
"recurringBillItem": {
"productKey": "<string>",
"description": "<string>",
"amount": {
"currency": "<string>",
"amount": 123
},
"quantity": 123,
"vat": {
"taxMode": "<string>",
"taxRate": 123
},
"dueDateRule": {
"dayOfPeriod": 123
},
"billingCycle": {
"timeUnit": "<string>",
"periodLength": 123,
"start": 123
},
"startedOn": "<string>",
"firstBillingPeriodBillItem": {
"amount": {
"currency": "<string>",
"amount": 123
},
"dueDate": "<string>",
"accountingPeriod": "<string>"
},
"discount": {
"amount": {
"currency": "<string>",
"amount": 123
},
"percentage": 123,
"description": "<string>",
"endDate": "<string>"
}
}
}'{
"recurringBillItemId": "<string>",
"firstDueDate": "<string>"
}Request
The lease for which recurring bill items will be created
The key or identifier for the product or service billed (e.g., “key:rent”)
The content of the description that is going to be put on the bill
The quantity of items that is going to be put on the bill
The rule used to calculate the due date
The day of the period when the due date is calculated (e.g., 1 for the first day after period starts, -1 for the last day before period starts)
Time unit based on which the billing cycle is calculated (“Month”)
The number of time units in the billing cycle (e.g., 1 month, 3 months)
Index of what day within the billing period the cycle starts (usually 1 for the first day of the period)
First due date for the recurring bill item in ISO 8601 format
The due date in ISO 8601 format of the first billing period bill item
The accounting period for the first billing period bill item, in the format “YYYY-MM-DD/YYYY-MM-DD”
Discount that is going to be applied to the recurring bill item
The amount that is going to be subtracted from the recurring bill item amount Either this or “percentage” is required
The percentage of the recurring bill item amount that is going to be subtracted (e.g., 0.10) Either this or “amount” is required
The content of the discount description that is going to be put on the bill
The date in ISO 8601 format on which discount ends
Response
The unique identifier for the created recurring bill item
The first due date in ISO 8601 format of the recurring bill item
curl --request POST \
--url https://api.helloproper.com/recurring-bill-items \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"leaseId": "<string>",
"recurringBillItem": {
"productKey": "<string>",
"description": "<string>",
"amount": {
"currency": "<string>",
"amount": 123
},
"quantity": 123,
"vat": {
"taxMode": "<string>",
"taxRate": 123
},
"dueDateRule": {
"dayOfPeriod": 123
},
"billingCycle": {
"timeUnit": "<string>",
"periodLength": 123,
"start": 123
},
"startedOn": "<string>",
"firstBillingPeriodBillItem": {
"amount": {
"currency": "<string>",
"amount": 123
},
"dueDate": "<string>",
"accountingPeriod": "<string>"
},
"discount": {
"amount": {
"currency": "<string>",
"amount": 123
},
"percentage": 123,
"description": "<string>",
"endDate": "<string>"
}
}
}'{
"recurringBillItemId": "<string>",
"firstDueDate": "<string>"
}