Log a charge

This request creates a charge on a line of credit account.

   Click here to learn more about this request

A charge can be applied to a line of credit account:

• The LineOfCreditCharges object holds charges information, and it's nested within the LineOfCredits entity.
• Charges cannot be applied to previous billing cycles—only current and future billing cycles.
• Charges are routed to a specific Bucket, which is associated to a line of credit account.
• Charges can also be edited and reversed. To do so, include the ID of the charge and the "__update": true parameter in the payload. See the payload samples below for examples.

For an example of how logging a charge works in the UI, take a look at our Line of Credit – Log a Charge article.

Database

For information regarding line of credit charge database tables, see the following articles:

• Database – Line of Credit Charges (line_of_credit_charge_entity)
• Database – Line of Credit Recurring Charges (line_of_credit_recurring_charge_entity)
• Database – Line of Credit Account (line_of_credit_entity)

Log a Charge

{
    "LineOfCreditCharges": {
        "results": [
            {
                "amount": 25.00,
                "applyDate": "2022-01-24",
                "status": "lineOfCredit.transactionStatus.active",
                "customChargeTypeId": 1,
                "interestBearing": 0,
                "description": "January Charge/Fee",
                "bucketId": 1
            }
        ]
    }
}

Edit a Charge

{
    "LineOfCreditCharges": {
        "results": [
            {
                "__id": 384,
                "__update": true,
                "amount": 50,
                "applyDate": "2023-10-30",
                "status": "lineOfCredit.transactionStatus.active",
                "customChargeTypeId": 1,
                "interestBearing": 0,
                "description": "Late Fee",
                "bucketId": 1
            }
        ]
    }
}

Reverse a Charge

{
    "LineOfCreditCharges": {
        "results": [
            {
                "__id": 384,
                "__update": true,
                "status": "lineOfCredit.transactionStatus.reversed"
            }
        ]
    }
}