{"id":19045496,"url":"https://github.com/yoast/singer-tap-twinfield","last_synced_at":"2026-06-05T16:31:52.868Z","repository":{"id":53445748,"uuid":"343709444","full_name":"Yoast/singer-tap-twinfield","owner":"Yoast","description":null,"archived":false,"fork":false,"pushed_at":"2022-09-30T08:28:27.000Z","size":58,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-02T08:30:59.534Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Yoast.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-02T09:04:52.000Z","updated_at":"2022-09-30T08:28:32.000Z","dependencies_parsed_at":"2023-01-18T19:14:38.303Z","dependency_job_id":null,"html_url":"https://github.com/Yoast/singer-tap-twinfield","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fsinger-tap-twinfield","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fsinger-tap-twinfield/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fsinger-tap-twinfield/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fsinger-tap-twinfield/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yoast","download_url":"https://codeload.github.com/Yoast/singer-tap-twinfield/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240102167,"owners_count":19747958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T22:50:23.657Z","updated_at":"2025-11-12T16:01:59.633Z","avatar_url":"https://github.com/Yoast.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tap-twinfield\n\nThis is a [Singer](https://singer.io) tap that produces JSON-formatted data\nfollowing the [Singer\nspec](https://github.com/singer-io/getting-started/blob/master/SPEC.md).\n\nThis tap:\n\n- Pulls raw data from [Twinfield](https://accounting2.twinfield.com/webservices/documentation/#/ApiReference/Request/BrowseData)\n- Extracts the following resources:\n  - 000 - General Ledger Transactions\n  - 010 - Transactions still to be matched\n  - 020 - Transaction List\n  - 030_3 - General Ledger Details\n  - 040_1 - Annual Report (Totals)\n  - 060 - Annual Report (Totals Multicurrency)\n  - 230_2 - Suppliers (v2)\n  - 410 - Bank Transactions\n  - 670 - Transaction Summary\n- Outputs the schema for each resource\n- Incrementally pulls data based on the input state\n\n### Step 1: Create an user\n\nThis user needs to have access to the reports.\n\n### Step 2: Configure\n\nCreate a file called `twinfield_config.json` in your working directory, following [sample_config.json](sample_config.json). The required parameters are the `username`, `password`, `organisation` and `office`.\n\nThis requires a `state.json` file to let the tap know from when to retrieve data. For example:\n```\n{\n    \"bookmarks\": {\n      \"bank_transactions\": {\n        \"start_date\": \"2021-01\"\n      },\n      \"general_ledger_details\": {\n        \"start_date\": \"2021-01\"\n      }\n    }\n}\n```\nWill replicate bank transactions and general ledger details data from 2021-01-01.\n\n### Step 3: Install and Run\n\nCreate a virtual Python environment for this tap. This tap has been tested with Python 3.7, 3.8 and 3.9 and might run on future versions without problems.\n```\npython -m venv singer-twinfield\nsinger-twinfield/bin/python -m pip install --upgrade pip\nsinger-twinfield/bin/pip install git+https://github.com/Yoast/singer-tap-twinfield.git\n```\n\nThis tap can be tested by piping the data to a local JSON target. For example:\n\nCreate a virtual Python environment with `singer-json`\n```\npython -m venv singer-json\nsinger-json/bin/python -m pip install --upgrade pip\nsinger-json/bin/pip install target-json\n```\n\nTest the tap:\n\n```\nsinger-twinfield/bin/tap-twinfield --state state.json -c twinfield_config.json | singer-json/bin/target-json \u003e\u003e state_result.json\n```\n\nCopyright \u0026copy; 2021 Yoast","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoast%2Fsinger-tap-twinfield","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoast%2Fsinger-tap-twinfield","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoast%2Fsinger-tap-twinfield/lists"}