Record a deposit received
deposit_recordRecord a security or retainer deposit received from a client, in minor units, with its currency, the date it arrived and the bank reference. Returns the DEP-YYYY-NNNN id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | security: held against damage or non-payment. retainer: held against work not yet invoiced | |
| notes | No | Free text kept on the record and printed on the statement | |
| client | Yes | Client name or client id. A name the invoice server already knows brings its address, email and VAT id onto the deposit | |
| currency | No | Defaults to your business default currency | |
| reference | No | Bank reference, transfer note or cheque number the money arrived with | |
| amount_minor | Yes | What was received, in MINOR units: 50000 = 500.00 EUR, 50000 = JPY 50000. Never a decimal | |
| client_email | No | Only if the user gave it; otherwise the stored client's email is used | |
| client_vat_id | No | Client VAT / tax registration id | |
| received_date | No | YYYY-MM-DD, the day the money arrived. Defaults to today | |
| client_address | No | Postal address for the statement's client block, newlines allowed |