api

package

Go to main page

Versions in this module

v0

v0.1.1

Jun 10, 2026

v0.1.0

Feb 4, 2026

Changes in this version

+ const BaseURL

+ const CircuitBreakerResetTime

+ const CircuitBreakerThreshold

+ const ContentType

+ const DefaultBaseDelay

+ const DefaultMaxRetries429

+ const DefaultMaxRetries5xx

+ const ExitAuth

+ const ExitError

+ const ExitNotFound

+ const ExitRateLimit

+ const ExitSuccess

+ const ExitUsage

+ const ServerErrorRetryDelay

+ var ErrNotAuthenticated = errors.New("not authenticated")

+ var ErrNotFound = errors.New("not found")

+ var ErrRateLimited = errors.New("rate limit exceeded")

+ func ExitCode(err error) int

+ type APIError struct

+ Details string

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ func (e *APIError) ExitCode() int

+ type AuthError struct

+ Err error

+ func (e *AuthError) Error() string

+ func (e *AuthError) Unwrap() error

+ type CircuitBreaker struct

+ func NewCircuitBreaker() *CircuitBreaker

+ func (cb *CircuitBreaker) Failures() int

+ func (cb *CircuitBreaker) IsOpen() bool

+ func (cb *CircuitBreaker) RecordFailure() bool

+ func (cb *CircuitBreaker) RecordSuccess()

+ type CircuitBreakerError struct

+ func (e *CircuitBreakerError) Error() string

+ type Client struct

+ func NewClient(ts oauth2.TokenSource, accountID int64, contactEmail string) *Client

+ func NewClientWithBaseURL(ts oauth2.TokenSource, accountID int64, contactEmail, baseURL string) *Client

+ func (c *Client) ApproveTimeEntries(ctx context.Context, ids []int64) error

+ func (c *Client) CreateClient(ctx context.Context, input *ClientInput) (*HarvestClient, error)

+ func (c *Client) CreateEstimate(ctx context.Context, input *EstimateInput) (*Estimate, error)

+ func (c *Client) CreateEstimateMessage(ctx context.Context, estimateID int64, input *EstimateMessageInput) (*EstimateMessage, error)

+ func (c *Client) CreateExpense(ctx context.Context, input *ExpenseInput) (*Expense, error)

+ func (c *Client) CreateInvoice(ctx context.Context, input *InvoiceInput) (*Invoice, error)

+ func (c *Client) CreateInvoiceMessage(ctx context.Context, invoiceID int64, input *InvoiceMessageInput) (*InvoiceMessage, error)

+ func (c *Client) CreateInvoicePayment(ctx context.Context, invoiceID int64, input *InvoicePaymentInput) (*InvoicePayment, error)

+ func (c *Client) CreateProject(ctx context.Context, input *ProjectInput) (*Project, error)

+ func (c *Client) CreateTask(ctx context.Context, input *TaskInput) (*Task, error)

+ func (c *Client) CreateTimeEntry(ctx context.Context, input *TimeEntryInput) (*TimeEntry, error)

+ func (c *Client) CreateUser(ctx context.Context, input *UserInput) (*User, error)

+ func (c *Client) Delete(ctx context.Context, path string) error

+ func (c *Client) DeleteClient(ctx context.Context, id int64) error

+ func (c *Client) DeleteEstimate(ctx context.Context, id int64) error

+ func (c *Client) DeleteEstimateMessage(ctx context.Context, estimateID, messageID int64) error

+ func (c *Client) DeleteExpense(ctx context.Context, id int64) error

+ func (c *Client) DeleteInvoice(ctx context.Context, id int64) error

+ func (c *Client) DeleteInvoiceMessage(ctx context.Context, invoiceID, messageID int64) error

+ func (c *Client) DeleteInvoicePayment(ctx context.Context, invoiceID, paymentID int64) error

+ func (c *Client) DeleteProject(ctx context.Context, id int64) error

+ func (c *Client) DeleteTask(ctx context.Context, id int64) error

+ func (c *Client) DeleteTimeEntry(ctx context.Context, id int64) error

+ func (c *Client) DeleteTimeEntryExternalReference(ctx context.Context, id int64) error

+ func (c *Client) DeleteUser(ctx context.Context, id int64) error

+ func (c *Client) Get(ctx context.Context, path string, result any) error

+ func (c *Client) GetClient(ctx context.Context, id int64) (*HarvestClient, error)

+ func (c *Client) GetCompany(ctx context.Context) (*Company, error)

+ func (c *Client) GetEstimate(ctx context.Context, id int64) (*Estimate, error)

+ func (c *Client) GetExpense(ctx context.Context, id int64) (*Expense, error)

+ func (c *Client) GetExpenseCategory(ctx context.Context, id int64) (*ExpenseCategory, error)

+ func (c *Client) GetInvoice(ctx context.Context, id int64) (*Invoice, error)

+ func (c *Client) GetMe(ctx context.Context) (*User, error)

+ func (c *Client) GetProject(ctx context.Context, id int64) (*Project, error)

+ func (c *Client) GetReports(ctx context.Context, path string, result any) error

+ func (c *Client) GetReportsLimiterStatus() (int, bool)

+ func (c *Client) GetRunningTimeEntry(ctx context.Context) (*TimeEntry, error)

+ func (c *Client) GetTask(ctx context.Context, id int64) (*Task, error)

+ func (c *Client) GetTimeEntry(ctx context.Context, id int64) (*TimeEntry, error)

+ func (c *Client) GetUser(ctx context.Context, id int64) (*User, error)

+ func (c *Client) ListAllClients(ctx context.Context, opts ClientListOptions) ([]HarvestClient, error)

+ func (c *Client) ListAllEstimateMessages(ctx context.Context, estimateID int64, opts EstimateMessageListOptions) ([]EstimateMessage, error)

+ func (c *Client) ListAllEstimates(ctx context.Context, opts EstimateListOptions) ([]Estimate, error)

+ func (c *Client) ListAllExpenseCategories(ctx context.Context, opts ExpenseCategoryListOptions) ([]ExpenseCategory, error)

+ func (c *Client) ListAllExpenseReportsByCategories(ctx context.Context, opts ReportListOptions) ([]ExpenseReportResult, error)

+ func (c *Client) ListAllExpenseReportsByClients(ctx context.Context, opts ReportListOptions) ([]ExpenseReportResult, error)

+ func (c *Client) ListAllExpenseReportsByProjects(ctx context.Context, opts ReportListOptions) ([]ExpenseReportResult, error)

+ func (c *Client) ListAllExpenseReportsByTeam(ctx context.Context, opts ReportListOptions) ([]ExpenseReportResult, error)

+ func (c *Client) ListAllExpenses(ctx context.Context, opts ExpenseListOptions) ([]Expense, error)

+ func (c *Client) ListAllInvoiceMessages(ctx context.Context, invoiceID int64, opts InvoiceMessageListOptions) ([]InvoiceMessage, error)

+ func (c *Client) ListAllInvoicePayments(ctx context.Context, invoiceID int64, opts InvoicePaymentListOptions) ([]InvoicePayment, error)

+ func (c *Client) ListAllInvoices(ctx context.Context, opts InvoiceListOptions) ([]Invoice, error)

+ func (c *Client) ListAllMyProjectAssignments(ctx context.Context) ([]ProjectAssignment, error)

+ func (c *Client) ListAllProjectBudgetReport(ctx context.Context, opts ProjectBudgetReportOptions) ([]ProjectBudgetReportResult, error)

+ func (c *Client) ListAllProjects(ctx context.Context, opts ProjectListOptions) ([]Project, error)

+ func (c *Client) ListAllTasks(ctx context.Context, opts TaskListOptions) ([]Task, error)

+ func (c *Client) ListAllTimeEntries(ctx context.Context, opts TimeEntryListOptions) ([]TimeEntry, error)

+ func (c *Client) ListAllTimeReportsByClients(ctx context.Context, opts ReportListOptions) ([]TimeReportResult, error)

+ func (c *Client) ListAllTimeReportsByProjects(ctx context.Context, opts ReportListOptions) ([]TimeReportResult, error)

+ func (c *Client) ListAllTimeReportsByTasks(ctx context.Context, opts ReportListOptions) ([]TimeReportResult, error)

+ func (c *Client) ListAllTimeReportsByTeam(ctx context.Context, opts ReportListOptions) ([]TimeReportResult, error)

+ func (c *Client) ListAllUninvoicedReport(ctx context.Context, opts ReportListOptions) ([]UninvoicedReportResult, error)

+ func (c *Client) ListAllUsers(ctx context.Context, opts UserListOptions) ([]User, error)

+ func (c *Client) ListClients(ctx context.Context, opts ClientListOptions) (*ClientsResponse, error)

+ func (c *Client) ListEstimateMessages(ctx context.Context, estimateID int64, opts EstimateMessageListOptions) (*EstimateMessagesResponse, error)

+ func (c *Client) ListEstimates(ctx context.Context, opts EstimateListOptions) (*EstimatesResponse, error)

+ func (c *Client) ListExpenseCategories(ctx context.Context, opts ExpenseCategoryListOptions) (*ExpenseCategoriesResponse, error)

+ func (c *Client) ListExpenseReportsByCategories(ctx context.Context, opts ReportListOptions) (*ExpenseReportsResponse, error)

+ func (c *Client) ListExpenseReportsByClients(ctx context.Context, opts ReportListOptions) (*ExpenseReportsResponse, error)

+ func (c *Client) ListExpenseReportsByProjects(ctx context.Context, opts ReportListOptions) (*ExpenseReportsResponse, error)

+ func (c *Client) ListExpenseReportsByTeam(ctx context.Context, opts ReportListOptions) (*ExpenseReportsResponse, error)

+ func (c *Client) ListExpenses(ctx context.Context, opts ExpenseListOptions) (*ExpensesResponse, error)

+ func (c *Client) ListInvoiceMessages(ctx context.Context, invoiceID int64, opts InvoiceMessageListOptions) (*InvoiceMessagesResponse, error)

+ func (c *Client) ListInvoicePayments(ctx context.Context, invoiceID int64, opts InvoicePaymentListOptions) (*InvoicePaymentsResponse, error)

+ func (c *Client) ListInvoices(ctx context.Context, opts InvoiceListOptions) (*InvoicesResponse, error)

+ func (c *Client) ListMyProjectAssignments(ctx context.Context, opts MyProjectAssignmentsOptions) (*MyProjectAssignmentsResponse, error)

+ func (c *Client) ListProjectBudgetReport(ctx context.Context, opts ProjectBudgetReportOptions) (*ProjectBudgetReportResponse, error)

+ func (c *Client) ListProjects(ctx context.Context, opts ProjectListOptions) (*ProjectsResponse, error)

+ func (c *Client) ListTasks(ctx context.Context, opts TaskListOptions) (*TasksResponse, error)

+ func (c *Client) ListTimeEntries(ctx context.Context, opts TimeEntryListOptions) (*TimeEntriesResponse, error)

+ func (c *Client) ListTimeReportsByClients(ctx context.Context, opts ReportListOptions) (*TimeReportsResponse, error)

+ func (c *Client) ListTimeReportsByProjects(ctx context.Context, opts ReportListOptions) (*TimeReportsResponse, error)

+ func (c *Client) ListTimeReportsByTasks(ctx context.Context, opts ReportListOptions) (*TimeReportsResponse, error)

+ func (c *Client) ListTimeReportsByTeam(ctx context.Context, opts ReportListOptions) (*TimeReportsResponse, error)

+ func (c *Client) ListUninvoicedReport(ctx context.Context, opts ReportListOptions) (*UninvoicedReportResponse, error)

+ func (c *Client) ListUsers(ctx context.Context, opts UserListOptions) (*UsersResponse, error)

+ func (c *Client) MarkEstimateAccepted(ctx context.Context, estimateID int64) (*EstimateMessage, error)

+ func (c *Client) MarkEstimateDeclined(ctx context.Context, estimateID int64) (*EstimateMessage, error)

+ func (c *Client) MarkEstimateDraft(ctx context.Context, estimateID int64) (*EstimateMessage, error)

+ func (c *Client) MarkEstimateSent(ctx context.Context, estimateID int64) (*EstimateMessage, error)

+ func (c *Client) MarkInvoiceClosed(ctx context.Context, id int64) (*Invoice, error)

+ func (c *Client) MarkInvoiceDraft(ctx context.Context, id int64) (*Invoice, error)

+ func (c *Client) MarkInvoiceOpen(ctx context.Context, id int64) (*Invoice, error)

+ func (c *Client) MarkInvoiceSent(ctx context.Context, id int64, eventType string) (*Invoice, error)

+ func (c *Client) Patch(ctx context.Context, path string, body, result any) error

+ func (c *Client) Post(ctx context.Context, path string, body, result any) error

+ func (c *Client) RejectTimeEntries(ctx context.Context, ids []int64) error

+ func (c *Client) RestartTimeEntry(ctx context.Context, id int64) (*TimeEntry, error)

+ func (c *Client) SetVersion(version string)

+ func (c *Client) StopTimeEntry(ctx context.Context, id int64) (*TimeEntry, error)

+ func (c *Client) SubmitTimeEntriesForApproval(ctx context.Context, ids []int64) error

+ func (c *Client) UnsubmitTimeEntries(ctx context.Context, ids []int64) error

+ func (c *Client) UpdateClient(ctx context.Context, id int64, input *ClientInput) (*HarvestClient, error)

+ func (c *Client) UpdateCompany(ctx context.Context, input *CompanyUpdateInput) (*Company, error)

+ func (c *Client) UpdateEstimate(ctx context.Context, id int64, input *EstimateInput) (*Estimate, error)

+ func (c *Client) UpdateExpense(ctx context.Context, id int64, input *ExpenseInput) (*Expense, error)

+ func (c *Client) UpdateInvoice(ctx context.Context, id int64, input *InvoiceInput) (*Invoice, error)

+ func (c *Client) UpdateProject(ctx context.Context, id int64, input *ProjectInput) (*Project, error)

+ func (c *Client) UpdateTask(ctx context.Context, id int64, input *TaskInput) (*Task, error)

+ func (c *Client) UpdateTimeEntry(ctx context.Context, id int64, input *TimeEntryInput) (*TimeEntry, error)

+ func (c *Client) UpdateUser(ctx context.Context, id int64, input *UserInput) (*User, error)

+ func (c *Client) UploadExpenseReceipt(ctx context.Context, expenseID int64, receiptPath string) (*Expense, error)

+ func (c *Client) WarnIfNearReportsLimit() string

+ type ClientInput struct

+ Address *string

+ Currency *string

+ IsActive *bool

+ Name string

+ type ClientListOptions struct

+ IsActive *bool

+ Page int

+ PerPage int

+ UpdatedSince string

+ func (o ClientListOptions) QueryParams() string

+ type ClientRef struct

+ ID int64

+ Name string

+ type ClientsResponse struct

+ Clients []HarvestClient

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ type Company struct

+ ApprovalFeature bool

+ BaseURI string

+ Clock string

+ ColorScheme string

+ CurrencyCodeDisplay string

+ CurrencySymbolDisplay string

+ DateFormat string

+ DecimalSymbol string

+ EstimateFeature bool

+ ExpenseFeature bool

+ FullDomain string

+ InvoiceFeature bool

+ IsActive bool

+ Name string

+ PlanType string

+ TeamFeature bool

+ ThousandsSeparator string

+ TimeFormat string

+ WantsTimestampTimers bool

+ WeekStartDay string

+ WeeklyCapacity int

+ type CompanyUpdateInput struct

+ WantsTimestampTimers *bool

+ WeeklyCapacity *int

+ type Estimate struct

+ AcceptedAt *time.Time

+ Amount float64

+ Client ClientRef

+ ClientKey string

+ CreatedAt time.Time

+ Creator UserRef

+ Currency string

+ DeclinedAt *time.Time

+ Discount *float64

+ DiscountAmount float64

+ ID int64

+ IssueDate string

+ LineItems []EstimateLineItem

+ Notes string

+ Number string

+ PurchaseOrder string

+ SentAt *time.Time

+ State string

+ Subject string

+ Tax *float64

+ Tax2 *float64

+ Tax2Amount float64

+ TaxAmount float64

+ UpdatedAt time.Time

+ type EstimateInput struct

+ ClientID int64

+ Currency *string

+ Discount *float64

+ IssueDate *string

+ LineItems []EstimateLineItem

+ Notes *string

+ Number *string

+ PurchaseOrder *string

+ Subject *string

+ Tax *float64

+ Tax2 *float64

+ type EstimateLineItem struct

+ Amount float64

+ Description string

+ Destroy bool

+ ID int64

+ Kind string

+ Quantity float64

+ Taxed bool

+ Taxed2 bool

+ UnitPrice float64

+ type EstimateListOptions struct

+ ClientID int64

+ From string

+ Page int

+ PerPage int

+ State string

+ To string

+ UpdatedSince string

+ func (o EstimateListOptions) QueryParams() string

+ type EstimateMessage struct

+ Body string

+ CreatedAt time.Time

+ EventType string

+ ID int64

+ Recipients []EstimateMessageRecipient

+ SendMeACopy bool

+ SentBy string

+ SentByEmail string

+ SentFrom string

+ SentFromEmail string

+ Subject string

+ UpdatedAt time.Time

+ type EstimateMessageInput struct

+ Body *string

+ EventType *string

+ Recipients []EstimateMessageRecipient

+ SendMeACopy *bool

+ Subject *string

+ type EstimateMessageListOptions struct

+ Page int

+ PerPage int

+ UpdatedSince string

+ func (o EstimateMessageListOptions) QueryParams() string

+ type EstimateMessageRecipient struct

+ Email string

+ Name string

+ type EstimateMessagesResponse struct

+ EstimateMessages []EstimateMessage

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ type EstimateRef struct

+ ID int64

+ type EstimatesResponse struct

+ Estimates []Estimate

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ type Expense struct

+ ApprovalStatus string

+ Billable bool

+ Client ClientRef

+ CreatedAt time.Time

+ ExpenseCategory ExpenseCategoryRef

+ ID int64

+ Invoice *InvoiceRef

+ IsBilled bool

+ IsClosed bool

+ IsLocked bool

+ LockedReason string

+ Notes string

+ Project ProjectRef

+ Receipt *Receipt

+ SpentDate string

+ TotalCost float64

+ Units float64

+ UpdatedAt time.Time

+ User UserRef

+ UserAssignment *UserAssignment

+ type ExpenseCategoriesResponse struct

+ ExpenseCategories []ExpenseCategory

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ type ExpenseCategory struct

+ CreatedAt time.Time

+ ID int64

+ IsActive bool

+ Name string

+ UnitName *string

+ UnitPrice *float64

+ UpdatedAt time.Time

+ type ExpenseCategoryListOptions struct

+ IsActive *bool

+ Page int

+ PerPage int

+ UpdatedSince string

+ func (o ExpenseCategoryListOptions) QueryParams() string

+ type ExpenseCategoryRef struct

+ ID int64

+ Name string

+ UnitName *string

+ UnitPrice *float64

+ type ExpenseInput struct

+ Billable *bool

+ DeleteReceipt *bool

+ ExpenseCategoryID int64

+ Notes *string

+ ProjectID int64

+ SpentDate string

+ TotalCost *float64

+ Units *int

+ UserID *int64

+ type ExpenseListOptions struct

+ ApprovalStatus string

+ ClientID int64

+ From string

+ IsBilled *bool

+ Page int

+ PerPage int

+ ProjectID int64

+ To string

+ UpdatedSince string

+ UserID int64

+ func (o ExpenseListOptions) QueryParams() string

+ type ExpenseReportResult struct

+ BillableAmount float64

+ ClientID int64

+ ClientName string

+ Currency string

+ ExpenseCategoryID int64

+ ExpenseCategoryName string

+ IsContractor bool

+ ProjectID int64

+ ProjectName string

+ TotalAmount float64

+ UserID int64

+ UserName string

+ type ExpenseReportsResponse struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ Results []ExpenseReportResult

+ TotalEntries int

+ TotalPages int

+ type ExpensesResponse struct

+ Expenses []Expense

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ type ExternalReference struct

+ AccountID string

+ GroupID string

+ ID string

+ Permalink string

+ Service string

+ ServiceIconURL string

+ type HarvestClient struct

+ Address string

+ CreatedAt time.Time

+ Currency string

+ ID int64

+ IsActive bool

+ Name string

+ StatementKey string

+ UpdatedAt time.Time

+ type Invoice struct

+ Amount float64

+ Client ClientRef

+ ClientKey string

+ ClosedAt *time.Time

+ CreatedAt time.Time

+ Creator *UserRef

+ Currency string

+ Discount *float64

+ DiscountAmount float64

+ DueAmount float64

+ DueDate string

+ Estimate *EstimateRef

+ ID int64

+ IssueDate string

+ LineItems []InvoiceLineItem

+ Notes string

+ Number string

+ PaidAt *time.Time

+ PaidDate *string

+ PaymentTerm string

+ PeriodEnd *string

+ PeriodStart *string

+ PurchaseOrder string

+ RecurringInvoiceID *int64

+ Retainer *RetainerRef

+ SentAt *time.Time

+ State string

+ Subject string

+ Tax *float64

+ Tax2 *float64

+ Tax2Amount float64

+ TaxAmount float64

+ UpdatedAt time.Time

+ type InvoiceExpensesImport struct

+ AttachReceipts bool

+ From string

+ SummaryType string

+ To string

+ type InvoiceInput struct

+ ClientID int64

+ Currency *string

+ Discount *float64

+ DueDate *string

+ EstimateID *int64

+ IssueDate *string

+ LineItems []InvoiceLineItemInput

+ LineItemsImport *InvoiceLineItemsImport

+ Notes *string

+ Number *string

+ PaymentTerm *string

+ PurchaseOrder *string

+ RetainerID *int64

+ Subject *string

+ Tax *float64

+ Tax2 *float64

+ type InvoiceLineItem struct

+ Amount float64

+ Description string

+ ID int64

+ Kind string

+ Project *ProjectRef

+ Quantity float64

+ Taxed bool

+ Taxed2 bool

+ UnitPrice float64

+ type InvoiceLineItemInput struct

+ Description *string

+ Destroy *bool

+ ID *int64

+ Kind string

+ ProjectID *int64

+ Quantity *float64

+ Taxed *bool

+ Taxed2 *bool

+ UnitPrice *float64

+ type InvoiceLineItemsImport struct

+ Expenses *InvoiceExpensesImport

+ ProjectIDs []int64

+ Time *InvoiceTimeImport

+ type InvoiceListOptions struct

+ ClientID int64

+ From string

+ Page int

+ PerPage int

+ ProjectID int64

+ State string

+ To string

+ UpdatedSince string

+ func (o InvoiceListOptions) QueryParams() string

+ type InvoiceMessage struct

+ AttachPDF bool

+ Body string

+ CreatedAt time.Time

+ EventType string

+ ID int64

+ IncludeLinkToClientInvoice bool

+ Recipients []InvoiceMessageRecipient

+ Reminder bool

+ SendMeACopy bool

+ SendReminderOn *string

+ SentBy string

+ SentByEmail string

+ SentFrom string

+ SentFromEmail string

+ Subject string

+ ThankYou bool

+ UpdatedAt time.Time

+ type InvoiceMessageInput struct

+ AttachPDF *bool

+ Body string

+ EventType string

+ IncludeLinkToClientInvoice *bool

+ Recipients []InvoiceMessageRecipient

+ SendMeACopy *bool

+ Subject string

+ ThankYou *bool

+ type InvoiceMessageListOptions struct

+ Page int

+ PerPage int

+ UpdatedSince string

+ func (o InvoiceMessageListOptions) QueryParams() string

+ type InvoiceMessageRecipient struct

+ Email string

+ Name string

+ type InvoiceMessagesResponse struct

+ InvoiceMessages []InvoiceMessage

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ type InvoicePayment struct

+ Amount float64

+ CreatedAt time.Time

+ ID int64

+ Notes string

+ PaidAt time.Time

+ PaidDate string

+ PaymentGateway *PaymentGatewayRef

+ RecordedBy string

+ RecordedByEmail string

+ TransactionID string

+ UpdatedAt time.Time

+ type InvoicePaymentInput struct

+ Amount float64

+ Notes string

+ PaidAt string

+ PaidDate string

+ type InvoicePaymentListOptions struct

+ Page int

+ PerPage int

+ UpdatedSince string

+ func (o InvoicePaymentListOptions) QueryParams() string

+ type InvoicePaymentsResponse struct

+ InvoicePayments []InvoicePayment

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ type InvoiceRef struct

+ ID int64

+ Number string

+ type InvoiceTimeImport struct

+ From string

+ SummaryType string

+ To string

+ type InvoicesResponse struct

+ Invoices []Invoice

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ type MyProjectAssignmentsOptions struct

+ Page int

+ PerPage int

+ func (o MyProjectAssignmentsOptions) QueryParams() string

+ type MyProjectAssignmentsResponse struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ ProjectAssignments []ProjectAssignment

+ TotalEntries int

+ TotalPages int

+ type NotFoundError struct

+ ID string

+ Resource string

+ func (e *NotFoundError) Error() string

+ type Pagination struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ type PaginationLinks struct

+ First string

+ Last string

+ Next string

+ Previous string

+ type PaymentGatewayRef struct

+ ID int64

+ Name string

+ type Project struct

+ BillBy string

+ Budget *float64

+ BudgetBy string

+ BudgetIsMonthly bool

+ Client ProjectClientRef

+ Code string

+ CostBudget *float64

+ CostBudgetIncludeExpenses bool

+ CreatedAt time.Time

+ EndsOn *string

+ Fee *float64

+ HourlyRate *float64

+ ID int64

+ IsActive bool

+ IsBillable bool

+ IsFixedFee bool

+ Name string

+ Notes string

+ NotifyWhenOverBudget bool

+ OverBudgetNotificationDate *string

+ OverBudgetNotificationPercentage float64

+ ShowBudgetToAll bool

+ StartsOn *string

+ UpdatedAt time.Time

+ type ProjectAssignment struct

+ Budget *float64

+ Client ClientRef

+ CreatedAt time.Time

+ HourlyRate *float64

+ ID int64

+ IsActive bool

+ IsProjectManager bool

+ Project ProjectRef

+ TaskAssignments []ProjectTaskAssignment

+ UpdatedAt time.Time

+ type ProjectBudgetReportOptions struct

+ IsActive *bool

+ Page int

+ PerPage int

+ func (o ProjectBudgetReportOptions) QueryParams() string

+ type ProjectBudgetReportResponse struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ Results []ProjectBudgetReportResult

+ TotalEntries int

+ TotalPages int

+ type ProjectBudgetReportResult struct

+ Budget *float64

+ BudgetBy string

+ BudgetIsMonthly bool

+ BudgetRemaining float64

+ BudgetSpent float64

+ ClientID int64

+ ClientName string

+ IsActive bool

+ ProjectID int64

+ ProjectName string

+ type ProjectClientRef struct

+ Currency string

+ ID int64

+ Name string

+ type ProjectInput struct

+ BillBy string

+ Budget *float64

+ BudgetBy string

+ BudgetIsMonthly *bool

+ ClientID int64

+ Code *string

+ CostBudget *float64

+ CostBudgetIncludeExpenses *bool

+ EndsOn *string

+ Fee *float64

+ HourlyRate *float64

+ IsActive *bool

+ IsBillable *bool

+ IsFixedFee *bool

+ Name string

+ Notes *string

+ NotifyWhenOverBudget *bool

+ OverBudgetNotificationPercentage *float64

+ ShowBudgetToAll *bool

+ StartsOn *string

+ type ProjectListOptions struct

+ ClientID int64

+ IsActive *bool

+ Page int

+ PerPage int

+ UpdatedSince string

+ func (o ProjectListOptions) QueryParams() string

+ type ProjectRef struct

+ Code string

+ ID int64

+ Name string

+ type ProjectTaskAssignment struct

+ Billable bool

+ Budget *float64

+ HourlyRate *float64

+ ID int64

+ IsActive bool

+ Task TaskRef

+ type ProjectsResponse struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ Projects []Project

+ TotalEntries int

+ TotalPages int

+ type RateLimitError struct

+ RetryAfter time.Duration

+ func (e *RateLimitError) Error() string

+ type RateLimiter struct

+ func NewGeneralRateLimiter() *RateLimiter

+ func NewRateLimiter(limit int, window time.Duration, proactive bool) *RateLimiter

+ func NewReportsRateLimiter() *RateLimiter

+ func (rl *RateLimiter) Remaining() int

+ func (rl *RateLimiter) UpdateFromHeaders(h http.Header)

+ func (rl *RateLimiter) Wait(ctx context.Context) error

+ type Receipt struct

+ ContentType string

+ FileName string

+ FileSize int64

+ URL string

+ type ReportListOptions struct

+ From string

+ Page int

+ PerPage int

+ To string

+ func (o ReportListOptions) QueryParams() string

+ type RetainerRef struct

+ ID int64

+ type RetryTransport struct

+ Base http.RoundTripper

+ BaseDelay time.Duration

+ CircuitBreaker *CircuitBreaker

+ MaxRetries429 int

+ MaxRetries5xx int

+ RateLimiter *RateLimiter

+ func NewRetryTransport(base http.RoundTripper) *RetryTransport

+ func (t *RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

+ type Task struct

+ BillableByDefault bool

+ CreatedAt time.Time

+ DefaultHourlyRate float64

+ ID int64

+ IsActive bool

+ IsDefault bool

+ Name string

+ UpdatedAt time.Time

+ type TaskAssignment struct

+ Billable bool

+ Budget *float64

+ CreatedAt time.Time

+ HourlyRate *float64

+ ID int64

+ IsActive bool

+ UpdatedAt time.Time

+ type TaskInput struct

+ BillableByDefault *bool

+ DefaultHourlyRate *float64

+ IsActive *bool

+ IsDefault *bool

+ Name string

+ type TaskListOptions struct

+ IsActive *bool

+ Page int

+ PerPage int

+ UpdatedSince string

+ func (o TaskListOptions) QueryParams() string

+ type TaskRef struct

+ ID int64

+ Name string

+ type TasksResponse struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ Tasks []Task

+ TotalEntries int

+ TotalPages int

+ type TimeEntriesResponse struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TimeEntries []TimeEntry

+ TotalEntries int

+ TotalPages int

+ type TimeEntry struct

+ ApprovalStatus string

+ Billable bool

+ BillableRate *float64

+ Budgeted bool

+ Client ClientRef

+ CostRate *float64

+ CreatedAt time.Time

+ EndedTime string

+ ExternalReference *ExternalReference

+ Hours float64

+ HoursWithoutTimer float64

+ ID int64

+ Invoice *InvoiceRef

+ IsBilled bool

+ IsClosed bool

+ IsLocked bool

+ IsRunning bool

+ LockedReason string

+ Notes string

+ Project ProjectRef

+ RoundedHours float64

+ SpentDate string

+ StartedTime string

+ Task TaskRef

+ TaskAssignment *TaskAssignment

+ TimerStartedAt *time.Time

+ UpdatedAt time.Time

+ User UserRef

+ UserAssignment *UserAssignment

+ type TimeEntryApprovalRequest struct

+ TimeEntryIDs []int64

+ type TimeEntryInput struct

+ EndedTime *string

+ ExternalReference *ExternalReference

+ Hours *float64

+ Notes *string

+ ProjectID int64

+ SpentDate string

+ StartedTime *string

+ TaskID int64

+ UserID *int64

+ type TimeEntryListOptions struct

+ ApprovalStatus string

+ ClientID int64

+ ExternalReferenceID string

+ From string

+ IsBilled *bool

+ IsRunning *bool

+ Page int

+ PerPage int

+ ProjectID int64

+ TaskID int64

+ To string

+ UpdatedSince string

+ UserID int64

+ func (o TimeEntryListOptions) QueryParams() string

+ type TimeReportResult struct

+ AvatarURL string

+ BillableAmount float64

+ BillableHours float64

+ ClientID int64

+ ClientName string

+ Currency string

+ IsContractor bool

+ ProjectID int64

+ ProjectName string

+ TaskID int64

+ TaskName string

+ TotalHours float64

+ UserID int64

+ UserName string

+ WeeklyCapacity int

+ type TimeReportsResponse struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ Results []TimeReportResult

+ TotalEntries int

+ TotalPages int

+ type UninvoicedReportResponse struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ Results []UninvoicedReportResult

+ TotalEntries int

+ TotalPages int

+ type UninvoicedReportResult struct

+ ClientID int64

+ ClientName string

+ Currency string

+ ProjectID int64

+ ProjectName string

+ TotalHours float64

+ UninvoicedAmount float64

+ UninvoicedExpenses float64

+ UninvoicedHours float64

+ type User struct

+ AccessRoles []string

+ AvatarURL string

+ CostRate *float64

+ CreatedAt time.Time

+ DefaultHourlyRate *float64

+ Email string

+ FirstName string

+ HasAccessToAllFutureProjects bool

+ ID int64

+ IsActive bool

+ IsContractor bool

+ LastName string

+ Roles []string

+ Telephone string

+ Timezone string

+ UpdatedAt time.Time

+ WeeklyCapacity int

+ func (u *User) FullName() string

+ type UserAssignment struct

+ Budget *float64

+ CreatedAt time.Time

+ HourlyRate *float64

+ ID int64

+ IsActive bool

+ IsProjectManager bool

+ UpdatedAt time.Time

+ type UserInput struct

+ AccessRoles []string

+ CostRate *float64

+ DefaultHourlyRate *float64

+ Email string

+ FirstName string

+ HasAccessToAllFutureProjects *bool

+ IsActive *bool

+ IsContractor *bool

+ LastName string

+ Roles []string

+ Timezone *string

+ WeeklyCapacity *int

+ type UserListOptions struct

+ IsActive *bool

+ Page int

+ PerPage int

+ UpdatedSince string

+ func (o UserListOptions) QueryParams() string

+ type UserRef struct

+ ID int64

+ Name string

+ type UsersResponse struct

+ Links PaginationLinks

+ NextPage *int

+ Page int

+ PerPage int

+ PreviousPage *int

+ TotalEntries int

+ TotalPages int

+ Users []User

+ type ValidationError struct

+ Fields map[string]string

+ func (e *ValidationError) Error() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL