aboutsummaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/ProductBalances.md
blob: 92a9170d54db0b6616c8cfceafb91cb4c9aefa07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# ProductBalances


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**product_id** | **string** |  | [optional] [default to undefined]
**last_event** | **string** |  | [optional] [default to undefined]
**bp_payment_credit** | **number** | The total amount that has been earned by the Task completes, for this Brokerage Product account. | [optional] [default to 0]
**adjustment_credit** | **number** | Positive reconciliations issued back to the Brokerage Product account. | [optional] [default to 0]
**adjustment_debit** | **number** | Negative reconciliations for any Task completes | [optional] [default to 0]
**supplier_credit** | **number** | ACH or Wire amounts issued to GRL from a Supplier to recoup for a negative Brokerage Product balance | [optional] [default to 0]
**supplier_debit** | **number** | ACH or Wire amounts sent to a Supplier | [optional] [default to 0]
**user_bonus_credit** | **number** | If a respondent ever pays back an product account. | [optional] [default to 0]
**user_bonus_debit** | **number** | Pay a user into their wallet balance. There is no fee here. There is only a fee when the user requests a payout.The bonus could be as a bribe, winnings for a contest, leaderboard, etc. | [optional] [default to 0]
**issued_payment** | **number** | This is the amount that we decide to credit as havingtaken from this Product. If there is any amount not issuedit is summed up over the Business to offset any negativebalances elsewhere. | [optional] [default to 0]
**payout** | **number** | The sum amount of all Task payouts | [readonly] [default to undefined]
**payout_usd_str** | **string** |  | [readonly] [default to undefined]
**adjustment** | **number** | The sum amount of all Task Adjustments | [readonly] [default to undefined]
**expense** | **number** | The sum amount of any associated Product Expenses (eg: user bonuses) | [readonly] [default to undefined]
**net** | **number** | The Product\'s Net Earnings which is equal to the totalamount of Task Payouts, with Task Adjustments and anyProduct Expenses deducted. This can be positive ornegative. | [readonly] [default to undefined]
**payment** | **number** | The sum amount of all Supplier Payments (eg ACH or Wire transfers) | [readonly] [default to undefined]
**payment_usd_str** | **string** |  | [readonly] [default to undefined]
**balance** | **number** | The Product\'s Balance which is equal to the Product\'s Netamount with already issued Supplier Payments deducted. This can be positive or negative. | [readonly] [default to undefined]
**retainer** | **number** | The Smart Retainer is an about of money that is held byGRL to account for any Task Adjustments that may occurin the future. The amount will always be positive, andif the Product\'s balance is negative, the retainer will be $0.00 as the Product is not eligible for any SupplierPayments either way. | [readonly] [default to undefined]
**retainer_usd_str** | **string** |  | [readonly] [default to undefined]
**available_balance** | **number** | The Available Balance is the amount that is currently, andimmediately available for withdraw from the Supplier\'sbalance. Supplier Payments are made every Friday for Businesses with an ACH connected Bank Account to GRL, while a Business that requires an International Wire are issued on the last Friday of every Month. | [readonly] [default to undefined]
**available_balance_usd_str** | **string** |  | [readonly] [default to undefined]
**recoup** | **number** |  | [readonly] [default to undefined]
**recoup_usd_str** | **string** |  | [readonly] [default to undefined]
**adjustment_percent** | **number** | The percentage of USDCent value that has been adjustedover all time for this Product. | [readonly] [default to undefined]

## Example

```typescript
import { ProductBalances } from './api';

const instance: ProductBalances = {
    product_id,
    last_event,
    bp_payment_credit,
    adjustment_credit,
    adjustment_debit,
    supplier_credit,
    supplier_debit,
    user_bonus_credit,
    user_bonus_debit,
    issued_payment,
    payout,
    payout_usd_str,
    adjustment,
    expense,
    net,
    payment,
    payment_usd_str,
    balance,
    retainer,
    retainer_usd_str,
    available_balance,
    available_balance_usd_str,
    recoup,
    recoup_usd_str,
    adjustment_percent,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)