Get a revenue

Get the revenue with the specified id

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Id of the specific revenue

Response

Response body
object
int64

Id of the revenue, required when updating an existing revenue

string

Status of the revenue

ACTIVE INACTIVE

string

Review status of the revenue

PARTNER_REVIEW_REQUIRED USER_REVIEW_REQUIRED ACCOUNTANT_REVIEW_REQUIRED RECONCILIATION_STAGED RECONCILED RECONCILIATION_DISCREPANCY ADJUSTMENT_USER_REVIEW_REQUIRED ADJUSTMENT_ACCOUNTANT_REVIEW_REQUIRED ADJUSTMENT_RECONCILIATION_STAGED

string

Access level for the user. This field uses the default configuration for the Partner; however, it can be overridden to manipulate how a user can interact with this revenue.

NONE READ_ONLY READ_WRITE

string

Access level for the accountant. This field uses the default configuration for the Partner; however, it can be overridden to manipulate how an accountant can interact with this revenue.

NONE READ_ONLY READ_WRITE

string

Type of the revenue

BUSINESS NOT_BUSINESS INVOICE_PAYMENT BANK_RECONCILED PENDING

date-time

Date of the revenue

number
required

Amount of the revenue

string

State in which this revenue was received, used to calculate sales tax amount

UNKNOWN AL AK AS AZ AR CA CO CT DE DC FM FL GA GU HI ID IL IN IA KS KY LA ME MD MH MA MI MN MS MO MT NE NV NH NJ NM NY NC ND MP OH OK OR PW PA PR RI SC SD TN TX UT VT VI VA WA WV WI WY AB BC MB NB NL NT NS NU ON PE QC SK YT

number

Sales tax amount for the revenue

string

Description of the revenue

int64

Id of the business assigned to this revenue, required for BUSINESS revenues

int64

Id of the client assigned to this revenue

string

Name of the client assigned to this revenue

string

Name of this business assigned to this revenue

string

Name of the original business on associated API

int64

Id of the invoice associated with this revenue

string

Id of the payment on associated API

string

Id of the user's bank account on associated API

string

Mask of the user's bank account, often the last 4 digits of the account number

string

Display name for the bank account from which this income originated

string

Name or id of the institution from which this transaction originated

int64
required

id of the user's bank account

int64

Bank transfer that paid out this revenue

string

Transaction description, similar to what will show on the user's bank statement

string

Type of currency on this revenue

USD CAD EUR GBP JPY

int64

Id of the GL account this revenue belongs to, defaults to the id of the 'Services Income' account

int64

Id of the rule that automatically classified this revenue

customData
object

Custom JSON in which you can store any data with max length of 2000 characters

Has additional fields
string

Id of the order associated with this revenue

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json