summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/POPFinancial.md
diff options
context:
space:
mode:
authorMax Nanis2026-02-18 20:42:03 -0500
committerMax Nanis2026-02-18 20:42:03 -0500
commit3eaa56f0306ead818f64c3d99fc6d230d9b970a4 (patch)
tree9fecc2f1456e6321572e0e65f57106916df173e2 /jb-ui/src/api_fsb/docs/POPFinancial.md
downloadamt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.tar.gz
amt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.zip
HERE WE GO, HERE WE GO, HERE WE GO
Diffstat (limited to 'jb-ui/src/api_fsb/docs/POPFinancial.md')
-rw-r--r--jb-ui/src/api_fsb/docs/POPFinancial.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/POPFinancial.md b/jb-ui/src/api_fsb/docs/POPFinancial.md
new file mode 100644
index 0000000..a262efc
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/POPFinancial.md
@@ -0,0 +1,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)