# Sales Module

# sales-ajax-sale

# Sale – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/ajax-sale/`  
**Model:** Sale  
**Record Name:** Sale  
**Plural Name:** Sales  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale # | Text | A sale's friendly name, used to identify the transaction in receipts, reports, and searches |
| Customer | Relationship (single) | The customer that made this purchase |
| Date Created | Date & time | The date and time that this transaction was started |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this sale |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this sale are sourced |
| Fulfillment Status | Text (choice) | Status information for pending deliveries or shipments for this sale |
| Fulfillment Required | Yes/No (optional) | Marked as false for direct retail sales and service items, marked as true when shipments or deliveries are necessary |
| Payment Status | Text (choice) | Status information for pending payments and/or accounts receivable |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Grosssubtotal Currency | Text (choice) | _TODO_ |
| Non-Discount Subtotal | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted subtotal |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Grosstotal Currency | Text (choice) | _TODO_ |
| Non-Discount Total | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted total |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Paid Currency | Text (choice) | _TODO_ |
| Amount Paid | Number (decimal) | _TODO_ |
| Balance Currency | Text (choice) | _TODO_ |
| Balance | Number (decimal) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |
| Cash Drawer | Relationship (single) (optional) | Links this sale to the cash drawer that it was rung up at |
| Payment Url | Text (optional) | Stores the URL to pay this invoice online |
| Web Payment Received | Yes/No | True/False indicator of if a requested online payment has been received |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-sales](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales)
- **Create View** — [sales-sales-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-create)
- **Detail View** — [sales-sales-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id)
- **Update View** — [sales-sales-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id-update)
- **List View** — [sales-pos-sale-list](https://help.brisksystems.us/books/brisk-documentation/page/sales-pos-sale-list)

---

## Advanced Notes
_TODO_

# sales-cash-drawers-create

# Cash Drawer – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/cash-drawers/create/`  
**Model:** CashDrawer  
**Record Name:** Cash Drawer  
**Plural Name:** Cash Drawers  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Name | Text | _TODO_ |
| Description | Text | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-cash-drawers](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers)
- **Detail View** — [sales-cash-drawers-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers-id)
- **Update View** — [sales-cash-drawers-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers-id-update)

---

## Advanced Notes
_TODO_

# sales-cash-drawers-id-update

# Cash Drawer – Update View

**Module:** Sales  
**Screen Type:** Update View  
**URL:** `/^sales/cash-drawers/<pk>/update/`  
**Model:** CashDrawer  
**Record Name:** Cash Drawer  
**Plural Name:** Cash Drawers  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Name | Text | _TODO_ |
| Description | Text | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-cash-drawers](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers)
- **Create View** — [sales-cash-drawers-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers-create)
- **Detail View** — [sales-cash-drawers-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers-id)

---

## Advanced Notes
_TODO_

# sales-cash-drawers-id

# Cash Drawer – Detail View

**Module:** Sales  
**Screen Type:** Detail View  
**URL:** `/^sales/cash-drawers/<pk>/`  
**Model:** CashDrawer  
**Record Name:** Cash Drawer  
**Plural Name:** Cash Drawers  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Name | Text | _TODO_ |
| Description | Text | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-cash-drawers](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers)
- **Create View** — [sales-cash-drawers-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers-create)
- **Update View** — [sales-cash-drawers-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers-id-update)

---

## Advanced Notes
_TODO_

# sales-cash-drawers

# Cash Drawers – List View

**Module:** Sales  
**Screen Type:** List View  
**URL:** `/^sales/cash-drawers/`  
**Model:** CashDrawer  
**Record Name:** Cash Drawer  
**Plural Name:** Cash Drawers  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Name | Text | _TODO_ |
| Description | Text | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **Create View** — [sales-cash-drawers-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers-create)
- **Detail View** — [sales-cash-drawers-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers-id)
- **Update View** — [sales-cash-drawers-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-cash-drawers-id-update)

---

## Advanced Notes
_TODO_

# sales-discount-periods-create

# Discount Period – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/discount-periods/create/`  
**Model:** DiscountPeriod  
**Record Name:** Discount Period  
**Plural Name:** Discount Periods  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Description | Text | Give a memo or reason for this discount |
| Percent | Number (decimal) | Set the percentage that all items will be discounted for the period of promotion |
| Begin Date | Date | Set the beginning of the discount period |
| End Date | Date | Set the ending of the discount period |
| Cancelled | Yes/No | Use this field to quickly disable a Discount without changing its dates or deleting it |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-discount-periods](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods)
- **Detail View** — [sales-discount-periods-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods-id)
- **Update View** — [sales-discount-periods-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods-id-update)

---

## Advanced Notes
_TODO_

# sales-discount-periods-id-update

# Discount Period – Update View

**Module:** Sales  
**Screen Type:** Update View  
**URL:** `/^sales/discount-periods/<pk>/update/`  
**Model:** DiscountPeriod  
**Record Name:** Discount Period  
**Plural Name:** Discount Periods  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Description | Text | Give a memo or reason for this discount |
| Percent | Number (decimal) | Set the percentage that all items will be discounted for the period of promotion |
| Begin Date | Date | Set the beginning of the discount period |
| End Date | Date | Set the ending of the discount period |
| Cancelled | Yes/No | Use this field to quickly disable a Discount without changing its dates or deleting it |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-discount-periods](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods)
- **Create View** — [sales-discount-periods-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods-create)
- **Detail View** — [sales-discount-periods-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods-id)

---

## Advanced Notes
_TODO_

# sales-discount-periods-id

# Discount Period – Detail View

**Module:** Sales  
**Screen Type:** Detail View  
**URL:** `/^sales/discount-periods/<pk>/`  
**Model:** DiscountPeriod  
**Record Name:** Discount Period  
**Plural Name:** Discount Periods  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Description | Text | Give a memo or reason for this discount |
| Percent | Number (decimal) | Set the percentage that all items will be discounted for the period of promotion |
| Begin Date | Date | Set the beginning of the discount period |
| End Date | Date | Set the ending of the discount period |
| Cancelled | Yes/No | Use this field to quickly disable a Discount without changing its dates or deleting it |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-discount-periods](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods)
- **Create View** — [sales-discount-periods-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods-create)
- **Update View** — [sales-discount-periods-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods-id-update)

---

## Advanced Notes
_TODO_

# sales-discount-periods

# Discount Periods – List View

**Module:** Sales  
**Screen Type:** List View  
**URL:** `/^sales/discount-periods/`  
**Model:** DiscountPeriod  
**Record Name:** Discount Period  
**Plural Name:** Discount Periods  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Description | Text | Give a memo or reason for this discount |
| Percent | Number (decimal) | Set the percentage that all items will be discounted for the period of promotion |
| Begin Date | Date | Set the beginning of the discount period |
| End Date | Date | Set the ending of the discount period |
| Cancelled | Yes/No | Use this field to quickly disable a Discount without changing its dates or deleting it |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **Create View** — [sales-discount-periods-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods-create)
- **Detail View** — [sales-discount-periods-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods-id)
- **Update View** — [sales-discount-periods-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-discount-periods-id-update)

---

## Advanced Notes
_TODO_

# sales-itemrows

# Item Rows – List View

**Module:** Sales  
**Screen Type:** List View  
**URL:** `/^sales/itemrows/`  
**Model:** ItemRow  
**Record Name:** Item Row  
**Plural Name:** Item Rows  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Item | Relationship (single) (optional) | _TODO_ |
| Quantity | Number (decimal) | _TODO_ |
| Uom | Relationship (single) (optional) | _TODO_ |
| Cost Currency | Text (choice) | _TODO_ |
| Cost | Number (decimal) | _TODO_ |
| Price Currency | Text (choice) | _TODO_ |
| Price | Number (decimal) | _TODO_ |
| Totalprice Currency | Text (choice) | _TODO_ |
| Total Price | Number (decimal) | _TODO_ |
| Description | Long text | Enter the item description here |
| Tax Category | Relationship (single) | _TODO_ |
| Taxamount Currency | Text (choice) (optional) | _TODO_ |
| Tax Amount | Number (decimal) (optional) | _TODO_ |
| Sale Link | Relationship (single) (optional) | _TODO_ |
| Consumed | Yes/No | _TODO_ |
| Contract # | Relationship (single) (optional) | Records the item contract associated with this line item |
| Manufacturing Instance | Relationship (single) (optional) | Links this line item to the manufacturing instance that created it, if applicable |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens


---

## Advanced Notes
_TODO_

# sales-payouts-create

# Payout – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/payouts/create/`  
**Model:** Payout  
**Record Name:** Payout  
**Plural Name:** Payouts  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Amount Currency | Text (choice) | _TODO_ |
| Amount | Number (decimal) | _TODO_ |
| Employee | Relationship (single) | The employee that performed this payout |
| Memo | Long text | Reason/information as to why this money was taken from the register |
| Processed | Yes/No | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-payouts](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts)
- **Detail View** — [sales-payouts-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts-id)
- **Update View** — [sales-payouts-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts-id-update)

---

## Advanced Notes
_TODO_

# sales-payouts-id-update

# Payout – Update View

**Module:** Sales  
**Screen Type:** Update View  
**URL:** `/^sales/payouts/<pk>/update/`  
**Model:** Payout  
**Record Name:** Payout  
**Plural Name:** Payouts  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Amount Currency | Text (choice) | _TODO_ |
| Amount | Number (decimal) | _TODO_ |
| Employee | Relationship (single) | The employee that performed this payout |
| Memo | Long text | Reason/information as to why this money was taken from the register |
| Processed | Yes/No | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-payouts](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts)
- **Create View** — [sales-payouts-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts-create)
- **Detail View** — [sales-payouts-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts-id)

---

## Advanced Notes
_TODO_

# sales-payouts-id

# Payout – Detail View

**Module:** Sales  
**Screen Type:** Detail View  
**URL:** `/^sales/payouts/<pk>/`  
**Model:** Payout  
**Record Name:** Payout  
**Plural Name:** Payouts  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Amount Currency | Text (choice) | _TODO_ |
| Amount | Number (decimal) | _TODO_ |
| Employee | Relationship (single) | The employee that performed this payout |
| Memo | Long text | Reason/information as to why this money was taken from the register |
| Processed | Yes/No | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-payouts](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts)
- **Create View** — [sales-payouts-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts-create)
- **Update View** — [sales-payouts-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts-id-update)

---

## Advanced Notes
_TODO_

# sales-payouts

# Payouts – List View

**Module:** Sales  
**Screen Type:** List View  
**URL:** `/^sales/payouts/`  
**Model:** Payout  
**Record Name:** Payout  
**Plural Name:** Payouts  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Amount Currency | Text (choice) | _TODO_ |
| Amount | Number (decimal) | _TODO_ |
| Employee | Relationship (single) | The employee that performed this payout |
| Memo | Long text | Reason/information as to why this money was taken from the register |
| Processed | Yes/No | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **Create View** — [sales-payouts-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts-create)
- **Detail View** — [sales-payouts-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts-id)
- **Update View** — [sales-payouts-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-payouts-id-update)

---

## Advanced Notes
_TODO_

# sales-pos-sale-list

# Sales – List View

**Module:** Sales  
**Screen Type:** List View  
**URL:** `/^sales/pos-sale-list/`  
**Model:** Sale  
**Record Name:** Sale  
**Plural Name:** Sales  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale # | Text | A sale's friendly name, used to identify the transaction in receipts, reports, and searches |
| Customer | Relationship (single) | The customer that made this purchase |
| Date Created | Date & time | The date and time that this transaction was started |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this sale |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this sale are sourced |
| Fulfillment Status | Text (choice) | Status information for pending deliveries or shipments for this sale |
| Fulfillment Required | Yes/No (optional) | Marked as false for direct retail sales and service items, marked as true when shipments or deliveries are necessary |
| Payment Status | Text (choice) | Status information for pending payments and/or accounts receivable |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Grosssubtotal Currency | Text (choice) | _TODO_ |
| Non-Discount Subtotal | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted subtotal |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Grosstotal Currency | Text (choice) | _TODO_ |
| Non-Discount Total | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted total |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Paid Currency | Text (choice) | _TODO_ |
| Amount Paid | Number (decimal) | _TODO_ |
| Balance Currency | Text (choice) | _TODO_ |
| Balance | Number (decimal) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |
| Cash Drawer | Relationship (single) (optional) | Links this sale to the cash drawer that it was rung up at |
| Payment Url | Text (optional) | Stores the URL to pay this invoice online |
| Web Payment Received | Yes/No | True/False indicator of if a requested online payment has been received |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-sales](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales)
- **Create View** — [sales-sales-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-create)
- **Detail View** — [sales-sales-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id)
- **Update View** — [sales-sales-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id-update)
- **Create View** — [sales-ajax-sale](https://help.brisksystems.us/books/brisk-documentation/page/sales-ajax-sale)

---

## Advanced Notes
_TODO_

# sales-quotes-convert

# Quoted Sale – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/quotes/convert/`  
**Model:** QuotedSale  
**Record Name:** Quoted Sale  
**Plural Name:** Quoted Sales  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale # | Text | A sale's friendly name, used to identify the transaction in receipts, reports, and searches |
| Customer | Relationship (single) | The customer that made this purchase |
| Date Created | Date & time | The date and time that this transaction was started |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this sale |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this sale are sourced |
| Fulfillment Status | Text (choice) | Status information for pending deliveries or shipments for this sale |
| Fulfillment Required | Yes/No (optional) | Marked as false for direct retail sales and service items, marked as true when shipments or deliveries are necessary |
| Payment Status | Text (choice) | Status information for pending payments and/or accounts receivable |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Grosssubtotal Currency | Text (choice) | _TODO_ |
| Non-Discount Subtotal | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted subtotal |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Grosstotal Currency | Text (choice) | _TODO_ |
| Non-Discount Total | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted total |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Paid Currency | Text (choice) | _TODO_ |
| Amount Paid | Number (decimal) | _TODO_ |
| Balance Currency | Text (choice) | _TODO_ |
| Balance | Number (decimal) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |
| Cash Drawer | Relationship (single) (optional) | Links this sale to the cash drawer that it was rung up at |
| Payment Url | Text (optional) | Stores the URL to pay this invoice online |
| Web Payment Received | Yes/No | True/False indicator of if a requested online payment has been received |
| Sale Ptr | Relationship (one-to-one) | _TODO_ |
| Quote | Relationship (single) | Connects this Invoice to its source Quote |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens


---

## Advanced Notes
_TODO_

# sales-quotes-create

# Quote – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/quotes/create/`  
**Model:** Quote  
**Record Name:** Quote  
**Plural Name:** Quotes  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Quote # | Text | A quote's friendly name, used to identify the transaction in lists, reports, and searches |
| Customer | Relationship (single) | The customer that will be receiving this quote |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this quote |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this quote would be sourced |
| Status | Text (choice) | _TODO_ |
| Memo | Long text | An optional field to record notes and other information about this quote |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Converted | Yes/No | Marks this quote as conerted to an invoice and completed |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-quotes](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes)
- **Detail View** — [sales-quotes-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes-id)
- **Update View** — [sales-quotes-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes-id-update)

---

## Advanced Notes
_TODO_

# sales-quotes-id-update

# Quote – Update View

**Module:** Sales  
**Screen Type:** Update View  
**URL:** `/^sales/quotes/<pk>/update/`  
**Model:** Quote  
**Record Name:** Quote  
**Plural Name:** Quotes  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Quote # | Text | A quote's friendly name, used to identify the transaction in lists, reports, and searches |
| Customer | Relationship (single) | The customer that will be receiving this quote |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this quote |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this quote would be sourced |
| Status | Text (choice) | _TODO_ |
| Memo | Long text | An optional field to record notes and other information about this quote |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Converted | Yes/No | Marks this quote as conerted to an invoice and completed |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-quotes](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes)
- **Create View** — [sales-quotes-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes-create)
- **Detail View** — [sales-quotes-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes-id)

---

## Advanced Notes
_TODO_

# sales-quotes-id

# Quote – Detail View

**Module:** Sales  
**Screen Type:** Detail View  
**URL:** `/^sales/quotes/<pk>/`  
**Model:** Quote  
**Record Name:** Quote  
**Plural Name:** Quotes  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Quote # | Text | A quote's friendly name, used to identify the transaction in lists, reports, and searches |
| Customer | Relationship (single) | The customer that will be receiving this quote |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this quote |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this quote would be sourced |
| Status | Text (choice) | _TODO_ |
| Memo | Long text | An optional field to record notes and other information about this quote |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Converted | Yes/No | Marks this quote as conerted to an invoice and completed |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-quotes](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes)
- **Create View** — [sales-quotes-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes-create)
- **Update View** — [sales-quotes-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes-id-update)

---

## Advanced Notes
_TODO_

# sales-quotes

# Quotes – List View

**Module:** Sales  
**Screen Type:** List View  
**URL:** `/^sales/quotes/`  
**Model:** Quote  
**Record Name:** Quote  
**Plural Name:** Quotes  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Quote # | Text | A quote's friendly name, used to identify the transaction in lists, reports, and searches |
| Customer | Relationship (single) | The customer that will be receiving this quote |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this quote |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this quote would be sourced |
| Status | Text (choice) | _TODO_ |
| Memo | Long text | An optional field to record notes and other information about this quote |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Converted | Yes/No | Marks this quote as conerted to an invoice and completed |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **Create View** — [sales-quotes-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes-create)
- **Detail View** — [sales-quotes-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes-id)
- **Update View** — [sales-quotes-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-quotes-id-update)

---

## Advanced Notes
_TODO_

# sales-returns-create

# Return – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/returns/create/`  
**Model:** Return  
**Record Name:** Return  
**Plural Name:** Returns  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale | Relationship (single) (optional) | _TODO_ |
| Date Created | Date & time | _TODO_ |
| Moneyback Currency | Text (choice) | _TODO_ |
| Balance To Refund | Number (decimal) | _TODO_ |
| Taxback Currency | Text (choice) | _TODO_ |
| Tax To Refund | Number (decimal) | _TODO_ |
| Restockfee Currency | Text (choice) | _TODO_ |
| Restocking Fee | Number (decimal) | _TODO_ |
| Totaldue Currency | Text (choice) (optional) | _TODO_ |
| Total To Refund | Number (decimal) (optional) | _TODO_ |
| Refund Status | Text (choice) (optional) | _TODO_ |
| Totalback Currency | Text (choice) (optional) | _TODO_ |
| Total Refunded | Number (decimal) (optional) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-returns](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns)
- **Detail View** — [sales-returns-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns-id)
- **Update View** — [sales-returns-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns-id-update)

---

## Advanced Notes
_TODO_

# sales-returns-id-update

# Return – Update View

**Module:** Sales  
**Screen Type:** Update View  
**URL:** `/^sales/returns/<pk>/update/`  
**Model:** Return  
**Record Name:** Return  
**Plural Name:** Returns  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale | Relationship (single) (optional) | _TODO_ |
| Date Created | Date & time | _TODO_ |
| Moneyback Currency | Text (choice) | _TODO_ |
| Balance To Refund | Number (decimal) | _TODO_ |
| Taxback Currency | Text (choice) | _TODO_ |
| Tax To Refund | Number (decimal) | _TODO_ |
| Restockfee Currency | Text (choice) | _TODO_ |
| Restocking Fee | Number (decimal) | _TODO_ |
| Totaldue Currency | Text (choice) (optional) | _TODO_ |
| Total To Refund | Number (decimal) (optional) | _TODO_ |
| Refund Status | Text (choice) (optional) | _TODO_ |
| Totalback Currency | Text (choice) (optional) | _TODO_ |
| Total Refunded | Number (decimal) (optional) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-returns](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns)
- **Create View** — [sales-returns-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns-create)
- **Detail View** — [sales-returns-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns-id)

---

## Advanced Notes
_TODO_

# sales-returns-id

# Return – Detail View

**Module:** Sales  
**Screen Type:** Detail View  
**URL:** `/^sales/returns/<pk>/`  
**Model:** Return  
**Record Name:** Return  
**Plural Name:** Returns  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale | Relationship (single) (optional) | _TODO_ |
| Date Created | Date & time | _TODO_ |
| Moneyback Currency | Text (choice) | _TODO_ |
| Balance To Refund | Number (decimal) | _TODO_ |
| Taxback Currency | Text (choice) | _TODO_ |
| Tax To Refund | Number (decimal) | _TODO_ |
| Restockfee Currency | Text (choice) | _TODO_ |
| Restocking Fee | Number (decimal) | _TODO_ |
| Totaldue Currency | Text (choice) (optional) | _TODO_ |
| Total To Refund | Number (decimal) (optional) | _TODO_ |
| Refund Status | Text (choice) (optional) | _TODO_ |
| Totalback Currency | Text (choice) (optional) | _TODO_ |
| Total Refunded | Number (decimal) (optional) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-returns](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns)
- **Create View** — [sales-returns-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns-create)
- **Update View** — [sales-returns-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns-id-update)

---

## Advanced Notes
_TODO_

# sales-returns

# Returns – List View

**Module:** Sales  
**Screen Type:** List View  
**URL:** `/^sales/returns/`  
**Model:** Return  
**Record Name:** Return  
**Plural Name:** Returns  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale | Relationship (single) (optional) | _TODO_ |
| Date Created | Date & time | _TODO_ |
| Moneyback Currency | Text (choice) | _TODO_ |
| Balance To Refund | Number (decimal) | _TODO_ |
| Taxback Currency | Text (choice) | _TODO_ |
| Tax To Refund | Number (decimal) | _TODO_ |
| Restockfee Currency | Text (choice) | _TODO_ |
| Restocking Fee | Number (decimal) | _TODO_ |
| Totaldue Currency | Text (choice) (optional) | _TODO_ |
| Total To Refund | Number (decimal) (optional) | _TODO_ |
| Refund Status | Text (choice) (optional) | _TODO_ |
| Totalback Currency | Text (choice) (optional) | _TODO_ |
| Total Refunded | Number (decimal) (optional) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **Create View** — [sales-returns-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns-create)
- **Detail View** — [sales-returns-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns-id)
- **Update View** — [sales-returns-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-returns-id-update)

---

## Advanced Notes
_TODO_

# sales-sales-create

# Sale – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/sales/create/`  
**Model:** Sale  
**Record Name:** Sale  
**Plural Name:** Sales  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale # | Text | A sale's friendly name, used to identify the transaction in receipts, reports, and searches |
| Customer | Relationship (single) | The customer that made this purchase |
| Date Created | Date & time | The date and time that this transaction was started |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this sale |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this sale are sourced |
| Fulfillment Status | Text (choice) | Status information for pending deliveries or shipments for this sale |
| Fulfillment Required | Yes/No (optional) | Marked as false for direct retail sales and service items, marked as true when shipments or deliveries are necessary |
| Payment Status | Text (choice) | Status information for pending payments and/or accounts receivable |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Grosssubtotal Currency | Text (choice) | _TODO_ |
| Non-Discount Subtotal | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted subtotal |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Grosstotal Currency | Text (choice) | _TODO_ |
| Non-Discount Total | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted total |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Paid Currency | Text (choice) | _TODO_ |
| Amount Paid | Number (decimal) | _TODO_ |
| Balance Currency | Text (choice) | _TODO_ |
| Balance | Number (decimal) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |
| Cash Drawer | Relationship (single) (optional) | Links this sale to the cash drawer that it was rung up at |
| Payment Url | Text (optional) | Stores the URL to pay this invoice online |
| Web Payment Received | Yes/No | True/False indicator of if a requested online payment has been received |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-sales](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales)
- **Detail View** — [sales-sales-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id)
- **Update View** — [sales-sales-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id-update)
- **List View** — [sales-pos-sale-list](https://help.brisksystems.us/books/brisk-documentation/page/sales-pos-sale-list)
- **Create View** — [sales-ajax-sale](https://help.brisksystems.us/books/brisk-documentation/page/sales-ajax-sale)

---

## Advanced Notes
_TODO_

# sales-sales-id-update

# Sale – Update View

**Module:** Sales  
**Screen Type:** Update View  
**URL:** `/^sales/sales/<pk>/update/`  
**Model:** Sale  
**Record Name:** Sale  
**Plural Name:** Sales  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale # | Text | A sale's friendly name, used to identify the transaction in receipts, reports, and searches |
| Customer | Relationship (single) | The customer that made this purchase |
| Date Created | Date & time | The date and time that this transaction was started |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this sale |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this sale are sourced |
| Fulfillment Status | Text (choice) | Status information for pending deliveries or shipments for this sale |
| Fulfillment Required | Yes/No (optional) | Marked as false for direct retail sales and service items, marked as true when shipments or deliveries are necessary |
| Payment Status | Text (choice) | Status information for pending payments and/or accounts receivable |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Grosssubtotal Currency | Text (choice) | _TODO_ |
| Non-Discount Subtotal | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted subtotal |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Grosstotal Currency | Text (choice) | _TODO_ |
| Non-Discount Total | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted total |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Paid Currency | Text (choice) | _TODO_ |
| Amount Paid | Number (decimal) | _TODO_ |
| Balance Currency | Text (choice) | _TODO_ |
| Balance | Number (decimal) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |
| Cash Drawer | Relationship (single) (optional) | Links this sale to the cash drawer that it was rung up at |
| Payment Url | Text (optional) | Stores the URL to pay this invoice online |
| Web Payment Received | Yes/No | True/False indicator of if a requested online payment has been received |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-sales](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales)
- **Create View** — [sales-sales-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-create)
- **Detail View** — [sales-sales-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id)
- **List View** — [sales-pos-sale-list](https://help.brisksystems.us/books/brisk-documentation/page/sales-pos-sale-list)
- **Create View** — [sales-ajax-sale](https://help.brisksystems.us/books/brisk-documentation/page/sales-ajax-sale)

---

## Advanced Notes
_TODO_

# sales-sales-id

# Sale – Detail View

**Module:** Sales  
**Screen Type:** Detail View  
**URL:** `/^sales/sales/<pk>/`  
**Model:** Sale  
**Record Name:** Sale  
**Plural Name:** Sales  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale # | Text | A sale's friendly name, used to identify the transaction in receipts, reports, and searches |
| Customer | Relationship (single) | The customer that made this purchase |
| Date Created | Date & time | The date and time that this transaction was started |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this sale |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this sale are sourced |
| Fulfillment Status | Text (choice) | Status information for pending deliveries or shipments for this sale |
| Fulfillment Required | Yes/No (optional) | Marked as false for direct retail sales and service items, marked as true when shipments or deliveries are necessary |
| Payment Status | Text (choice) | Status information for pending payments and/or accounts receivable |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Grosssubtotal Currency | Text (choice) | _TODO_ |
| Non-Discount Subtotal | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted subtotal |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Grosstotal Currency | Text (choice) | _TODO_ |
| Non-Discount Total | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted total |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Paid Currency | Text (choice) | _TODO_ |
| Amount Paid | Number (decimal) | _TODO_ |
| Balance Currency | Text (choice) | _TODO_ |
| Balance | Number (decimal) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |
| Cash Drawer | Relationship (single) (optional) | Links this sale to the cash drawer that it was rung up at |
| Payment Url | Text (optional) | Stores the URL to pay this invoice online |
| Web Payment Received | Yes/No | True/False indicator of if a requested online payment has been received |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-sales](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales)
- **Create View** — [sales-sales-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-create)
- **Update View** — [sales-sales-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id-update)
- **List View** — [sales-pos-sale-list](https://help.brisksystems.us/books/brisk-documentation/page/sales-pos-sale-list)
- **Create View** — [sales-ajax-sale](https://help.brisksystems.us/books/brisk-documentation/page/sales-ajax-sale)

---

## Advanced Notes
_TODO_

# sales-sales

# Sales – List View

**Module:** Sales  
**Screen Type:** List View  
**URL:** `/^sales/sales/`  
**Model:** Sale  
**Record Name:** Sale  
**Plural Name:** Sales  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale # | Text | A sale's friendly name, used to identify the transaction in receipts, reports, and searches |
| Customer | Relationship (single) | The customer that made this purchase |
| Date Created | Date & time | The date and time that this transaction was started |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this sale |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this sale are sourced |
| Fulfillment Status | Text (choice) | Status information for pending deliveries or shipments for this sale |
| Fulfillment Required | Yes/No (optional) | Marked as false for direct retail sales and service items, marked as true when shipments or deliveries are necessary |
| Payment Status | Text (choice) | Status information for pending payments and/or accounts receivable |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Grosssubtotal Currency | Text (choice) | _TODO_ |
| Non-Discount Subtotal | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted subtotal |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Grosstotal Currency | Text (choice) | _TODO_ |
| Non-Discount Total | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted total |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Paid Currency | Text (choice) | _TODO_ |
| Amount Paid | Number (decimal) | _TODO_ |
| Balance Currency | Text (choice) | _TODO_ |
| Balance | Number (decimal) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |
| Cash Drawer | Relationship (single) (optional) | Links this sale to the cash drawer that it was rung up at |
| Payment Url | Text (optional) | Stores the URL to pay this invoice online |
| Web Payment Received | Yes/No | True/False indicator of if a requested online payment has been received |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **Create View** — [sales-sales-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-create)
- **Detail View** — [sales-sales-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id)
- **Update View** — [sales-sales-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-sales-id-update)
- **List View** — [sales-pos-sale-list](https://help.brisksystems.us/books/brisk-documentation/page/sales-pos-sale-list)
- **Create View** — [sales-ajax-sale](https://help.brisksystems.us/books/brisk-documentation/page/sales-ajax-sale)

---

## Advanced Notes
_TODO_

# sales-subscriptions-bill

# Recurring Sale – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/subscriptions/bill/`  
**Model:** RecurringSale  
**Record Name:** Recurring Sale  
**Plural Name:** Recurring Sales  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Sale # | Text | A sale's friendly name, used to identify the transaction in receipts, reports, and searches |
| Customer | Relationship (single) | The customer that made this purchase |
| Date Created | Date & time | The date and time that this transaction was started |
| Salesperson | Relationship (single) (optional) | The salesperson assigned to this sale |
| Warehouse | Relationship (single) (optional) | The physical location from which inventory items for this sale are sourced |
| Fulfillment Status | Text (choice) | Status information for pending deliveries or shipments for this sale |
| Fulfillment Required | Yes/No (optional) | Marked as false for direct retail sales and service items, marked as true when shipments or deliveries are necessary |
| Payment Status | Text (choice) | Status information for pending payments and/or accounts receivable |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Customer Po # | Text | An optional field to make note of the customer's purchase order number |
| Grosssubtotal Currency | Text (choice) | _TODO_ |
| Non-Discount Subtotal | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted subtotal |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Grosstotal Currency | Text (choice) | _TODO_ |
| Non-Discount Total | Number (decimal) | If a cash discount is applied to the ticket, this field represents the original, undiscounted total |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |
| Paid Currency | Text (choice) | _TODO_ |
| Amount Paid | Number (decimal) | _TODO_ |
| Balance Currency | Text (choice) | _TODO_ |
| Balance | Number (decimal) | _TODO_ |
| Edit Locked | Yes/No | _TODO_ |
| Cash Drawer | Relationship (single) (optional) | Links this sale to the cash drawer that it was rung up at |
| Payment Url | Text (optional) | Stores the URL to pay this invoice online |
| Web Payment Received | Yes/No | True/False indicator of if a requested online payment has been received |
| Sale Ptr | Relationship (one-to-one) | _TODO_ |
| Subscription | Relationship (single) | Connects this Recurring Sale to its source subscription |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens


---

## Advanced Notes
_TODO_

# sales-subscriptions-create

# Subscription – Create View

**Module:** Sales  
**Screen Type:** Create View  
**URL:** `/^sales/subscriptions/create/`  
**Model:** Subscription  
**Record Name:** Subscription  
**Plural Name:** Subscriptions  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Label | Text | A label to identify this subscription in the business |
| Frequency | Text (choice) | Determines the frequency with which a subscription should occur |
| Customer | Relationship (single) | The customer that made this purchase |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-subscriptions](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions)
- **Detail View** — [sales-subscriptions-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions-id)
- **Update View** — [sales-subscriptions-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions-id-update)

---

## Advanced Notes
_TODO_

# sales-subscriptions-id-update

# Subscription – Update View

**Module:** Sales  
**Screen Type:** Update View  
**URL:** `/^sales/subscriptions/<pk>/update/`  
**Model:** Subscription  
**Record Name:** Subscription  
**Plural Name:** Subscriptions  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Label | Text | A label to identify this subscription in the business |
| Frequency | Text (choice) | Determines the frequency with which a subscription should occur |
| Customer | Relationship (single) | The customer that made this purchase |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-subscriptions](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions)
- **Create View** — [sales-subscriptions-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions-create)
- **Detail View** — [sales-subscriptions-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions-id)

---

## Advanced Notes
_TODO_

# sales-subscriptions-id

# Subscription – Detail View

**Module:** Sales  
**Screen Type:** Detail View  
**URL:** `/^sales/subscriptions/<pk>/`  
**Model:** Subscription  
**Record Name:** Subscription  
**Plural Name:** Subscriptions  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Label | Text | A label to identify this subscription in the business |
| Frequency | Text (choice) | Determines the frequency with which a subscription should occur |
| Customer | Relationship (single) | The customer that made this purchase |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **List View** — [sales-subscriptions](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions)
- **Create View** — [sales-subscriptions-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions-create)
- **Update View** — [sales-subscriptions-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions-id-update)

---

## Advanced Notes
_TODO_

# sales-subscriptions

# Subscriptions – List View

**Module:** Sales  
**Screen Type:** List View  
**URL:** `/^sales/subscriptions/`  
**Model:** Subscription  
**Record Name:** Subscription  
**Plural Name:** Subscriptions  

---

## What This Screen Is For
_TODO: Explain what this screen does in plain language._

---

## What You See on This Screen
📸 _Add a screenshot of this screen._

## Fields on This Screen

| Field | Type | Description |
|------|------|------------|
| Last Modified At | Date & time | _TODO_ |
| Last Modified By | Relationship (single) (optional) | _TODO_ |
| Label | Text | A label to identify this subscription in the business |
| Frequency | Text (choice) | Determines the frequency with which a subscription should occur |
| Customer | Relationship (single) | The customer that made this purchase |
| Memo | Long text | An open text field for employees to make notes about this transaction |
| Subtotal Currency | Text (choice) | _TODO_ |
| Subtotal | Number (decimal) | The total sales price of all line items before sales tax |
| Taxtotal Currency | Text (choice) | _TODO_ |
| Tax Total | Number (decimal) | The total sales tax due for this sale |
| Total Currency | Text (choice) | _TODO_ |
| Total | Number (decimal) | _TODO_ |

## System Fields (Managed Automatically)

⚙️ These fields are managed by the system and usually do not need to be edited.

| Field | Type | Description |
|------|------|------------|
| Id | Auto number (ID) | _TODO_ |
| Created At | Date & time | _TODO_ |
| Created By | Relationship (single) (optional) | _TODO_ |
| Custom Fields | Extra Fields JSONField | _TODO_ |
| Deleted At | Date & time (optional) | _TODO_ |

---

## Common Tasks
- _TODO_

---

## Tips & Helpful Hints
💡 _TODO_

---

## Who Uses This Screen
- _TODO_

## Related Screens

- **Create View** — [sales-subscriptions-create](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions-create)
- **Detail View** — [sales-subscriptions-id](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions-id)
- **Update View** — [sales-subscriptions-id-update](https://help.brisksystems.us/books/brisk-documentation/page/sales-subscriptions-id-update)

---

## Advanced Notes
_TODO_