Skip to content
This repository was archived by the owner on Jun 11, 2019. It is now read-only.

Commit 254a8a8

Browse files
committed
Add an announcement and URL to the new API docs
1 parent 3f99529 commit 254a8a8

18 files changed

+60
-24
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
13
*Looking for a quick way to add time tracking to your app? Learn more about the Harvest Button and Widget [here](https://www.getharvest.com/add-time-tracking).*
24

3-
# Introduction to the Harvest API
5+
## Introduction to the Harvest API
46

57
Harvest provides two API interfaces, serving two distinct roles. If you need to access and manipulate your daily timesheet the [Time Tracking API](https://github.com/harvesthq/api/blob/master/Sections/Time%20Tracking.md) fits the bill. Notable uses of the [Time Tracking API](https://github.com/harvesthq/api/blob/master/Sections/Time%20Tracking.md) are the widgets we provide for PC and Mac as well as other third party timesheet software integrations.
68

Sections/Accounts.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Account Information
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Account Information
24

35
## USER AND ACCOUNT INFORMATION FOR CURRENT USER
46

@@ -52,4 +54,4 @@ HTTP Response: 200 Success
5254
<timestamp-timers type="boolean">false</timestamp-timers>
5355
</user>
5456
</hash>
55-
```
57+
```

Sections/Client Contacts.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Client Contacts
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Client Contacts
24

35
## GET ALL CONTACTS FOR AN ACCOUNT
46

@@ -133,4 +135,4 @@ You can update selected attributes for a client contact.
133135

134136
DELETE `/contacts/#{contact_id}`
135137

136-
HTTP Response: 200 OK
138+
HTTP Response: 200 OK

Sections/Clients.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Clients
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Clients
24

35
## GET ALL CLIENTS
46

@@ -135,4 +137,4 @@ Note that if the client has active projects, Harvest will return HTTP Response:
135137

136138
DELETE `/clients/#{client_id}`
137139

138-
If client does not have associated projects or invoices Harvest deletes it and returns HTTP Response: 200 OK otherwise client is not deleted and you'll get a HTTP Response: 400 Bad Request .
140+
If client does not have associated projects or invoices Harvest deletes it and returns HTTP Response: 200 OK otherwise client is not deleted and you'll get a HTTP Response: 400 Bad Request .

Sections/Estimates.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1-
# Estimates
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Estimates
24

35
Currently, the Harvest API does not have support for Estimates. We do not have a timeline for deploying Estimate support in the API.

Sections/Expense Categories.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Expense Categories
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Expense Categories
24

35
## SHOW ALL EXPENSE CATEGORIES
46

Sections/Expense Tracking.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Expense Tracking API
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Expense Tracking API
24

35
The Expense tracking API allows you to access and manipulate expense entries in similar fashion to using the weekly expensesheet view. This allows developers to create lightweight clients or widgets to track expenses beyond directly interacting with Harvest through the web browser.
46

Sections/Invoice Categories.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Invoice Item Categories
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Invoice Item Categories
24

35
Important: this assumes invoice feature is enabled for your account.
46

@@ -74,4 +76,4 @@ HTTP Response: 200 OK.
7476

7577
HTTP Response: 400 Bad Request
7678

77-
Returned if category is not removable (default categories can only be edited).
79+
Returned if category is not removable (default categories can only be edited).

Sections/Invoice Messages.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Invoice Messages
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Invoice Messages
24

35
Important: this assumes invoice feature is enabled for your account.
46

Sections/Invoice Payments.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Invoice Payments
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Invoice Payments
24

35
Important: this assumes invoice feature is enabled for your account.
46

@@ -72,4 +74,4 @@ DELETE `/invoices/#{invoice_id}/payments/#{payment_id}`
7274

7375
HTTP Response: 200 OK.
7476

75-
Payment related invoice attributes like due-amount will be updated. Invoice status will be set to paid if no amount is left due.
77+
Payment related invoice attributes like due-amount will be updated. Invoice status will be set to paid if no amount is left due.

Sections/Invoices.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Invoices
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Invoices
24

35
Important: this assumes that the invoice feature is enabled for your account (via. "Choose Modules" on your Account Settings page).
46

Sections/People.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# People
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## People
24

35
## SHOW A USER
46

Sections/Projects.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Projects
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Projects
24

35
## SHOW A PROJECT
46

Sections/Task Assignment.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Task Assignment: Assigning tasks to projects
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Task Assignment: Assigning tasks to projects
24

35
## GET ALL TASKS ASSIGNED TO A GIVEN PROJECT
46

@@ -115,4 +117,4 @@ You will have to post the following:
115117
<budget type="decimal">3234</budget>
116118
<hourly-rate type="decimal">100</hourly-rate>
117119
</task-assignment>
118-
```
120+
```

Sections/Tasks.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Tasks
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Tasks
24

35
## SHOW ONE TASK
46

Sections/Time Tracking.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Time Tracking API
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Time Tracking API
24

35
The Time tracking API allows you to access and manipulate time entries in similar fashion to using the daily timesheet view. This allows developers to create lightweight clients or widgets to track time beyond directly interacting with Harvest through the web browser.
46

Sections/Time and Expense Reporting.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Time and Expense Reporting
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## Time and Expense Reporting
24

35
Harvest provides a powerful reporting interface along with CSV export. If you need to get raw data in a scriptable manner, Harvest provides direct XML export through the Reporting API. You can import XML data into other systems or create your own custom reporting interfaces on top of your Harvest account's data.
46

Sections/User Assignment.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# User Assignment: Assigning people to projects
1+
# This documentation is out of date. Please see our new API docs [here!](http://help.getharvest.com/api)
2+
3+
## User Assignment: Assigning people to projects
24

35
## GET ALL USERS ASSIGNED TO A GIVEN PROJECT
46

0 commit comments

Comments
 (0)