Create a management fee credit
Issues a credit against a property that future management fees can be set off against. The credit starts fully available and is drawn down oldest first when fees are charged.
Authorization
AuthorizationstringrequiredBody
application/json
propertyIdstringrequiredThe property the credit applies to. Must belong to the caller's company and be active.
amountnumberrequiredWhat the credit is worth, in dollars and cents. At least 1.00.
issueDatestring · daterequiredThe day the credit is issued. Returned as creditDate.
descriptionstringWhy the credit is being issued. At most 1000 characters. Returned as memo.
Response
200 · The credit that was created.
idstringThe credit. A Snowflake id sent as a decimal string.
propertyIdstringThe property whose management fees this credit can offset.
portfolioIdstringThe portfolio that property belongs to.
amountnumberWhat the credit is worth, in dollars and cents. Positive — money that reduces what the property owes in management fees.
appliedAmountnumberHow much of it has already been used against fees.
availableAmountnumberWhat is left to use: amount less appliedAmount.
creditDatestring · dateThe day the credit was issued.
memostringWhy the credit was issued. Absent when none was recorded.
bankAccountIdstringThe bank account the credit is booked against.
chartOfAccountIdstringThe chart of account the credit is booked to.
appliedManagementFeesobject[]Which management fees the credit has been used against.
metadataobjectFree-form key-value pairs kept on the credit.
createdstring · date-timeWhen the credit was created, in the company's timezone.
updatedstring · date-timeWhen it last changed, in the company's timezone.
creatorobjectWho created the record.
bankAccountobjectThe bank account the credit is booked against.
chartOfAccountobjectThe chart of account the credit is booked to.
portfolioobjectThe portfolio the property belongs to.
propertyobjectThe property the credit is for.
managementFeesobject[]The management fees the credit has been applied to. Empty on a new credit.