summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/POPFinancial.md
blob: a262efc4463f3f62a7b001ffb1905089fbf80751 (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
# POPFinancial

We can\'t use our USDCent class in here because aside from it not     supporting negative values for our adjustments, FastAPI also     complains because it doesn\'t know how to generate documentation     for it.  - Max 2024-06-25

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**product_id** | **string** |  | [optional] [default to undefined]
**time** | **string** | The starting time block for the respective \'Period\' thatthis grouping is on. The `time` could be the start of a 1 minute or 1 hour block for example. | [default to undefined]
**payout** | **number** | The total amount (in USD cents) that the Brokerage Producthas earned within a respective time period. | [optional] [default to 0]
**adjustment** | **number** | The total amount (in USD cents) that the Brokerage Producthas had adjusted within a respective time period. Most ofthe time, this will be negative due to Complete to Incomplete reconciliations. However, it can also be positive due to Incomplete to Complete adjustments. | [default to undefined]
**adjustment_types** | [**Array<AdjustmentType>**](AdjustmentType.md) |  | [default to undefined]
**expense** | **number** | For Product accounts that are setup with Respondent payouts,competitions, user bonuses, or other associated \'costs\', thoseexpenses are accounted for here. This will be negative forthose types of costs. | [default to undefined]
**net** | **number** | This is the sum of the Payout total, Adjustment and any Expenses total. It can be positive or negative for any specific time period. | [default to undefined]
**payment** | **number** | Any ACH or Wire amount that was issued between GRL and the Supplier. | [default to undefined]

## Example

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

const instance: POPFinancial = {
    product_id,
    time,
    payout,
    adjustment,
    adjustment_types,
    expense,
    net,
    payment,
};
```

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