Skip to main content
GET
/
v5
/
investments
/
gain
Get an investment gain
curl --request GET \
  --url https://sandbox.hurdlr.com/rest/v5/investments/gain \
  --header 'Authorization: Bearer <token>'
{
  "type": "OTHER_INTEREST",
  "date": "2022-01-04",
  "amount": 50.01,
  "id": 123,
  "status": "ACTIVE",
  "description": "<string>",
  "externalId": "<string>",
  "idPrefix": "COMPANY"
}

Documentation Index

Fetch the complete documentation index at: https://docs.tight.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

id
string
default:""
required

Id of the specific investment gain

Response

200 - application/json

Successful operation

type
enum<string>
required

Type of the investment gain

Available options:
OTHER_INTEREST,
FEDERAL_OR_TERRITORIES_INTEREST,
NON_QUALIFIED_DIVIDEND,
QUALIFIED_DIVIDEND,
TAX_FREE_INTEREST_OTHER_STATE,
SHORT_TERM_CAPITAL_GAIN,
SHORT_TERM_CAPITAL_GAIN_AMT,
LONG_TERM_CAPITAL_GAIN,
LONG_TERM_CAPITAL_GAIN_AMT,
SOCIAL_SECURITY_BENEFIT,
OTHER_INVESTMENT_INCOME,
OTHER_NON_INVESTMENT_INCOME,
TAX_FREE_INTEREST_IN_STATE,
TEN_NINETY_NINE
date
string<date>
required

Date of the investment gain

Example:

"2022-01-04"

amount
number
required

Total amount of the investment gain

Example:

50.01

id
number

Id of the investment gain, required when updating an existing investment gain

status
enum<string>

Status of the investment gain

Available options:
ACTIVE,
INACTIVE
description
string

Description of the investment gain

externalId
string
idPrefix
enum<string>
Available options:
COMPANY,
EMPLOYEE,
CLASS_SEGMENT,
CLASS_LABEL,
CUSTOMER,
BANK_ACCOUNT,
GL_ACCOUNT,
TRANSACTION_CATEGORY,
BANK_TRANSACTION,
PROCESSOR_TRANSACTION,
TRANSACTION_LINE_ITEM,
VENDOR,
TRANSACTION_RULE,
REVENUE_RULE,
INVOICE,
INVOICE_LINE_ITEM,
BILL,
BILL_LINE_ITEM,
PAYROLL,
PAYROLL_LINE_ITEM,
FINANCIAL_SUMMARY,
TASK,
CONVERSATION,
MESSAGE,
REACTION,
BUSINESS_TYPE,
TEMPLATE_CLASS_LABEL,
TEMPLATE_COA,
TEMPLATE_GL_ACCOUNT,
TEMPLATE_TRANSACTION_RULES,
MANUAL_JOURNAL_ENTRY,
GL_TRANSACTION,
ATTACHMENT,
CAR,
MILEAGE,
INTEGRATION,
TIME,
TIME_TYPE,
TAX_RETURN