# GetWhiteLabelSimAccount

Read practice capital and reset eligibility. Equity includes unallocated cash and closed SIM returns; PendingCount identifies subscriptions awaiting their initial snapshot. Non-paginated endpoint.

Endpoint: GET /Autotrade/GetWhiteLabelSimAccount
Version: v4
Security: 

## Query parameters:

  - `PersonId` (integer,null, required)
    The active customer on your White Label site.

## Response 200 fields (application/json):

  - `Results` (array,null)
    Result array

  - `Results.PersonId` (integer)
    The customer whose practice account was requested.

  - `Results.IsCompleted` (boolean,null)
    Whether the operation completed. A mutation can fail after partial changes; inspect FailureCode and refresh current state before retrying.

  - `Results.FailureCode` (string,null)
    The operation failure code, when present.

  - `Results.FailureMessage` (string,null)
    The reason the operation did not complete, when present.

  - `Results.StartingEquity` (number,null)
    The starting practice-account equity in dollars.

  - `Results.Equity` (number,null)
    The current practice-account equity in dollars.

  - `Results.Allocated` (number,null)
    Practice capital reserved for active SIM subscriptions, in dollars.

  - `Results.Available` (number,null)
    Practice capital available for allocation, in dollars.

  - `Results.PendingCount` (integer,null)
    The number of SIM subscriptions awaiting their initial performance snapshot.

  - `Results.ResetPolicy` (object)

  - `Results.ResetPolicy.IsEligible` (boolean,null)
    Whether the practice account may currently be reset.

  - `Results.ResetPolicy.IsBelowDistressThreshold` (boolean,null)
    Whether available practice capital qualifies for the low-balance cooldown exception.

  - `Results.ResetPolicy.LastResetEpoch` (integer,null)
    The last reset time as Unix seconds, if known.

  - `Results.ResetPolicy.NextRegularResetEpoch` (integer,null)
    The next reset time under the ordinary cooldown, as Unix seconds.

  - `Results.ResetPolicy.DistressThreshold` (number)
    The available-capital threshold for the low-balance reset exception, in dollars.

  - `Results.ResetPolicy.CooldownSeconds` (integer)
    The ordinary reset cooldown in seconds.

  - `Results.AllocationRange` (object)

  - `Results.AllocationRange.Minimum` (number)
    The minimum supported allocation multiplier.

  - `Results.AllocationRange.Maximum` (number)
    The maximum supported allocation multiplier.

  - `Results.AllocationRange.Step` (number)
    The supported increment between allocation multipliers.

  - `Results.AllocationRange.Available` (number)
    The exact practice capital available for the allocation, in dollars.

  - `Results.AllocationRange.StrategyEquity` (number)
    The strategy equity used to calculate the allocation, in dollars.

  - `Results.SubscriptionId` (integer,null)
    The current or replacement SIM subscription ID.

  - `Results.PreviousSubscriptionId` (integer,null)
    The SIM subscription replaced by an allocation change.

  - `Results.ScalingFactor` (number,null)
    The actual allocation multiplier, including an existing fractional multiplier on an unchanged request.

  - `Results.IsUnchanged` (boolean,null)
    Whether the existing SIM subscription was returned without a change.

  - `Results.StoppedSimCount` (integer,null)
    The actual number of SIM subscriptions stopped by the reset.

  - `Results.ClearedResultCount` (integer,null)
    The actual number of practice result rows rebased by the reset.

  - `Results.RemovedSnapshotCount` (integer,null)
    The actual number of practice-history snapshots removed by the reset.

  - `Results.NextResetEpoch` (integer,null)
    The next eligible reset time as Unix seconds.

  - `Results.Timezone` (string,null)
    The time zone used for daily practice-equity dates.

  - `Results.RetentionDays` (integer,null)
    The maximum retained practice-history period in days.

  - `Results.OmittedSampleCount` (integer,null)
    The number of unusable observations omitted from the returned history.

  - `Results.Days` (array,null)
    The last stored observation for each available practice-equity day.

  - `Results.Days.Date` (string,null)
    The observation date in YYYY-MM-DD format, in the response time zone.

  - `Results.Days.RecordedEpoch` (integer)
    The recorded observation time as Unix seconds.

  - `Results.Days.Equity` (number)
    The practice-account equity at that observation, in dollars.

  - `Results.Days.IsClosedDay` (boolean,null)
    Whether the observation belongs to a prior calendar day; later corrections remain possible.

  - `ResponseStatus` (object)

  - `ResponseStatus.ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `ResponseStatus.Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `ResponseStatus.Errors` (array,null)

  - `ResponseStatus.Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `ResponseStatus.Errors.FieldName` (string,null)
    The affected parameter.

  - `ResponseStatus.Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 400 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 401 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 403 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 404 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 406 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 409 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 429 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 500 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 503 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.


## Response 304 fields
