Twinfield

tap-twinfield (yoast variant)

Tax and Accounting Software

The tap-twinfield extractor pulls data from Twinfield that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-twinfield extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-twinfield
  3. Configure the tap-twinfield settings using
    meltano config
    :
  4. meltano config tap-twinfield set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-twinfield test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-twinfield may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-twinfield settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-twinfield list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Office (office)

  • Environment variable: TAP_TWINFIELD_OFFICE

Your Twinfield office.


Configure this setting directly using the following Meltano command:

meltano config tap-twinfield set office [value]

Organisation (organisation)

  • Environment variable: TAP_TWINFIELD_ORGANISATION

Your Twinfield organisation.


Configure this setting directly using the following Meltano command:

meltano config tap-twinfield set organisation [value]

Password (password)

  • Environment variable: TAP_TWINFIELD_PASSWORD

Your Twinfield password.


Configure this setting directly using the following Meltano command:

meltano config tap-twinfield set password [value]

Start Date (start_date)

  • Environment variable: TAP_TWINFIELD_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.


Configure this setting directly using the following Meltano command:

meltano config tap-twinfield set start_date [value]

Username (username)

  • Environment variable: TAP_TWINFIELD_USERNAME

Your Twinfield username.


Configure this setting directly using the following Meltano command:

meltano config tap-twinfield set username [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-twinfield extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-twinfield

Maintenance Status

  • Maintenance Status

Repo

https://github.com/Yoast/singer-tap-twinfield
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Yoast

Keywords

  • api