Affiliate transactions

Get affiliate transactions

Returns a list of affiliate transactions that match the specified filters, including only the requested fields.

get/api/v1/partnership/transaction

Request

  • Base URL: https://cdn.app.axl.tech (the document declares no server; this is the origin it was published from)
  • URL: https://cdn.app.axl.tech/api/v1/partnership/transaction
  • Auth: API key in header Authorization

Query parameters

idstring

ID

excludeIdstring

Excluded ID

partnerIdstring

Affiliate ID

adminCreatorIdstring

ID of the admin who created the transaction

studentIdstring

Contact ID

orderIdstring

Order ID

partnerIdsstring[]

Affiliate IDs

adminCreatorIdsstring[]

IDs of the admins who created the transactions

studentIdsstring[]

Contact IDs

hasAdminCreatorIdboolean

Created by an admin

type'deposit' | 'withdrawal'

Type

createdDateFromstring date-time

Start of the creation date range

createdDateTostring date-time

End of the creation date range

amountFromnumber double

Minimum amount

amountTonumber double

Maximum amount

feeFromnumber double

Minimum commission

feeTonumber double

Maximum commission

deductionFromnumber double

Minimum deduction

deductionTonumber double

Maximum deduction

hasValidAfterDateboolean

Has a valid-after date

validAfterDateMoreDatestring date-time

Valid-after date later than

forAvailableAmountboolean

Amount available for withdrawal

timezoneOffsetMininteger

Time zone offset in minutes

skipEmptyListboolean

Ignore empty lists

itemsTotalinteger

Total items

takeinteger

Number of results per page

skipinteger

Number of records to skip

searchstring

Search phrase

sortNamestring

Property to sort by

sortType'asc' | 'desc'

Sort order

useSortboolean

Apply sorting

useBaseFilterboolean

Use base filter

useItemsTotalboolean

Count total records

softDeletedboolean

Soft-deleted

idsstring[]

List of unique identifiers

fieldsstring

Fields to return, using a flexible GraphQL-style syntax. For example, contact fields: {id,email,firstName} See the sample server response for the full list of fields.

Response

OK

successboolean

True if the error list is empty or missing, false otherwise.

resetTokenboolean

Tells the client that the authentication token must be reset.

Changes

No recorded changes to this operation across all 1 revision of this API.