Doc extras

HenryTraill · HenryTraill · commit cee3863c138c · 2025-02-10T10:40:01.000Z
diff --git a/pages/adhoccharges/ad-hoc-charge-object.json b/pages/adhoccharges/ad-hoc-charge-object.json
@@ -4,7 +4,6 @@
   "appointment": null,
   "category": {
     "branch_tax_setup": "Default Company Tax (20%)",
-    "charge_via_branch": true,
     "contractor_tax_setup": "Default Company Tax (20%)",
     "contractor_usable": true,
     "default_charge_amount": "10.00",
diff --git a/pages/adhoccharges/ad-hoc-charge-object.yml b/pages/adhoccharges/ad-hoc-charge-object.yml
@@ -87,10 +87,6 @@ attributes:
         name: branch_tax_setup
         type: string
         description: Tax setup for the Branch when invoicing.
-      -
-        name: charge_via_branch
-        type: boolean
-        description: Force Invoices associated with this Tutor to be charged via branch.
       -
         name: contractor_tax_setup
         type: string
diff --git a/pages/adhoccharges/create-an-ad-hoc-charge.json b/pages/adhoccharges/create-an-ad-hoc-charge.json
@@ -4,7 +4,6 @@
   "appointment": null,
   "category": {
     "branch_tax_setup": "Default Company Tax (20%)",
-    "charge_via_branch": true,
     "contractor_tax_setup": "Default Company Tax (20%)",
     "contractor_usable": true,
     "default_charge_amount": "10.00",
diff --git a/pages/adhoccharges/get-an-ad-hoc-charge.json b/pages/adhoccharges/get-an-ad-hoc-charge.json
@@ -4,7 +4,6 @@
   "appointment": null,
   "category": {
     "branch_tax_setup": "Default Company Tax (20%)",
-    "charge_via_branch": true,
     "contractor_tax_setup": "Default Company Tax (20%)",
     "contractor_usable": true,
     "default_charge_amount": "10.00",
diff --git a/pages/adhoccharges/update-an-ad-hoc-charge.json b/pages/adhoccharges/update-an-ad-hoc-charge.json
@@ -4,7 +4,6 @@
   "appointment": null,
   "category": {
     "branch_tax_setup": "Default Company Tax (20%)",
-    "charge_via_branch": true,
     "contractor_tax_setup": "Default Company Tax (20%)",
     "contractor_usable": true,
     "default_charge_amount": "10.00",
diff --git a/pages/agents/agent-object-v1.yml b/pages/agents/agent-object-v1.yml
@@ -130,23 +130,23 @@ attributes:
 
 filters:
   -
-    name: created__gte
+    name: user__created__gte
     type: string
     description: Filter by the date and time the Agent was created.
   -
-    name: created__lte
+    name: user__created__lte
     type: string
     description: Filter by the date and time the Agent was created.
   -
-    name: first_name
+    name: user__first_name
     type: string
     description: Filter by the Agent's first name.
   -
-    name: last_name
+    name: user__last_name
     type: string
     description: Filter by the Agent's last name.
   -
-    name: email
+    name: user__email
     type: string
     description: Filter by the Agent's email address.
   -
@@ -164,4 +164,4 @@ filters:
   -
     name: labels
     type: integer
-    description: Filter by the Agent's labels.
+    description: Filter by the Agent's labels (id).
diff --git a/pages/agents/agent-object-v2.yml b/pages/agents/agent-object-v2.yml
@@ -125,23 +125,23 @@ attributes:
 
 filters:
   -
-    name: created__gte
+    name: user__created__gte
     type: string
     description: Filter by the date and time the Agent was created.
   -
-    name: created__lte
+    name: user__created__lte
     type: string
     description: Filter by the date and time the Agent was created.
   -
-    name: first_name
+    name: user__first_name
     type: string
     description: Filter by the Agent's first name.
   -
-    name: last_name
+    name: user__last_name
     type: string
     description: Filter by the Agent's last name.
   -
-    name: email
+    name: user__email
     type: string
     description: Filter by the Agent's email address.
   -
@@ -159,4 +159,4 @@ filters:
   -
     name: labels
     type: integer
-    description: Filter by the Agent's labels.
+    description: Filter by the Agent's labels (id).
diff --git a/pages/agents/create-an-agent.py b/pages/agents/create-an-agent.py
@@ -12,8 +12,6 @@
     'town': 'London',
     'country': 183,
     'postcode': 'SW8 1XP',
-    'latitude': '51.5549',
-    'longitude': '-0.1084',
     'timezone': 'Europe/London',
     'commission_rate': 10.1,
     'calendar_colour': 'LimeGreen',
diff --git a/pages/ahc-categories/ad-hoc-charge-category-object.json b/pages/ahc-categories/ad-hoc-charge-category-object.json
@@ -1,6 +1,5 @@
 {
   "branch_tax_setup": "Default Company Tax (20%)",
-  "charge_via_branch": true,
   "contractor_tax_setup": "Default Company Tax (20%)",
   "contractor_usable": true,
   "default_charge_amount": "10.00",
diff --git a/pages/ahc-categories/ad-hoc-charge-category-object.yml b/pages/ahc-categories/ad-hoc-charge-category-object.yml
@@ -11,10 +11,6 @@ attributes:
     name: branch_tax_setup
     type: string
     description: Tax setup for the Branch when invoicing.
-  -
-    name: charge_via_branch
-    type: boolean
-    description: Force Invoices associated with this Tutor to be charged via branch.
   -
     name: contractor_tax_setup
     type: string
diff --git a/pages/ahc-categories/list-all-ad-hoc-charge-categories.json b/pages/ahc-categories/list-all-ad-hoc-charge-categories.json
@@ -5,7 +5,6 @@
   "results": [
     {
       "branch_tax_setup": "Default Company Tax (20%)",
-      "charge_via_branch": true,
       "contractor_tax_setup": "Default Company Tax (20%)",
       "contractor_usable": true,
       "default_charge_amount": "10.00",
diff --git a/pages/clients/client-object-v1.json b/pages/clients/client-object-v1.json
@@ -28,7 +28,6 @@
     "low_balance_reminders",
     "broadcasts"
   ],
-  "charge_via_branch": false,
   "invoices_count": 4,
   "payment_pending": "100.50",
   "auto_charge": true,
diff --git a/pages/clients/client-object-v1.yml b/pages/clients/client-object-v1.yml
@@ -78,10 +78,6 @@ attributes:
     name: received_notifications
     type: array
     description: An array of the Client's received notifications. choices are `broadcasts`, `apt_reminders`, `low_balance_reminders`, `invoice_reminders`, `pfi_reminders`, `invoices`, `credit_requests`
-  -
-    name: charge_via_branch
-    type: boolean
-    description: Force Invoices associated with this Tutor to be charged via branch.
   -
     name: invoices_count
     type: integer
@@ -223,23 +219,23 @@ attributes:
 
 filters:
   -
-    name: created__gte
+    name: user__created__gte
     type: string
     description: Filter by the date and time the Client was created.
   -
-    name: created__lte
+    name: user__created__lte
     type: string
     description: Filter by the date and time the Client was created.
   -
-    name: first_name
+    name: user__first_name
     type: string
     description: Filter by the Client's first name.
   -
-    name: last_name
+    name: user__last_name
     type: string
     description: Filter by the Client's last name.
   -
-    name: email
+    name: user__email
     type: string
     description: Filter by the Client's email address.
   -
diff --git a/pages/clients/client-object-v2.json b/pages/clients/client-object-v2.json
@@ -26,7 +26,6 @@
     "low_balance_reminders",
     "broadcasts"
   ],
-  "charge_via_branch": false,
   "invoices_count": 4,
   "payment_pending": "100.50",
   "auto_charge": true,
diff --git a/pages/clients/client-object-v2.yml b/pages/clients/client-object-v2.yml
@@ -73,10 +73,6 @@ attributes:
     name: received_notifications
     type: array
     description: An array of the Client's received notifications. choices are `broadcasts`, `apt_reminders`, `low_balance_reminders`, `invoice_reminders`, `pfi_reminders`, `invoices`, `credit_requests`
-  -
-    name: charge_via_branch
-    type: boolean
-    description: Force Invoices associated with this Tutor to be charged via branch.
   -
     name: invoices_count
     type: integer
@@ -218,23 +214,23 @@ attributes:
 
 filters:
   -
-    name: created__gte
+    name: user__created__gte
     type: string
     description: Filter by the date and time the Client was created.
   -
-    name: created__lte
+    name: user__created__lte
     type: string
     description: Filter by the date and time the Client was created.
   -
-    name: first_name
+    name: user__first_name
     type: string
     description: Filter by the Client's first name.
   -
-    name: last_name
+    name: user__last_name
     type: string
     description: Filter by the Client's last name.
   -
-    name: email
+    name: user__email
     type: string
     description: Filter by the Client's email address.
   -
diff --git a/pages/clients/create-a-client.json b/pages/clients/create-a-client.json
@@ -26,7 +26,6 @@
     "low_balance_reminders",
     "broadcasts"
   ],
-  "charge_via_branch": false,
   "invoices_count": 4,
   "payment_pending": "100.50",
   "auto_charge": true,
diff --git a/pages/clients/create-a-client.py b/pages/clients/create-a-client.py
@@ -12,8 +12,6 @@
     'town': 'London',
     'country': 183,
     'postcode': 'SW8 1XP',
-    'latitude': '51.5549',
-    'longitude': '-0.1084',
     'timezone': 'Europe/London',
     'status': 'live',
     'is_taxable': False,
diff --git a/pages/clients/get-a-client.json b/pages/clients/get-a-client.json
@@ -26,7 +26,6 @@
     "low_balance_reminders",
     "broadcasts"
     ],
-  "charge_via_branch": false,
   "invoices_count": 4,
   "payment_pending": "100.50",
   "auto_charge": true,
diff --git a/pages/clients/label-add-to-a-client.json b/pages/clients/label-add-to-a-client.json
@@ -26,7 +26,6 @@
     "low_balance_reminders",
     "broadcasts"
     ],
-  "charge_via_branch": false,
   "invoices_count": 4,
   "payment_pending": "100.50",
   "auto_charge": true,
diff --git a/pages/clients/update-a-client.json b/pages/clients/update-a-client.json
@@ -26,7 +26,6 @@
     "low_balance_reminders",
     "broadcasts"
   ],
-  "charge_via_branch": false,
   "invoices_count": 4,
   "payment_pending": "100.50",
   "auto_charge": true,
diff --git a/pages/contractors/contractor-object-v1.json b/pages/contractors/contractor-object-v1.json
@@ -18,7 +18,6 @@
     "timezone": null
   },
   "status": "approved",
-  "charge_via_branch": false,
   "default_rate": null,
   "qualifications": [],
   "skills": [
diff --git a/pages/contractors/contractor-object-v1.yml b/pages/contractors/contractor-object-v1.yml
@@ -70,10 +70,6 @@ attributes:
     name: status
     type: string
     description: The Contractor's status, choices are `pending`, `approved`, `rejected` and `dormant`.
-  -
-    name: charge_via_branch
-    type: boolean
-    description: Force Invoices associated with this Tutor to be charged via branch.
   -
     name: default_rate
     type: decimal
@@ -205,23 +201,23 @@ attributes:
 
 filters:
   -
-    name: created__gte
+    name: user__created__gte
     type: string
     description: Filter by the date and time the Contractor was created.
   -
-    name: created__lte
+    name: user__created__lte
     type: string
     description: Filter by the date and time the Contractor was created.
   -
-    name: first_name
+    name: user__first_name
     type: string
     description: Filter by the Contractor's first name.
   -
-    name: last_name
+    name: user__last_name
     type: string
     description: Filter by the Contractor's last name.
   -
-    name: email
+    name: user__email
     type: string
     description: Filter by the Contractor's email address.
   -
diff --git a/pages/contractors/contractor-object-v2.json b/pages/contractors/contractor-object-v2.json
@@ -14,9 +14,8 @@
   "latitude": "51.5210000000000008",
   "longitude": "-0.1370000000000005",
   "date_created": "2018-11-22T09:23:55.297608Z",
-  "timezone": null
+  "timezone": null,
   "status": "approved",
-  "charge_via_branch": false,
   "default_rate": null,
   "qualifications": [],
   "skills": [
diff --git a/pages/contractors/contractor-object-v2.yml b/pages/contractors/contractor-object-v2.yml
@@ -65,10 +65,6 @@ attributes:
     name: status
     type: string
     description: The Contractor's status, choices are `pending`, `approved`, `rejected` and `dormant`.
-  -
-    name: charge_via_branch
-    type: boolean
-    description: Force Invoices associated with this Tutor to be charged via branch.
   -
     name: default_rate
     type: decimal
@@ -200,23 +196,23 @@ attributes:
 
 filters:
   -
-    name: created__gte
+    name: user__created__gte
     type: string
     description: Filter by the date and time the Contractor was created.
   -
-    name: created__lte
+    name: user__created__lte
     type: string
     description: Filter by the date and time the Contractor was created.
   -
-    name: first_name
+    name: user__first_name
     type: string
     description: Filter by the Contractor's first name.
   -
-    name: last_name
+    name: user__last_name
     type: string
     description: Filter by the Contractor's last name.
   -
-    name: email
+    name: user__email
     type: string
     description: Filter by the Contractor's email address.
   -
diff --git a/pages/contractors/create-a-contractor.json b/pages/contractors/create-a-contractor.json
@@ -16,7 +16,6 @@
   "date_created": "2018-11-22T09:23:55.297608Z",
   "timezone": null,
   "status": "approved",
-  "charge_via_branch": false,
   "default_rate": null,
   "qualifications": [],
   "skills": [
diff --git a/pages/contractors/create-a-contractor.py b/pages/contractors/create-a-contractor.py
diff --git a/pages/contractors/get-a-contractor.json b/pages/contractors/get-a-contractor.json
diff --git a/pages/contractors/label-add-to-a-contractor.json b/pages/contractors/label-add-to-a-contractor.json
diff --git a/pages/contractors/label-remove-from-a-contractor.json b/pages/contractors/label-remove-from-a-contractor.json
diff --git a/pages/contractors/update-a-contractor.json b/pages/contractors/update-a-contractor.json
diff --git a/pages/custom-fields/custom-fields.md b/pages/custom-fields/custom-fields.md
diff --git a/pages/recipients/create-a-recipient.py b/pages/recipients/create-a-recipient.py
diff --git a/pages/versioning/versioning.md b/pages/versioning/versioning.md
diff --git a/pages/webhooks/webhook-object.json b/pages/webhooks/webhook-object.json

Original file line number	Diff line number	Diff line change
`@@ -130,23 +130,23 @@ attributes:`
`130`	`130`
`131`	`131`	`filters:`
`132`	`132`	`-`
`133`		`- name: created__gte`
	`133`	`+ name: user__created__gte`
`134`	`134`	`type: string`
`135`	`135`	`description: Filter by the date and time the Agent was created.`
`136`	`136`	`-`
`137`		`- name: created__lte`
	`137`	`+ name: user__created__lte`
`138`	`138`	`type: string`
`139`	`139`	`description: Filter by the date and time the Agent was created.`
`140`	`140`	`-`
`141`		`- name: first_name`
	`141`	`+ name: user__first_name`
`142`	`142`	`type: string`
`143`	`143`	`description: Filter by the Agent's first name.`
`144`	`144`	`-`
`145`		`- name: last_name`
	`145`	`+ name: user__last_name`
`146`	`146`	`type: string`
`147`	`147`	`description: Filter by the Agent's last name.`
`148`	`148`	`-`
`149`		`- name: email`
	`149`	`+ name: user__email`
`150`	`150`	`type: string`
`151`	`151`	`description: Filter by the Agent's email address.`
`152`	`152`	`-`
`@@ -164,4 +164,4 @@ filters:`
`164`	`164`	`-`
`165`	`165`	`name: labels`
`166`	`166`	`type: integer`
`167`		`- description: Filter by the Agent's labels.`
	`167`	`+ description: Filter by the Agent's labels (id).`
Original file line number	Diff line number	Diff line change
`@@ -125,23 +125,23 @@ attributes:`
`125`	`125`
`126`	`126`	`filters:`
`127`	`127`	`-`
`128`		`- name: created__gte`
	`128`	`+ name: user__created__gte`
`129`	`129`	`type: string`
`130`	`130`	`description: Filter by the date and time the Agent was created.`
`131`	`131`	`-`
`132`		`- name: created__lte`
	`132`	`+ name: user__created__lte`
`133`	`133`	`type: string`
`134`	`134`	`description: Filter by the date and time the Agent was created.`
`135`	`135`	`-`
`136`		`- name: first_name`
	`136`	`+ name: user__first_name`
`137`	`137`	`type: string`
`138`	`138`	`description: Filter by the Agent's first name.`
`139`	`139`	`-`
`140`		`- name: last_name`
	`140`	`+ name: user__last_name`
`141`	`141`	`type: string`
`142`	`142`	`description: Filter by the Agent's last name.`
`143`	`143`	`-`
`144`		`- name: email`
	`144`	`+ name: user__email`
`145`	`145`	`type: string`
`146`	`146`	`description: Filter by the Agent's email address.`
`147`	`147`	`-`
`@@ -159,4 +159,4 @@ filters:`
`159`	`159`	`-`
`160`	`160`	`name: labels`
`161`	`161`	`type: integer`
`162`		`- description: Filter by the Agent's labels.`
	`162`	`+ description: Filter by the Agent's labels (id).`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"branch_tax_setup": "Default Company Tax (20%)",`
`3`		`- "charge_via_branch": true,`
`4`	`3`	`"contractor_tax_setup": "Default Company Tax (20%)",`
`5`	`4`	`"contractor_usable": true,`
`6`	`5`	`"default_charge_amount": "10.00",`