### Example WebsiteSettingResult

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Example of WebsiteSettingResult, which returns a JSON object containing website settings.

```json
{"setting": {}}
```

--------------------------------

### Get Interest Filter Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

This example shows the parameters used to filter interest data, including user ID, auction ID, auction ring ID, simulcast round ID, and duration.

```json
{
  "user_id": "4",
  "auction_id": "4",
  "auction_ring_id": 4,
  "simulcast_round_id": 4,
  "duration": 123
}
```

--------------------------------

### SimpleAuction Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

This section provides an example of the payload structure for a SimpleAuction.

```APIDOC
## SimpleAuction Example

### Description
This section provides an example of the payload structure for a SimpleAuction, detailing user interactions and document status within an auction.

### Method
N/A (Example Payload)

### Endpoint
N/A (Example Payload)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **user_id** (integer) - Required - The ID of the user associated with the auction.
- **auction_id** (string) - Required - The ID of the auction.
- **document_id** (integer) - Required - The ID of the document related to the auction.
- **signed** (boolean) - Required - Indicates whether the document has been signed.
- **is_external** (boolean) - Required - Indicates if the auction involves an external party.

### Request Example
```json
{
  "user_id": 4,
  "auction_id": "4",
  "document_id": 4,
  "signed": true,
  "is_external": true
}
```

### Response
#### Success Response (200)
This example illustrates a typical success response structure. The specific fields may vary based on the actual API endpoint.
- **user_id** (integer) - The ID of the user.
- **auction_id** (string) - The ID of the auction.
- **document_id** (integer) - The ID of the document.
- **signed** (boolean) - Status of the document signing.
- **is_external** (boolean) - Indicator for external involvement.

#### Response Example
```json
{
  "user_id": 4,
  "auction_id": "4",
  "document_id": 4,
  "signed": true,
  "is_external": true
}
```
```

--------------------------------

### QuickExpenseFilter Example Data

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

An example JSON object for QuickExpenseFilter, demonstrating how to specify filter criteria.

```json
{
  "apply_to_invoice": false,
  "apply_to_statement": true,
  "quick_expense_ids": [4]
}
```

--------------------------------

### RealEstateBranding Example Data

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

An example JSON object for RealEstateBranding, showing typical values for its fields.

```json
{
  "is_required": true,
  "name": "xyz789",
  "logo": "abc123",
  "logo_alt": "xyz789",
  "link": "xyz789"
}
```

--------------------------------

### _AuctionUnlockPaginationInput Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Provides an example of pagination input for _AuctionUnlock results, using 'page' and 'pageSize'.

```json
{
  "page": 987,
  "pageSize": 987
}
```

--------------------------------

### Example Invoice Filter Structure

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

An illustrative example demonstrating how to construct a query using the InvoiceFiltersInput. This example shows the structure for applying filters based on invoice reference, balance, pickup status, and other relevant criteria.

```json
{
  "and": [InvoiceFiltersInput],
  "or": [InvoiceFiltersInput],
  "invoice_ref": StringFilterOp,
  "invoice_balance": FloatFilterOp,
  "user_drivers_license": StringFilterOp,
  "is_picked_up": BooleanFilterOp,
  "invoice_status": StringFilterOp,
  "is_emailed": BooleanFilterOp,
  "auction_title": StringFilterOp,
  "auctions_won_count": IntFilterOp,
  "pending_payments": IntFilterOp,
  "invoice_payment_status": PaymentStatusFilterEnumFilterOp,
  "payment_past_due": BooleanFilterOp,
  "bidder_number": StringFilterOp,
  "bidder_first_name": StringFilterOp,
  "bidder_last_name": StringFilterOp,
  "bidder_full_name": StringFilterOp,
  "company": StringFilterOp,
  "bidder_email": StringFilterOp,
  "phone": StringFilterOp,
  "not_picked_up_count": IntFilterOp,
  "lot_count": IntFilterOp,
  "invoice_total": FloatFilterOp,
  "bid_total": FloatFilterOp,
  "premium_total": FloatFilterOp,
  "tax_total": FloatFilterOp,
  "all_expense_total": FloatFilterOp,
  "payment_total": FloatFilterOp,
  "returning_buyer": BooleanFilterOp,
  "lot_number": StringFilterOp,
  "created_at": StringFilterOp
}
```

--------------------------------

### CreditCard Input Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Example JSON for a CreditCard object, including user details, card information, and status.

```json
{
  "user_id": "abc123",
  "credit_card_id": 4,
  "description": "xyz789",
  "card_type": "xyz789",
  "card_number": "xyz789",
  "expiration_date": "2007-12-03",
  "first_name": "xyz789",
  "middle_name": "xyz789",
  "last_name": "xyz789",
  "company": "xyz789",
  "is_default": true,
  "card_status": 123,
  "created_at": "2007-12-03T10:15:30Z",
  "deleted_at": "2007-12-03T10:15:30Z",
  "expiration_month": 987,
  "expiration_year": 123,
  "location": Location,
  "user": SimpleUser
}
```

--------------------------------

### GraphQL Response Example for signUrl

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

An example of a successful response from the 'signUrl' GraphQL query, returning the generated signed URL.

```json
{
  "data": {
    "signUrl": "abc123"
  }
}
```

--------------------------------

### GraphQL Response for Invoice Statistics

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Example response from the `invoiceStats` GraphQL query, showing the calculated count and sum of invoices.

```json
{"data": {"invoiceStats": {"count": 123, "sum": 987.65}}}
```

--------------------------------

### UsernameAvailableResult Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

This JSON object shows the expected response when checking username availability. It indicates whether the username is available and provides a reason if it's not.

```json
{
  "available": false,
  "reason": "abc123"
}
```

--------------------------------

### Example Logo Response Structure (JSON)

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

This JSON object represents the structure of a successful response when retrieving logo data. It includes details about attachments, auction information, and asset metadata. The structure is nested and contains various data types.

```json
{
  "data": {
    "logos": [
      {
        "attachment_id": 4,
        "auction_id": "xyz789",
        "auction_ring_id": "4",
        "inventory_id": "abc123",
        "auction_lot_id": "xyz789",
        "affiliate_id": "abc123",
        "item_group_lot_id": "abc123",
        "sublot_id": 4,
        "page_id": "abc123",
        "category_id": "xyz789",
        "dynamic_field_id": "xyz789",
        "user_id": "abc123",
        "invoice_id": "4",
        "title": "abc123",
        "file_name": "abc123",
        "gallery_key": "abc123",
        "asset_metadata": "AttachmentMetadata",
        "storage_details": {},
        "batch_id": 123,
        "url": "abc123",
        "profile": "xyz789",
        "thumb_url": "abc123",
        "order_by": 123,
        "is_protected": false,
        "visibility": "xyz789",
        "is_ready": true,
        "is_primary": true,
        "asset_url": "abc123",
        "asset_url_image_variants": "AssetUrlImageVariants",
        "variant_url": "abc123",
        "folder_id": 4,
        "is_featured": true,
        "created_at": "2007-12-03",
        "deleted_at": "2007-12-03",
        "storage_service": "xyz789",
        "cached_assets": ["CachedAsset"],
        "print_with_invoice": true,
        "default_invoice_copies": 123,
        "document_type": "abc123",
        "categories": ["CategoryDocument"],
        "signatures": ["SimpleSignedDocument"],
        "_evaluation_id": "4"
      }
    ]
  }
}
```

--------------------------------

### Example JSON Response for URL Forwarding Check

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

This JSON object represents the response from a URL forwarding check. It includes details about the forwarding ID, source and destination URLs, type, and timestamps for creation and deletion.

```json
{
  "data": {
    "check_url_forwarding": {
      "url_forwarding_id": "4",
      "from_url": "abc123",
      "to_url": "xyz789",
      "type": 123,
      "created_at": "2007-12-03T10:15:30Z",
      "deleted_at": "2007-12-03T10:15:30Z",
      "affiliate_id": "4"
    }
  }
}
```

--------------------------------

### Auction Queries - Get Auctions

Source: https://context7.com/usaamatahir/freijeapi/llms.txt

Retrieves a paginated list of auctions with filtering and sorting options. Returns auction details including title, dates, status, lot counts, and associated media.

```APIDOC
## GET /api/graphql

### Description
Retrieves a paginated list of auctions with filtering and sorting options.

### Method
GET

### Endpoint
https://www.jeffmartinauctioneers.com/api

### Parameters
#### Query Parameters
None

#### Request Body
```graphql
query auctions(
  $pagination: AuctionPaginationInput,
  $filter: AuctionFilterInput,
  $order: AuctionOrderInput
) {
  auctions(
    pagination: $pagination,
    filter: $filter,
    order: $order
  ) {
    total
    auctions {
      auction_id
      auction_ref
      title
      type
      description
      start_time
      end_time
      prebid_start_time
      prebid_end_time
      public_url
      auction_group
      watch_count
      front_visible_lot_count
      image_tag
      is_visible_on_front
      is_featured
      view_count
      landing_view_count
      auction_status
      lots {
        total
        lots {
          lot_number
          title
          description
          quantity
          reserve_bid
          bid_count
          view_count
          starting_bid
          winning_bidder_id
        }
      }
    }
    custom_fields
  }
}
```

### Request Example
```json
{
  "query": "query auctions($pagination: AuctionPaginationInput, $filter: AuctionFilterInput, $order: AuctionOrderInput) { auctions(pagination: $pagination, filter: $filter, order: $order) { total auctions { auction_id auction_ref title type description start_time end_time prebid_start_time prebid_end_time public_url auction_group watch_count front_visible_lot_count image_tag is_visible_on_front is_featured view_count landing_view_count auction_status lots { total lots { lot_number title description quantity reserve_bid bid_count view_count starting_bid winning_bidder_id } } } custom_fields } }",
  "variables": {
    "pagination": {
      "page": 1,
      "pageSize": 10
    },
    "filter": {
      "type": "online",
      "start_time_from": "2025-01-01"
    },
    "order": {
      "column": "start_time",
      "direction": "ASC"
    }
  }
}
```

### Response
#### Success Response (200)
- **total** (Integer) - The total number of auctions matching the query.
- **auctions** (Array) - An array of auction objects.
  - **auction_id** (String) - The unique identifier for the auction.
  - **auction_ref** (String) - The reference code for the auction.
  - **title** (String) - The title of the auction.
  - **type** (String) - The type of auction (e.g., 'online', 'simulcast').
  - **description** (String) - A detailed description of the auction.
  - **start_time** (String) - The start date and time of the auction.
  - **end_time** (String) - The end date and time of the auction.
  - **prebid_start_time** (String) - The start date and time for pre-bidding.
  - **prebid_end_time** (String) - The end date and time for pre-bidding.
  - **public_url** (String) - The public URL for the auction.
  - **auction_group** (String) - Identifier for auction grouping.
  - **watch_count** (Integer) - Number of users watching the auction.
  - **front_visible_lot_count** (Integer) - Number of lots visible on the front page.
  - **image_tag** (String) - Tag for the auction image.
  - **is_visible_on_front** (Boolean) - Whether the auction is visible on the front page.
  - **is_featured** (Boolean) - Whether the auction is featured.
  - **view_count** (Integer) - Number of views for the auction.
  - **landing_view_count** (Integer) - Number of views on the landing page.
  - **auction_status** (String) - The current status of the auction.
  - **lots** (Object) - Information about the lots in the auction.
    - **total** (Integer) - Total number of lots.
    - **lots** (Array) - Array of lot objects.
      - **lot_number** (String) - The number of the lot.
      - **title** (String) - The title of the lot.
      - **description** (String) - The description of the lot.
      - **quantity** (Integer) - The quantity of the lot.
      - **reserve_bid** (Float) - The reserve bid amount for the lot.
      - **bid_count** (Integer) - The number of bids on the lot.
      - **view_count** (Integer) - The number of views for the lot.
      - **starting_bid** (Float) - The starting bid amount for the lot.
      - **winning_bidder_id** (String) - The ID of the winning bidder.
  - **custom_fields** (Object) - Any custom fields associated with the auction.

#### Response Example
```json
{
  "data": {
    "auctions": {
      "total": 5,
      "auctions": [
        {
          "auction_id": "123",
          "auction_ref": "AUCT-001",
          "title": "Spring Online Auction",
          "type": "online",
          "description": "A curated selection of items for the spring season.",
          "start_time": "2025-03-15T09:00:00Z",
          "end_time": "2025-03-22T17:00:00Z",
          "prebid_start_time": null,
          "prebid_end_time": null,
          "public_url": "https://example.com/auction/123",
          "auction_group": "Spring",
          "watch_count": 150,
          "front_visible_lot_count": 10,
          "image_tag": "img-tag-123",
          "is_visible_on_front": true,
          "is_featured": false,
          "view_count": 5000,
          "landing_view_count": 1200,
          "auction_status": "upcoming",
          "lots": {
            "total": 100,
            "lots": [
              {
                "lot_number": "1",
                "title": "Antique Vase",
                "description": "A beautiful blue ceramic vase.",
                "quantity": 1,
                "reserve_bid": 50.00,
                "bid_count": 5,
                "view_count": 100,
                "starting_bid": 20.00,
                "winning_bidder_id": null
              }
            ]
          },
          "custom_fields": {}
        }
      ],
      "custom_fields": {}
    }
  }
}
```
```

--------------------------------

### Auction Queries - Get Single Auction

Source: https://context7.com/usaamatahir/freijeapi/llms.txt

Retrieves detailed information about a single auction by ID. Returns comprehensive auction data including settings, premiums, commissions, and real estate information.

```APIDOC
## GET /api/graphql

### Description
Retrieves detailed information about a single auction by ID.

### Method
GET

### Endpoint
https://www.jeffmartinauctioneers.com/api

### Parameters
#### Query Parameters
None

#### Request Body
```graphql
query auction($auction_id: String!) {
  auction(auction_id: $auction_id) {
    auction_id
    auction_ref
    title
    type
    description
    start_time
    end_time
    auction_status
    is_simulcast
    is_prebidding_allowed
    prebid_start_time
    prebid_end_time
    bid_increment_id
    premium_id
    commission_id
    sales_tax
    terms
    preview
    preview_start_time
    preview_end_time
    is_visible_on_front
    is_featured
    allow_offers
    allow_donations
  }
}
```

### Request Example
```json
{
  "query": "query auction($auction_id: String!) { auction(auction_id: $auction_id) { auction_id auction_ref title type description start_time end_time auction_status is_simulcast is_prebidding_allowed prebid_start_time prebid_end_time bid_increment_id premium_id commission_id sales_tax terms preview preview_start_time preview_end_time is_visible_on_front is_featured allow_offers allow_donations } }",
  "variables": {
    "auction_id": "1161"
  }
}
```

### Response
#### Success Response (200)
- **auction_id** (String) - The unique identifier for the auction.
- **auction_ref** (String) - The reference code for the auction.
- **title** (String) - The title of the auction.
- **type** (String) - The type of auction.
- **description** (String) - A description of the auction.
- **start_time** (String) - The start date and time of the auction.
- **end_time** (String) - The end date and time of the auction.
- **auction_status** (String) - The current status of the auction.
- **is_simulcast** (Boolean) - Indicates if the auction is simulcast.
- **is_prebidding_allowed** (Boolean) - Indicates if pre-bidding is allowed.
- **prebid_start_time** (String) - The start date and time for pre-bidding.
- **prebid_end_time** (String) - The end date and time for pre-bidding.
- **bid_increment_id** (String) - The ID for bid increments.
- **premium_id** (String) - The ID for premiums.
- **commission_id** (String) - The ID for commissions.
- **sales_tax** (Float) - The sales tax rate.
- **terms** (String) - The terms and conditions of the auction.
- **preview** (String) - Description of the auction preview.
- **preview_start_time** (String) - The start date and time for the preview.
- **preview_end_time** (String) - The end date and time for the preview.
- **is_visible_on_front** (Boolean) - Whether the auction is visible on the front page.
- **is_featured** (Boolean) - Whether the auction is featured.
- **allow_offers** (Boolean) - Indicates if offers are allowed.
- **allow_donations** (Boolean) - Indicates if donations are allowed.

#### Response Example
```json
{
  "data": {
    "auction": {
      "auction_id": "1161",
      "auction_ref": "SIMULCAST-FALL-2024",
      "title": "Fall Simulcast Auction",
      "type": "simulcast",
      "description": "Live and online bidding for fall collection.",
      "start_time": "2024-10-20T10:00:00Z",
      "end_time": "2024-10-20T18:00:00Z",
      "auction_status": "live",
      "is_simulcast": true,
      "is_prebidding_allowed": true,
      "prebid_start_time": "2024-10-18T09:00:00Z",
      "prebid_end_time": "2024-10-20T09:00:00Z",
      "bid_increment_id": "std_increments",
      "premium_id": "standard_premium",
      "commission_id": "standard_commission",
      "sales_tax": 0.07,
      "terms": "Standard auction terms apply.",
      "preview": "Preview available by appointment.",
      "preview_start_time": "2024-10-15T09:00:00Z",
      "preview_end_time": "2024-10-19T17:00:00Z",
      "is_visible_on_front": true,
      "is_featured": true,
      "allow_offers": false,
      "allow_donations": false
    }
  }
}
```
```

--------------------------------

### Auction Queries - Get Auction Rings

Source: https://context7.com/usaamatahir/freijeapi/llms.txt

Retrieves auction rings (bidding lanes/streams) for live simulcast auctions. Rings allow multiple items to be sold simultaneously in different virtual lanes.

```APIDOC
## GET /api/graphql

### Description
Retrieves auction rings for live simulcast auctions.

### Method
GET

### Endpoint
https://www.jeffmartinauctioneers.com/api

### Parameters
#### Query Parameters
None

#### Request Body
```graphql
query auctionRings(
  $pagination: Pagination,
  $filter: AuctionRingFilterInput,
  $search: AuctionRingSearchInput,
  $order: OrderBy,
  $source: String
) {
  auctionRings(
    pagination: $pagination,
    filter: $filter,
    search: $search,
    order: $order,
    source: $source
  ) {
    total
    auctionRings {
      auction_ring_id
      auction_id
      title
      auction_type
    }
  }
}
```

### Request Example
```json
{
  "query": "query auctionRings($pagination: Pagination, $filter: AuctionRingFilterInput, $search: AuctionRingSearchInput, $order: OrderBy, $source: String) { auctionRings(pagination: $pagination, filter: $filter, search: $search, order: $order, source: $source) { total auctionRings { auction_ring_id auction_id title auction_type } } }",
  "variables": {
    "pagination": {
      "page": 1,
      "pageSize": 10
    },
    "filter": {
      "auction_id": 1161,
      "is_live_ring": true
    },
    "order": {
      "column": "start_time",
      "direction": "ASC"
    }
  }
}
```

### Response
#### Success Response (200)
- **total** (Integer) - The total number of auction rings matching the query.
- **auctionRings** (Array) - An array of auction ring objects.
  - **auction_ring_id** (String) - The unique identifier for the auction ring.
  - **auction_id** (String) - The ID of the auction this ring belongs to.
  - **title** (String) - The title or name of the auction ring.
  - **auction_type** (String) - The type of auction associated with the ring.

#### Response Example
```json
{
  "data": {
    "auctionRings": {
      "total": 3,
      "auctionRings": [
        {
          "auction_ring_id": "ring_1",
          "auction_id": "1161",
          "title": "Main Ring",
          "auction_type": "simulcast"
        },
        {
          "auction_ring_id": "ring_2",
          "auction_id": "1161",
          "title": "Ring B",
          "auction_type": "simulcast"
        }
      ]
    }
  }
}
```
```

--------------------------------

### MFASettingInput Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Provides an example of the JSON input for MFASetting, which includes fields for configuration such as name, type, secret, TOTP, default status, creation time, and data.

```json
{
  "name": "abc123",
  "type": MultiFactorAuthTypeEnum,
  "secret": "xyz789",
  "totp": "xyz789",
  "default": true,
  "created_at": "2007-12-03T10:15:30Z",
  "data": {}
}
```

--------------------------------

### User Expenditure Date Filter Input Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

An example JSON object for filtering user expenditures by date. It includes fields for the start date, end date, and additional sorting parameters.

```json
{
  "fromdate": "xyz789",
  "todate": "xyz789",
  "additional_sort": "xyz789"
}
```

--------------------------------

### AutobidProfile Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

An example JSON payload for an AutobidProfile. This includes profile identification, type, settings, scheduling information (start interval, recurrence, duration), statistics, and an enabled flag. The settings and stats fields are represented as JSON objects.

```json
{
  "auction_autobid_profile_id": "4",
  "profile_type": "xyz789",
  "settings": {},
  "start_interval": "abc123",
  "recurrence": "abc123",
  "duration": "xyz789",
  "stats": {},
  "is_enabled": false
}
```

--------------------------------

### MFASetting Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Shows the JSON structure for an MFASetting, including name, type, default status, creation timestamp, and associated data.

```json
{
  "name": "xyz789",
  "type": MultiFactorAuthTypeEnum,
  "default": true,
  "created_at": "2007-12-03T10:15:30Z",
  "data": {}
}
```

--------------------------------

### PickupLocationFilterInput Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Shows the input structure for filtering pickup locations, allowing searches by pickup location ID and affiliate ID. The example demonstrates how to provide these filter parameters.

```json
{
  "pickup_location_id": ["4"],
  "affiliate_id": "4"
}
```

--------------------------------

### DefaultInventory Structure Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Defines a simplified inventory structure, including category ID, starting and reserve bids, and an inventory reference.

```json
{
  "category_id": "abc123",
  "starting_bid": 987.65,
  "reserve_bid": 123.45,
  "inventory_ref": "abc123"
}
```

--------------------------------

### Menu Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Shows the JSON structure for a Menu object, including its ID, tag, name, and a list of menu items.

```json
{
  "menu_id": "4",
  "menu_tag": "abc123",
  "name": "abc123",
  "menu_items": [MenuItem]
}
```

--------------------------------

### PageViewDateRange Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Illustrates the PageViewDateRange input, used to specify a time interval for data retrieval. It requires both a start and end date in ISO 8601 format.

```json
{
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z"
}
```

--------------------------------

### PageViewDateRangeCount Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Represents a date range along with a count, likely used in analytics or reporting. It includes the start and end dates of the range and the associated count of events or views.

```json
{
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "count": 123
}
```

--------------------------------

### Example Website

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Example of the Website data structure, containing details about a website including its URLs, keys, and inventory reference numbers.

```json
{
  "name": "xyz789",
  "website_key": "xyz789",
  "front_url": "abc123",
  "admin_url": "xyz789",
  "api_url": "abc123",
  "ssr_asset_url": "abc123",
  "next_inventory_ref": 123,
  "next_check_number": 987
}
```

--------------------------------

### PrevNextInventory Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

This example illustrates the `PrevNextInventory` structure, providing the ID and title of an inventory item, potentially for navigating between inventory records.

```json
{"inventory_id": 4, "title": "xyz789"}
```

--------------------------------

### GraphQL Query Variables Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Example JSON object demonstrating the variables required for a GraphQL query. This specific example provides a value for 'field_permission_id'.

```json
{
  "field_permission_id": "4"
}
```

--------------------------------

### QuickExpense Example Data

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

An example JSON object representing a QuickExpense, illustrating the expected data types and values for each field.

```json
{
  "quick_expense_id": "4",
  "description": "abc123",
  "amount": 987.65,
  "expense_group_id": 4,
  "apply_to_invoice": true,
  "apply_to_statement": false,
  "created_at": "2007-12-03T10:15:30Z",
  "is_taxable": true,
  "tax_class_id": 4,
  "tax_class": "TaxClass"
}
```

--------------------------------

### User Object Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

An example of the user object structure returned by the API.

```APIDOC
## User Object Example

### Description
This example demonstrates the structure of a user object, including personal details, contact information, bidding preferences, and status flags.

### Request Example
```json
{
  "user_id": 4,
  "user_ref": "xyz789",
  "first_name": "abc123",
  "middle_name": "xyz789",
  "last_name": "xyz789",
  "preferred_name": "abc123",
  "username": "xyz789",
  "bidder_number": "abc123",
  "date_of_birth": "2007-12-03T10:15:30Z",
  "email": "xyz789",
  "company": "abc123",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z",
  "deleted_at": "2007-12-03T10:15:30Z",
  "drivers_license": "abc123",
  "drivers_license_expiration": "2007-12-03T10:15:30Z",
  "drivers_license_state_id": 4,
  "shipping_same_as_billing": true,
  "interested_in_list": "xyz789",
  "heard_about_us_list": "abc123",
  "preferred_pick_up_location": "xyz789",
  "dynamic_values": {},
  "email_verified": false,
  "do_not_auto_charge": false,
  "vip_bidder_number": "xyz789",
  "next_inventory_ref": "xyz789",
  "cc_email_addresses": ["abc123"],
  "bcc_email_addresses": ["abc123"],
  "bidding_threshold": 987.65,
  "enable_logrocket": false,
  "optout_text_reminder": false,
  "is_bidder_agent": true,
  "consignor_salesperson_id": 4,
  "first_auction_registration": "AuctionRegistration",
  "last_login": "2007-12-03T10:15:30Z",
  "remote_ip": "xyz789",
  "preferences": {},
  "mfa_settings": ["MFASetting"],
  "status": 987,
  "fein": "xyz789",
  "is_tax_exempt": true,
  "buyers_premium_tax_exempt": false,
  "is_bidding_disabled": true,
  "statement_category_expense_exempt": false,
  "banned_message": "xyz789",
  "banned_at": "2007-12-03T10:15:30Z",
  "banned_reason": "abc123",
  "override_require_cc_to_bid": false,
  "override_require_approval_to_bid": true,
  "override_require_payment_auth_to_bid": true,
  "override_require_text_verification_to_bid": false,
  "cp_allow_all_auctions": false,
  "can_edit_settings": true,
  "is_incomplete": false,
  "display_name": "abc123",
  "ignore_pst_threshold": false,
  "ignore_hst_threshold": false,
  "login_attempt_notification_count": 123,
  "file_upload_expires_at": "2007-12-03T10:15:30Z",
  "max_file_uploads": 987,
  "late_pickup_count": 123,
  "can_create_auction_front": false,
  "is_storage_fee_exempt": true,
  "notes": ["Note"],
  "_show_yourjma_link": true,
  "custom_permissions": {}
}
```
```

--------------------------------

### Bid Object Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

This comprehensive example illustrates the Bid object, detailing numerous fields related to bids, including ID, amount, status, and associated users and lots. It serves as a reference for all bid-related data.

```json
{
  "bid_id": 4,
  "amount": 987.65,
  "is_winner": false,
  "was_winner": true,
  "is_top": true,
  "is_absolute": false,
  "created_at": "2007-12-03T10:15:30Z",
  "bidder_number": 987,
  "source": "abc123",
  "source_ip": "abc123",
  "bid_status": 123,
  "quantity": 123,
  "composition": ["xyz789"],
  "pre_choice_selection": ["4"],
  "combo_num": 987,
  "combo_num_display": "xyz789",
  "user_id": "xyz789",
  "is_second": true,
  "is_third": true,
  "simulcast_round_id": "4",
  "dynamic_values": {},
  "floor_bidder_text": "xyz789",
  "proxy_bid_id": 4,
  "bidtoolused": {},
  "winning_bidder": ObscuredUser,
  "bidder": SimpleUser,
  "consignor_bidder": ConsignorBidderUser,
  "full_bidder": User,
  "lot": SimpleAuctionLot,
  "full_auction_lot": AuctionLot,
  "auction": SimpleAuction
}
```

--------------------------------

### SimplePremium Fields and Example

Source: https://github.com/usaamatahir/freijeapi/blob/main/index.html

Describes the fields for a SimplePremium, encompassing premium identifiers, names, types, amounts, and creation details. A JSON example illustrates its structure.

```json
{
  "premium_id": "ID!",
  "name": "String!",
  "type": "String!",
  "amount": "Float",
  "custom": "JSON",
  "created_at": "DateTime!",
  "qty_calculation_method": "String!",
  "is_flat": "Boolean!",
  "custom_disclaimer": "String",
  "affiliate_id": "ID",
  "shared_premium": "Boolean"
}
```