# BillProperties

Type: object

Schema: [BillProperties](https://sourcey-firefly.pages.dev/api/models/billproperties/index.md)

- `created_at` (optional)
  Type: string, date-time
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `updated_at` (optional)
  Type: string, date-time
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `name` (optional)
  Type: string, string
  
  The name of the subscription.
  
  Example:
  
  ```json
  "Rent"
  ```

- `object_has_currency_setting` (optional)
  Type: boolean
  
  Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  true
  ```

- `currency_id` (optional)
  Type: string, string
  
  The currency ID of the currency associated with this object.
  
  Example:
  
  ```json
  "5"
  ```

- `currency_name` (optional)
  Type: string, string
  
  The currency name of the currency associated with this object.
  
  Example:
  
  ```json
  "Euro"
  ```

- `currency_code` (optional)
  Type: string, string
  
  The currency code of the currency associated with this object.
  
  Example:
  
  ```json
  "EUR"
  ```

- `currency_symbol` (optional)
  Type: string, string
  
  readOnly: true
  
  Example:
  
  ```json
  "$"
  ```

- `currency_decimal_places` (optional)
  Type: integer, int32
  
  readOnly: true
  
  Example:
  
  ```json
  2
  ```

- `primary_currency_id` (optional)
  Type: string, string
  
  The currency ID of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "5"
  ```

- `primary_currency_name` (optional)
  Type: string, string
  
  The currency name of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "Euro"
  ```

- `primary_currency_code` (optional)
  Type: string, string
  
  The currency code of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "EUR"
  ```

- `primary_currency_symbol` (optional)
  Type: string, string
  
  The currency symbol of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "$"
  ```

- `primary_currency_decimal_places` (optional)
  Type: integer, int32
  
  The currency decimal places of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  2
  ```

- `amount_min` (optional)
  Type: string, amount
  
  The minimum amount that is expected for this subscription in the subscription's currency.
  
  Example:
  
  ```json
  "123.45"
  ```

- `pc_amount_min` (optional)
  Type: string, amount
  
  The minimum amount that is expected for this subscription in the administration's primary currency.
  
  Example:
  
  ```json
  "123.45"
  ```

- `amount_max` (optional)
  Type: string, amount
  
  The maximum amount that is expected for this subscription in the subscription's currency.
  
  Example:
  
  ```json
  "123.45"
  ```

- `pc_amount_max` (optional)
  Type: string, amount
  
  The maximum amount that is expected for this subscription in the administration's primary currency.
  
  Example:
  
  ```json
  "123.45"
  ```

- `amount_avg` (optional)
  Type: string, amount
  
  The average amount that is expected for this subscription in the subscription's currency.
  
  Example:
  
  ```json
  "123.45"
  ```

- `pc_amount_avg` (optional)
  Type: string, amount
  
  The average amount that is expected for this subscription in the administration's primary currency.
  
  Example:
  
  ```json
  "123.45"
  ```

- `date` (optional)
  Type: string, date-time
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `end_date` (optional)
  Type: string, date-time; nullable
  
  The date after which this subscription is no longer valid or applicable
  
  Example:
  
  ```json
  "2026-10-31T23:59:59+00:00"
  ```

- `extension_date` (optional)
  Type: string, date-time; nullable
  
  The date before which the subscription must be renewed (or cancelled)
  
  Example:
  
  ```json
  "2026-10-31T23:59:59+00:00"
  ```

- `repeat_freq` (optional)
  Reference: [BillRepeatFrequency](https://sourcey-firefly.pages.dev/api/models/billrepeatfrequency/index.md); Type: string, string
  
  How often the bill must be paid.
  
  enum: ["weekly","monthly","quarterly","half-year","yearly"]
  
  Example:
  
  ```json
  "monthly"
  ```

- `skip` (optional)
  Type: integer, int32
  
  How often the subscription will be skipped. 1 means a bi-monthly subscription.
  
  Example:
  
  ```json
  0
  ```

- `active` (optional)
  Type: boolean
  
  If the subscription is active.
  
  Example:
  
  ```json
  true
  ```

- `order` (optional)
  Type: integer, int32
  
  Order of the subscription.
  
  Example:
  
  ```json
  1
  ```

- `notes` (optional)
  Type: string, string; nullable
  
  Example:
  
  ```json
  "Some example notes"
  ```

- `object_group_id` (optional)
  Type: string, string; nullable
  
  The group ID of the group this object is part of. NULL if no group.
  
  Example:
  
  ```json
  "5"
  ```

- `object_group_order` (optional)
  Type: integer, int32; nullable
  
  The order of the group. At least 1, for the highest sorting.
  
  readOnly: true
  
  Example:
  
  ```json
  5
  ```

- `object_group_title` (optional)
  Type: string, string; nullable
  
  The name of the group. NULL if no group.
  
  Example:
  
  ```json
  "Example Group"
  ```

- `paid_dates` (optional)
  Type: array
  
  Array of past transactions when the subscription was paid.
  
  readOnly: true
  
  Items:
    Type: object
    
    readOnly: true
    
    - `transaction_group_id` (optional)
      Type: string, string
      
      Transaction group ID of the transaction linked to this subscription.
      
      readOnly: true
      
      Example:
      
      ```json
      "123"
      ```
    
    - `transaction_journal_id` (optional)
      Type: string, string
      
      Transaction journal ID of the transaction linked to this subscription.
      
      readOnly: true
      
      Example:
      
      ```json
      "123"
      ```
    
    - `date` (optional)
      Type: string, date-time
      
      Date the bill was paid.
      
      readOnly: true
      
      Example:
      
      ```json
      "2026-10-01T00:00:00+00:00"
      ```
    
    - `subscription_id` (optional)
      Type: string, string
      
      ID of this subscription.
      
      readOnly: true
      
      Example:
      
      ```json
      "123"
      ```
    
    - `currency_id` (optional)
      Type: string, string
      
      The currency ID of the currency associated with this object.
      
      Example:
      
      ```json
      "5"
      ```
    
    - `currency_name` (optional)
      Type: string, string
      
      The currency name of the currency associated with this object.
      
      Example:
      
      ```json
      "Euro"
      ```
    
    - `currency_code` (optional)
      Type: string, string
      
      The currency code of the currency associated with this object.
      
      Example:
      
      ```json
      "EUR"
      ```
    
    - `currency_symbol` (optional)
      Type: string, string
      
      readOnly: true
      
      Example:
      
      ```json
      "$"
      ```
    
    - `currency_decimal_places` (optional)
      Type: integer, int32
      
      readOnly: true
      
      Example:
      
      ```json
      2
      ```
    
    - `primary_currency_id` (optional)
      Type: string, string
      
      The currency ID of the administration's primary currency.
      
      readOnly: true
      
      Example:
      
      ```json
      "5"
      ```
    
    - `primary_currency_name` (optional)
      Type: string, string
      
      The currency name of the administration's primary currency.
      
      readOnly: true
      
      Example:
      
      ```json
      "Euro"
      ```
    
    - `primary_currency_code` (optional)
      Type: string, string
      
      The currency code of the administration's primary currency.
      
      readOnly: true
      
      Example:
      
      ```json
      "EUR"
      ```
    
    - `primary_currency_symbol` (optional)
      Type: string, string
      
      The currency symbol of the administration's primary currency.
      
      readOnly: true
      
      Example:
      
      ```json
      "$"
      ```
    
    - `primary_currency_decimal_places` (optional)
      Type: integer, int32
      
      The currency decimal places of the administration's primary currency.
      
      readOnly: true
      
      Example:
      
      ```json
      2
      ```
    
    - `amount` (optional)
      Type: string, amount
      
      The amount that was paid for this subscription in the subscription's currency.
      
      Example:
      
      ```json
      "123.45"
      ```
    
    - `pc_amount` (optional)
      Type: string, amount
      
      The amount that was paid for this subscription in the administration's primary currency.
      
      Example:
      
      ```json
      "123.45"
      ```
    
    - `foreign_amount` (optional)
      Type: string, amount
      
      The foreign amount that was paid for this subscription in the subscription's currency.
      
      Example:
      
      ```json
      "123.45"
      ```
    
    - `pc_foreign_amount` (optional)
      Type: string, amount
      
      The foreign amount that was paid for this subscription in the administration's primary currency.
      
      Example:
      
      ```json
      "123.45"
      ```

- `pay_dates` (optional)
  Type: array
  
  Array of future dates when the bill is expected to be paid. Autogenerated.
  
  readOnly: true
  
  Items:
    Type: string, date-time
    
    readOnly: true
    
    Example:
    
    ```json
    "2026-10-01T00:00:00+00:00"
    ```

- `next_expected_match` (optional)
  Type: string, date-time; nullable
  
  When the subscription is expected to be due.
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `next_expected_match_diff` (optional)
  Type: string, string; nullable
  
  Formatted (locally) when the subscription is due.
  
  readOnly: true
  
  Example:
  
  ```json
  "today"
  ```