Add & Update Clients

Get all clients

GET https://YOURACCOUNT.harvestapp.com/clients

Examples

HTTP Response: 200 OK

[
  {
    "client": {
        "id": 8361719,
        "name": "Harvest327",
        "active": true,
        "currency": "United States Dollar - USD",
        "updated_at": "2019-04-15T16:25:50Z",
        "created_at": "2019-04-15T16:25:50Z",
        "statement_key": "cf64fef5b21f88d26cb2c3bd4b139a38",
        "default_invoice_timeframe": null,
        "address": null,
        "currency_symbol": "$",
        "details": null,
        "last_invoice_kind": null
    }
  }
]

Get a single client

GET https://YOURACCOUNT.harvestapp.com/clients/{CLIENTID}

Examples

HTTP Response: 200 OK

{
    "client": {
        "id": 8483698,
        "name": "My Client",
        "active": true,
        "currency": "United States Dollar - USD",
        "updated_at": "2019-04-15T16:25:50Z",
        "created_at": "2019-04-15T16:25:50Z",
        "statement_key": "cf64fef5b21f88d26cb2c3bd4b139a38",
        "default_invoice_timeframe": null,
        "address": "123 A St. \r\nSomewhere, NY 12345",
        "currency_symbol": "$",
        "details": "123 A St. \r\nSomewhere, NY 12345",
        "last_invoice_kind": null
    }
}

Create a new client

POST https://YOURACCOUNT.harvestapp.com/clients

To create a new client, you’ll need to POST the following. Only Name is required.

Parameter Description
Name New client name.
Currency The currency you’d like to use for the client.
Currency-Symbol The symbol that correlates to the selected currency.
Active Determines if the client is active, or archived. Options: true, false.
Details Additional details, normally used for address information.
  • Once created successfully, we’ll return HTTP Response: 201 Created, along with Location /clients/{NEWCLIENTID}

Examples

{
    "client": {
        "name": "Your Client",
        "active": true,
        "currency": "United States Dollar - USD",
        "currency_symbol": "$",
        "details": "123 Main St\r\nAnytown, NY 12345"
    }
}

Update a client

PUT https://YOURACCOUNT.harvestapp.com/clients/{CLIENTID}

You may update client attributes using this call. Once updated successfully, we’ll return HTTP Response: 200 OK, along with Location /clients/{CLIENTID}

Activate or deactivate an existing client

POST https://YOURACCOUNT.harvestapp.com/clients/{CLIENTID}/toggle

You may toggle an existing client to active, or archived using this call. Once updated successfully, we’ll return HTTP Response: 200 OK, along with Location /clients/{CLIENTID}

If the client has active projects, Harvest will return HTTP Response: 400 Bad Request, with a Hint header.

Delete a client

DELETE https://YOURACCOUNT.harvestapp.com/clients/{CLIENTID}

Still have questions? We’re happy to help!

Contact Us