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.

Sign up for GitHub

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

Update README.md #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,19 +64,22 @@ These values are all obtained from the oauth steps documented on [quickbook's do
```
1. Create your tap's `config.json` file. The tap config file for this tap should include these entries:
- `start_date` - the default value to use if no bookmark exists for an endpoint (rfc3339 date string)
- `user_agent` (string, optional): Process and email for API logging purposes. Example: `tap-quickbooks <api_user_email@your_company.com>`
- `user_agent` (string): Process and email for API logging purposes. Example: `tap-quickbooks <api_user_email@your_company.com>`
- `realm_id` (string): The realm id of the company to fetch the data from.
- `sandbox` (string, optional): Whether to communication with quickbooks's sandbox or prod account for this application. If you're not sure leave out. Defaults to false.


And the other values mentioned in [the authentication section above](#authentication).

```json
{
"client_id": "<app_id>",
"start_date": "2020-08-21T00:00:00Z",
"refresh_token": "<refresh_token>",
"client_secret": "<app_secret>",
"sandbox": "<true|false>",
"user_agent": "Stitch Tap ([email protected])"
"refresh_token": "<refresh_token>",
"start_date": "2020-08-21T00:00:00Z",
"user_agent": "Stitch Tap ([email protected])",
"realm_id": "0123456789",
"sandbox": "<true|false>"
}
```

Expand Down