Skip to content

Commit dbfb379

Browse files
committed
Add send_receipt details in
1 parent 349f035 commit dbfb379

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

pages/balance_updates/create-a-balance-update.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
### Creating a Balance Update
22

33
Creating a Balance Update can be completed by simply supplying the `client`, `credit_amount` and `method` as the
4-
`description` field is optional. The `credit_amount` field must always be a positive value, however if the method is
5-
set to `"correction"` then `credit_amount` can be a negative value.
4+
`description` and `send_receipt` fields are optional. The `credit_amount` field must always be a positive value,
5+
however if the method is set to `"correction"` then `credit_amount` can be a negative value. If `send_receipt` is set
6+
to `True` then the `Payment receipt` email will be sent to the client if the email definition is enabled.
67

78
The possible values for the `method` field are:
89
`cash`, `cheque`, `credit_card`, `transferwise`, `debit_card`, `bank_transfer`, `direct_debit`, `bonus_credit`,

pages/balance_updates/create-a-balance-update.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"credit_amount": 100,
77
"method": "cash",
88
"description": "Client paid by cash.",
9+
"send_receipt": True,
910
}
1011
response = requests.post('https://secure.tutorcruncher.com/api/balance_updates/', json=data, headers=headers)
1112
pprint.pprint(response.json())

0 commit comments

Comments
 (0)