API Reference
Request Access
Start typing to search…

Get tax payments

get https://sandbox.hurdlr.com/rest/v5/taxes/taxPayments

Get all tax payments for the authenticated user

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

Year filter (YYYY) - returns all records for the specified year. Null will return all data.

status
array of strings

Status filter - returns all tax payments for the specified statuses. Null or empty list will default to ACTIVE.

status
type
array of strings

Type filter - returns all tax payments for the specified types. Null or empty list will default to PENDING & CONFIRMED.

type
Headers
string

Date filter - returns all records updated after the specified date.

string

Cursor from the previous paginated response

int32

Page size, i.e. number of items to return per page

Response

Response body
object
data
array of objects

The list of entities

data
object
int64

Id of the tax payment, required when updating an existing tax payment

string

Status of the tax payment

ACTIVE INACTIVE

string

Review status of the tax payment

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 tax payment.

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 tax payment.

NONE READ_ONLY READ_WRITE

string

Type of the tax payment

CONFIRMED PENDING

string
required

Tax region of payment

FED STATE

string
required

Period of the payment

Q1 Q2 Q3 Q4

int32
required

Year for which tax payment was made

number
required

Total amount of the tax payment

date

Date of the tax payment

string

Description of the tax payment

int64
required

id of the user's bank account

string

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

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 tax payment originated

string

Name or id of the institution from which the transaction originated

customData
object

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

Has additional fields
date-time

Date filter - to be used in your subsequent request

string

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.

deletedIds
array of int32s

Ids of entities that no longer match the request's filter criteria since the request's lastUpdatedDate

deletedIds

Updated about 1 year ago

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

Updated about 1 year ago