Finance

Harvest Readiness

Read Harvest evidence for invoice readiness and unbilled-work review without changing provider records.

Explore 6 capabilities ↓

What you can build

  • Compare project/time evidence with existing invoices
  • Prepare an invoice-readiness exception list
  • Build reviewed drafts in OrgSDK without writing to the provider

Access and credentials

Reads only one configured Harvest account using the attached token: current identity, projects, time entries and invoices. Token permissions depend on the user and are broader than this plugin. No writes, timer controls, email, payments or deletion.

This plugin uses an API token. Store credentials in OrgSDK and select them for the project that needs access.

Example action

Verify the configured Harvest account

Use this call in a saved OrgSDK action after enabling the plugin and connecting a credential.

return await harvest.verifyConnection({});

Use with OrgSDK

OrgSDK gives external AI clients persistent projects and controlled execution. Plugins add optional tools to those projects. Each run uses pinned plugin versions, and project configuration determines which credentials they can use.

Set up OrgSDK locally ↗

The plugin’s toolkit

Capabilities

6 functions from this published version. Read calls retrieve or process information; write actions can change data in the connected service.

6 of 6 functions

Verify personal-token access to the configured account and read the current user; data visibility still depends on that user's permissions.

Parameters and return value

This call takes no parameters.

Returns Promise<{ accountId: string; user: HarvestUser }>

Read one page of projects, billing method, client references, budget and rate evidence available to the user.

Parameters and return value
ParameterTypeDetails
clientIdOptionalnumber—
isActiveOptionalboolean—
pageOptionalnumber1..10000; fetch one page per call.
pageSizeOptionalnumber1..100; defaults to 50.

Returns Promise<HarvestPage<HarvestProject>>

Read one project's billing method, client, code and budget for invoice-readiness review.

Parameters and return value
ParameterTypeDetails
projectIdnumber—

Returns Promise<HarvestProject>

Read one page of time entries with billed/running/approval flags, invoice references and rates visible to the user. Required dates bound the review period.

Parameters and return value
ParameterTypeDetails
fromstringInclusive YYYY-MM-DD; range at most 366 calendar days.
tostringInclusive YYYY-MM-DD.
projectIdOptionalnumber—
clientIdOptionalnumber—
isBilledOptionalboolean—
isRunningOptionalboolean—
approvalStatusOptional"unsubmitted" | "submitted" | "approved"—
pageOptionalnumber1..10000; fetch one page per call.
pageSizeOptionalnumber1..100; defaults to 50.

Returns Promise<HarvestPage<HarvestTimeEntry>>

Read one page of invoices with line-item project references, purchase orders, amounts and state for reconciliation. Invoice permission is required in Harvest.

Parameters and return value
ParameterTypeDetails
fromstringInclusive YYYY-MM-DD; range at most 366 calendar days.
tostringInclusive YYYY-MM-DD.
projectIdOptionalnumber—
clientIdOptionalnumber—
stateOptional"draft" | "open" | "paid" | "closed"—
pageOptionalnumber1..10000; fetch one page per call.
pageSizeOptionalnumber1..100; defaults to 50.

Returns Promise<HarvestPage<HarvestInvoice>>

Read one invoice including amounts, state, purchase order and project-linked line items. The public invoice access key is excluded.

Parameters and return value
ParameterTypeDetails
invoiceIdnumber—

Returns Promise<HarvestInvoice>