Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: New stream trial_balances #20

Merged
merged 3 commits into from
Dec 17, 2024

Conversation

edgarrmondragon
Copy link
Member

@edgarrmondragon edgarrmondragon commented Dec 17, 2024

This makes the most basic date-range request which is probably a good start, but there's more options:

Details

Name Required Type Description
reportingperiodname Optional string Reporting period name. Required if not using startdate and enddate.
startdate Optional object Opening balance date. Required if not using reportingperiodname.
enddate Optional object Closing balance date. Required if not using reportingperiodname.
debitcreditbalance Optional boolean Set to true to show starting and ending balance debits and credits. (Default: false)
showzerobalances Optional boolean Show zero balance accounts. Use true or false. (Default: false)
showdeptdetail Optional boolean Expand department detail. Use true or false. (Default: false)
showlocdetail Optional boolean Expand location detail. Use true or false. (Default: false)
reportingbook Optional string Reporting book ID. Use ACCRUAL or CASH depending on the company configuration. If Global Consolidations is enabled, you can provide a consolidation book ID instead. (Default: Configured reporting book ID)
adjbooks Optional array of adjbook Adjustment book IDs for journals that are enabled in the GL configuration. Use GAAP, TAX, and/or the IDs of user defined books. Do not append text to the IDs. If you need help, look at the Trial Balance page in the Sage Intacct UI to see what is enabled.
includereportingbook Optional boolean Combine reporting book with other adjustment books. Use true to include the reporting book entries with entries from the specified adjustment books, or false to return only entries for the specified adjustment books.
statistical Optional string Statistical accounts. Use either include, exclude, or only. (Default: include)
departmentid Optional string Department ID.
dept_subs Optional boolean Include department subs. (Default: true)
locationid Optional string Location ID. This field is required in a multi-base currency company.
loc_subs Optional boolean Include location subs. (Default: true)
projectid Optional string Project ID or project group ID.
projectid_subs Optional boolean Include project subs. (Default: true)
projecttypeid Optional string Project type. Do not use if Project ID is set.
taskid Optional string Task ID. Only available when the parent projectid is also specified.
taskid_subs Optional boolean Include task sub dimensions. (Default: true)
customerid Optional string Customer ID or customer group ID.
customerid_subs Optional boolean Include customer subs. (Default: true)
customertypeid Optional string Customer type. Do not use if Customer ID is set.
vendorid Optional string Vendor ID or vendor group ID.
vendorid_subs Optional boolean Include vendor subs. (Default: true)
vendortypeid Optional string Vendor type. Do not use if Vendor ID is set.
employeeid Optional string Employee ID or employee group ID.
employeeid_subs Optional boolean Include employee subs. (Default: true)
employeetypeid Optional string Employee type. Do not use if Employee ID is set.
itemid Optional string Item ID or item group ID.
productlineid Optional string Product line. Do not use if Item ID is set.
classid Optional string Class ID or class group ID.
classid_subs Optional boolean Include class subs. (Default: true)
contractid Optional string Contract ID or contract group ID.
contractid_subs Optional boolean Include contract subs. (Default: true)
warehouseid Optional string Warehouse ID or warehouse group ID.
warehouseid_subs Optional boolean Include warehouse subs. (Default: true)
userDefinedDimensions Optional array of userDefinedDimension User defined dimension filters.

Test results

tests/test_core.py::TestTapIntacct::test_tap_cli_prints <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [  6%]
tests/test_core.py::TestTapIntacct::test_tap_discovery <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 12%]
tests/test_core.py::TestTapIntacct::test_tap_stream_connections <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 18%]
tests/test_core.py::TestTapIntacct::test_tap_valid_final_state <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 25%]
tests/test_core.py::TestTapIntacct::test_tap_stream_transformed_catalog_schema_matches_record[trial_balances] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 31%]
tests/test_core.py::TestTapIntacct::test_tap_stream_record_matches_stream_schema[trial_balances] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 37%]
tests/test_core.py::TestTapIntacct::test_tap_stream_record_schema_matches_transformed_catalog[trial_balances] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 43%]
tests/test_core.py::TestTapIntacct::test_tap_stream_returns_record[trial_balances] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 50%]
tests/test_core.py::TestTapIntacct::test_tap_stream_schema_is_valid[trial_balances] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 56%]
tests/test_core.py::TestTapIntacct::test_tap_stream_primary_keys[trial_balances] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 62%]
tests/test_core.py::TestTapIntacct::test_tap_stream_attribute_is_numeric[trial_balances.startbalance] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 68%]
tests/test_core.py::TestTapIntacct::test_tap_stream_attribute_is_numeric[trial_balances.debits] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 75%]
tests/test_core.py::TestTapIntacct::test_tap_stream_attribute_is_numeric[trial_balances.credits] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 81%]
tests/test_core.py::TestTapIntacct::test_tap_stream_attribute_is_numeric[trial_balances.adjdebits] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 87%]
tests/test_core.py::TestTapIntacct::test_tap_stream_attribute_is_numeric[trial_balances.adjcredits] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [ 93%]
tests/test_core.py::TestTapIntacct::test_tap_stream_attribute_is_numeric[trial_balances.endbalance] <- .venv/lib/python3.13/site-packages/singer_sdk/testing/templates.py PASSED [100%]

Closes #13

@edgarrmondragon edgarrmondragon linked an issue Dec 17, 2024 that may be closed by this pull request
@edgarrmondragon edgarrmondragon self-assigned this Dec 17, 2024
@edgarrmondragon edgarrmondragon force-pushed the 13-feat-add-trial-balance-stream branch from 858ea24 to a08efea Compare December 17, 2024 03:06
@edgarrmondragon edgarrmondragon marked this pull request as ready for review December 17, 2024 03:22
@edgarrmondragon edgarrmondragon merged commit 809b47c into main Dec 17, 2024
4 checks passed
@edgarrmondragon edgarrmondragon deleted the 13-feat-add-trial-balance-stream branch December 17, 2024 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: add trial balance stream
1 participant