This request logs a credit on a line of credit account.
Click here to learn more about this request
A credit can be applied to a line of credit account Note the following when using this request:
The LineOfCreditCreditTransactions object holds credit information. This object is nested within the LineOfCredits entity.
Credits cannot be applied before the account's open date and cannot be applied in previous billing cycles. Attempting to do so will result in an error.
Credits are applied broadly to a line of credit account instead of being applied to a specific Bucket. As such, credits affect the account's broad balance information.
Credits can also be edited and reversed. To do so, include the ID of the credit and the "__update": true parameter in the payload. See the payload samples below for examples.
For an example of how logging a credit works in the UI, take a look at our Credits article.
Database
For information regarding credit transaction database tables, see the following articles:
Database – Line of Credit Credit Transaction (line_of_credit_credit_transaction_entity)
Database – Line of Credit Account (line_of_credit_entity)
{
"LineOfCreditCreditTransactions": {
"results": [
{
"title": "March Credit",
"applyDate": "2023-03-22",
"amount": 10,
"categoryId": 1,
"paymentTypeId": 1,
"status": "lineOfCredit.transactionStatus.active",
"metadata": {
"keyValue": "NewValue"
}
}
]
}
}
{
"LineOfCreditCreditTransactions": {
"results": [
{
"__id": 223,
"__update": true,
"title": "March Promo Credit",
"applyDate": "2023-03-22",
"amount": 10,
"categoryId": 1,
"paymentTypeId": 1,
"status": "lineOfCredit.transactionStatus.active",
"metadata": {
"keyValue": "NewValue"
}
}
]
}
}
{
"LineOfCreditCreditTransactions": {
"results": [
{
"__id": 223,
"__update": true,
"status": "lineOfCredit.transactionStatus.reversed",
"metadata": {
"keyValue": "NewValue"
}
}
]
}
}