From 0805cdb15c6cefae1a177c2b15b1a0fd9d1d2a5b Mon Sep 17 00:00:00 2001 From: Pablo Martin Date: Mon, 19 Feb 2024 11:36:10 +0100 Subject: [PATCH] balance transactions docs --- models/doc_blocks.md | 29 +++++++++++++++ models/staging/stripe/_stripe_sources.yml | 43 +++++++++++++---------- 2 files changed, 53 insertions(+), 19 deletions(-) create mode 100644 models/doc_blocks.md diff --git a/models/doc_blocks.md b/models/doc_blocks.md new file mode 100644 index 0000000..ca174c6 --- /dev/null +++ b/models/doc_blocks.md @@ -0,0 +1,29 @@ +{% docs generic_id_desc %} + +The unique ID for records in this relation. + +{% enddocs %} + +{% docs field_docs_na_desc %} + +No available documentation for this field. + +{% enddocs %} + +{% docs _airbyte_raw_id_desc %} + +A UUID assigned by Airbyte to each processed event during the sync job. + +{% enddocs %} + +{% docs _airbyte_extracted_at_desc %} + +A timestamp for when the event was pulled by Airbyte from the original data source. + +{% enddocs %} + +{% docs _airbyte_meta_desc %} + +You can query the _airbyte_meta column to see which rows failed for content reasons, and why. + +{% enddocs %} diff --git a/models/staging/stripe/_stripe_sources.yml b/models/staging/stripe/_stripe_sources.yml index 3968d75..88e6819 100644 --- a/models/staging/stripe/_stripe_sources.yml +++ b/models/staging/stripe/_stripe_sources.yml @@ -6,64 +6,69 @@ sources: tables: - name: balance_transactions identifier: balance_transactions + description: | + Individual transactions happening in our different Stripe currency accounts. + + You can read more about this object here: https://docs.stripe.com/api/balance_transactions/object. + columns: - name: id data_type: character varying - description: "" + description: "{{ doc('generic_id_desc') }}" - name: fee data_type: bigint - description: "" + description: "Fees (in cents) paid for this transaction. Represented as a positive integer when assessed." - name: net data_type: bigint - description: "" + description: "Net impact to a Stripe balance (in cents). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by amount - fee" - name: type data_type: character varying - description: "" + description: "Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, obligation_outbound, obligation_reversal_inbound, payment, payment_failure_refund, payment_network_reserve_hold, payment_network_reserve_release, payment_refund, payment_reversal, payment_unreconciled, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, consider reporting_category instead." - name: amount data_type: bigint - description: "" + description: "Gross amount of this transaction (in cents). A positive value represents funds charged to another party, and a negative value represents funds sent to another party." - name: object data_type: character varying - description: "" + description: "Silly column. The value is always `balance_transaction`." - name: source data_type: character varying - description: "" + description: "This transaction relates to the Stripe object indicated here. Can be different object types (charge, refund, payment, etc)." - name: status data_type: character varying - description: "" + description: "The transaction’s net funds status in the Stripe balance, which are either available or pending." - name: created data_type: bigint - description: "" + description: "Time at which the object was created. Measured in seconds since the Unix epoch." - name: currency data_type: character varying - description: "" + description: "Three-letter ISO currency code, in lowercase. Must be a supported currency." - name: description data_type: character varying - description: "" + description: "An arbitrary string attached to the object. Often useful for displaying to users." - name: fee_details data_type: jsonb - description: "" + description: "Detailed breakdown of fees (in cents) paid for this transaction." - name: available_on data_type: bigint - description: "" + description: "The date that the transaction’s net funds become available in the Stripe balance." - name: exchange_rate data_type: numeric - description: "" + description: "If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the amount in currency A, multipled by the exchange_rate, equals the amount in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent’s amount is 1000 and currency is eur. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction’s amount is 1234, its currency is usd, and the exchange_rate is 1.234." - name: sourced_transfers data_type: jsonb - description: "" + description: "{{ doc('field_docs_na_desc') }}" - name: reporting_category data_type: character varying - description: "" + description: "Read more at https://stripe.com/docs/reports/reporting-categories." - name: _airbyte_raw_id data_type: character varying - description: "" + description: "{{ doc('_airbyte_raw_id_desc') }}" - name: _airbyte_extracted_at data_type: timestamp with time zone - description: "" + description: "{{ doc('_airbyte_extracted_at_desc') }}" - name: _airbyte_meta data_type: jsonb - description: "" + description: "{{ doc('_airbyte_meta_desc') }}" - name: charges identifier: charges columns: