Add a line to a customer's balance (write)
create_balance_lineAdds a one-off debit or credit to a customer's balance without invoicing, enabling custom charges or goodwill credits before billing.
Instructions
WRITE. Creates a line in the balance of a ProAbono customer: a debit when the amount is positive, a credit when it is negative. The amount is in cents, in the Segment's currency. This does not invoice anything -- it puts an amount in the balance, waiting. bill_customer is what turns the balance into an invoice, and the pair is only useful in that order. Use it for a one-off charge or a goodwill credit that the catalogue does not cover.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"customer_ref": "<customer_ref>",
"amount": "<amount>"
},
"name": "create_balance_line"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Value date of a one-off entry, ISO 8601. Exclusive with the period dates. | |
| label | No | Label of the line, shown on the invoice. | |
| amount | Yes | Amount in cents. Positive for a debit, negative for a credit. | |
| quantity | No | Quantity, when the line represents units. | |
| key_charge | No | Related charge key, which is what the tax treatment is derived from. | |
| period_end | No | Period end of a period entry, ISO 8601. Exclusive with date. | |
| customer_ref | Yes | Shared reference of the customer. | |
| period_start | No | Period start of a period entry, ISO 8601. Exclusive with date. | |
| ensure_billable | No | Check the customer can be billed before creating the line. | |
| subscription_id | No | Internal identifier of the subscription this line relates to. |