Skip to content

Commit d4c482b

Browse files
committed
Update commissions var schema
1 parent 1d2c994 commit d4c482b

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ commtrackr.init({ // Initialize CommTracker with configurations
7575
fields: [
7676
{
7777
id: 'name', // Unique identifier for the field
78-
type: 'text', // Field type (e.g., text, number, date, textarea, checkbox, radio, select)
78+
type: 'text', // Field type ('text', 'number', 'date', 'textarea', 'checkbox', 'radio', 'select')
7979
label: 'Website Name', // Field label
8080
description: 'The name of the website or project.', // Field description
8181
placeholder: 'e.g. My Website', // Placeholder text for the field
@@ -179,9 +179,17 @@ Session Example:
179179
{
180180
id: 'unique-commission-id', // Unique identifier for the commission
181181
client: 'Client Name', // Name of the client
182-
amount: 1000, // Commission amount
182+
amount: 1000, // Commission amount, or null if not applicable
183+
currency: 'USD', // Currency code for the commission amount
183184
date: '2023-10-01', // Date of the commission
184-
status: 'pending' // Status of the commission (e.g., 'pending', 'paid')
185+
status: 'pending', // Status of the commission ('completed', 'in-progress', 'on-hold', 'cancelled')
186+
tasks: [ // Array of tasks associated with the commission
187+
{
188+
done: false, // Task completion status
189+
content: '' // Task description
190+
}
191+
],
192+
tasksLocked: false // Whether tasks are locked from being edited by user
185193
}
186194
]
187195
```

0 commit comments

Comments
 (0)