Log a credit

This request logs a credit on a line of credit account.

 Click to learn more about this credits

Credit Transactions

A credit can be applied to a line of credit account. Here's what you need to know about this request:

  • The LineOfCreditCreditTransactions object holds credit information, and it's nested within the LineOfCredits entity.
  • Credits cannot be applied before the account's open date and cannot be applied in previous billing cycles.
  • Credits are applied broadly to a line of credit account instead of being applied to a specific Bucket.
    • 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 Line of Credit – Log a Credit article.

Database

For information regarding credit transaction database tables, see the following articles:

{
    "LineOfCreditCreditTransactions": {
        "results": [
            {
                "title": "March Credit",
                "applyDate": "2023-03-22",
                "amount": 10,
                "categoryId": 1,
                "paymentTypeId": 1,
                "status": "lineOfCredit.transactionStatus.active"
            }
        ]
    }
}
{
    "LineOfCreditCreditTransactions": {
        "results": [
            {
                "__id": 223,
                "__update": true,
                "title": "March Promo Credit",
                "applyDate": "2023-03-22",
                "amount": 10,
                "categoryId": 1,
                "paymentTypeId": 1,
                "status": "lineOfCredit.transactionStatus.active"
            }
        ]
    }
}
{
    "LineOfCreditCreditTransactions": {
        "results": [
            {
                "__id": 223,
                "__update": true,
                "status": "lineOfCredit.transactionStatus.reversed"
            }
        ]
    }
}
Language
Authorization
Click Try It! to start a request and see the response here!