diff --git a/.gitignore b/.gitignore index 698b7c1..640d0bd 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ /env/ .idea /__pycache__/ +.env diff --git a/pages/appointments/create-an-appointment.json b/pages/appointments/create-an-appointment.json index 2cee6c7..ff77dc1 100644 --- a/pages/appointments/create-an-appointment.json +++ b/pages/appointments/create-an-appointment.json @@ -21,7 +21,17 @@ } ], "repeater": null, - "service": 23, + "service": { + "id":23, + "name": "Service 23", + "dft_charge_type": "hourly", + "created": "2019-03-15T17:37:46.829300Z", + "dft_charge_rate": "100.00", + "dft_contractor_rate": "56.00", + "last_updated": "2019-03-15T17:38:02.989696Z", + "status": "available", + "url": "https://secure.tutorcruncher.com/api/services/23/" + }, "status": "planned", "units": "2.00000", "extra_attrs": {} diff --git a/pages/appointments/update-an-appointment.md b/pages/appointments/update-an-appointment.md index 127d15b..ffe5c92 100644 --- a/pages/appointments/update-an-appointment.md +++ b/pages/appointments/update-an-appointment.md @@ -3,4 +3,4 @@ Updating an Appointment is similar to [Creating an Appointment](#create-an-appointment). One major difference is that you cannot add, edit or delete Recipients or Contractors on the Appointment. To do this you must use the endpoints [Add/Edit Recipient on Appointment](#create-update-rcra), [Remove Recipient from Appointment](#remove-rcra), -[Add/Edit Contractor on Appointment](#create-update-cja) or [Remove Contractor from Appointment](#remove-cja). +[Add/Edit Contractor on Appointment](#create-update-cja) or [Remove Contractor from Appointment](#remove-cja). Note that only Appointments with status `Planned` can be updated. diff --git a/pages/creating-updating-users/creating-updating-users.md b/pages/creating-updating-users/creating-updating-users.md index be504fc..15db7c2 100644 --- a/pages/creating-updating-users/creating-updating-users.md +++ b/pages/creating-updating-users/creating-updating-users.md @@ -2,8 +2,8 @@ address as a unique identifier when creating/updating using the API. If you use the email address when creating/updating, we will check for an email address in the user data and check if this user already exists. -You can create a user without an email address, however, you will not be able to update the user. You must also -include the users last name when creating/updating as this field is required. Any other role specific required -fields are specified on the endpoint description. +You can create a user without an email address, but the user's last name is required when creating a new user. +To update an existing user, provide the user's ID as the unique identifier +in the URL. Any additional role-specific required fields are detailed in the endpoint documentation. Profile photos can be optionally added or updated for all user roles — [Agents](#agents), [Clients](#clients), [Contractors](#contractors), and [Recipients](#recipients) — by including a `photo` field with a valid image URL when creating or updating a user. If the image is valid and accessible, it will be downloaded, processed into thumbnails, and included in the response. If the `photo` field is omitted during an update, the current photo remains unchanged. To remove an existing photo, set the `photo` field to `null`. Invalid, corrupted, or inaccessible image URLs will result in a `400 Bad Request` with an appropriate error message. diff --git a/pages/invoices/take-invoice-payment.json b/pages/invoices/take-invoice-payment.json index f9e4411..e17142d 100644 --- a/pages/invoices/take-invoice-payment.json +++ b/pages/invoices/take-invoice-payment.json @@ -3,5 +3,6 @@ "amount_paid": "100.00", "still_to_pay": "185.00", "message": "Payment successfully created", - "paid": false + "paid": true, + "method": "cash" } diff --git a/pages/invoices/take-invoice-payment.md b/pages/invoices/take-invoice-payment.md index 74441ea..7ec8635 100644 --- a/pages/invoices/take-invoice-payment.md +++ b/pages/invoices/take-invoice-payment.md @@ -2,4 +2,6 @@ Pay partially or pay in full, post how much the Client paid towards the Invoice and we'll return how much there is `still_to_pay`. If fully paid off, `paid` will return a value of `true`. Any excess will be set in the Client's -Available Balance on their TutorCruncher profile. +Available Balance on their TutorCruncher profile. The `method` parameter specifies the offline payment method. +Available options are: `cash`, `cheque`, `credit_card`, `transferwise`, `debit_card`, `bank_transfer`, `direct_debit`, +`bonus_credit`, `manual`, and `voucher`. diff --git a/pages/proforma-invoices/take-proforma-invoice-payment.json b/pages/proforma-invoices/take-proforma-invoice-payment.json index f9e4411..ba13e57 100644 --- a/pages/proforma-invoices/take-proforma-invoice-payment.json +++ b/pages/proforma-invoices/take-proforma-invoice-payment.json @@ -3,5 +3,5 @@ "amount_paid": "100.00", "still_to_pay": "185.00", "message": "Payment successfully created", - "paid": false + "paid": true }