Get

Transactions
Content
1. GetTransactions_________________________________________________________ 1
1.1 Parameters _________________________________________________________________ 1
1.2 TransactionQuery ____________________________________________________________ 1
1.3 PageSettings _______________________________________________________________ 3
1.4 RateFilter __________________________________________________________________ 3
2. Return Types ___________________________________________________________ 4
2.1 GetTransactionsResponse _____________________________________________________ 4
2.2 Transaction ________________________________________________________________ 4
2.3 BasketInfo _________________________________________________________________ 5
2.4 RateInfo ___________________________________________________________________ 6
2.5 CreativeInfo ________________________________________________________________ 6

1. GetTransactions
Returns a collection of Sales, Leads and ClickOuts, which match the given search criteria. Along
with the PageSettings, either the input parameter TransactionIds or StartDate and EndDate must be
specified.
SOAP URL: https://api.affili.net/V2.0/PublisherStatistics.svc?wsdl

1.1 Parameters
Parameter

Type

Description

CredentialToken *

String

The authentification token you receive from the

method Logon

TransactionQuery *

TransactionQuery

Here you can specifiy the criteria which shall be

fulfilled by the transactions you wish to receive.

PageSettings *

PageSettings

Settings on how big each result set shall be.

1.2 TransactionQuery
Parameter

Type

Description

EndDate

DateTime

This parameter defines the end date for which the

statistics ought to be generated. It is included in the
evaluation. Currently only the date part is
considered.

NetPriceMax

Decimal

Lets you restrict the returned transactions to

th1,6ose with a NetPrice of no more than this limit.

NetPriceMin

Decimal

Lets you restrict the returned transactions to those

with a NetPrice of at least this limit or more.

ProgramIds

Array of Integer

This parameter defines the program IDs for which

the statistcs ought to be generated. Array must
contain no more than 200 ProgramIds

RateFilter

RateFilter

Restricts the returned transactions to only those of

the given commission type. Possible values are:
PayPerSale
PayPerLead
PayPerClickOut

Get Transactions: Publisher Webservices

Page 1

StartDate

DateTime

This parameter defines the start date for which the

statistics ought to be generated. It is included in the
evaluation. Currently only the date part is
considered.

SubId

String

Lets you restrict the returned transactions to only

those matching this SubId expression. The %
character can be used for wildcard searching. E.g.
%A%B%C% returns all transactions which contain
A, B and C somewhere within their SubId (in this
order). This string can hold up to 80 characters incl.
wildcards.

TransactionIds

Array of Integer

This parameter lets you access specific transactions

by their unique TransactionId. Up to 100
TransactionIds can be specified with each request.
If this parameter is set, all other input parameters of
the TransactionQuery and the RateFilter must be
left empty. PageSettings still have to be defined.

TransactionStatus

Enumeration

Depicts the status of the sale or lead. Possible

values are:
Open
Confirmed
Cancelled
All
If not specified, then only open transactions will be
returned.

ValuationType

Enumeration

This parameter defines the event on which

StartDate and EndDate shall operate. Possible
values are:
DateOfRegistration: this is when the transaction
has been created in our system.
DateOfConfirmation: this is the date when the
transaction has last been edited by the
advertiser. So if you want to know what
changed on your transactions yesterday, send
a request, where you set StartDate and
EndDate to the previous day and ValuationType
to DateOfConfirmation. Then you get all
transactions, which have been confirmed or
cancelled, got an adjusted NetPrice etc...
yesterday.
If not specified, DateOfRegistration is assumed.

Get Transactions: Publisher Webservices

Page 2

1.3 PageSettings
Property

Type

Description

CurrentPage

Integer

The number of the page of transactions which shall

be returned. Must be 1 or bigger.

PageSize

Integer

The amount of transactions you would like to see

per page. Must be between 1 and 100.

Property

Type

Description

RateMode

Enumeration

Restricts the returned transactions to only those of

the given commission type. Possible values are:
PayPerSale
PayPerLead
PayPerClickOut

1.4 RateFilter

If not specified, PayPerClickOut is assumed.

RateNumber

Integer

Get Transactions: Publisher Webservices

Each program can have several sale, lead or

clickout rates. With this parameter, you can restrict
the output to only those of a given rate. If
RateNumber is specified, then RateMode is also
required, and we recommend to also specify one
ProgramId, because e.g. lead rate number 3 can
mean two totally different things in two different
programs.

Page 3

2. Return Types
2.1 GetTransactionsResponse
Property

Type

Description

TotalRecords

Integer

The total amount of transactions matching the given

search criteria.

TransactionCollection

Array of Transaction

The transactions matching the given search criteria.

2.2 Transaction
Property

Type

Description

BasketInfo

BasketInfo

Some affilinet advertisers are using basket tracking,

so certain transactions can be grouped together in
one basket. If this transaction is part of a basket,
then this element contains basic information about
the basket. Otherwise, it is null.

CancellationReason

String

If a transaction has been cancelled or the NetPrice

has been reduced by the advertiser, he has to
specify a reason.

CheckDate

DateTime

The timestamp when the status of the transaction

was last changed.

ClickDate

DateTime

The timestamp when the click has been recorded,

which led to this transaction.

CreativeInfo

CreativeInfo

Detailed information on the creative, which was

used to transfer the customer to the advertiser.

NetPrice

Decimal

This is what has been transmitted as the net value

of the customers action. For sale transactions, this
is the base for the calculation of the commission.
For lead transactions, NetPrice is optional.

ProgramId

Integer

The ID of the program for which the transaction has

been generated.

ProgramTitle

String

The name of the program.

PublisherCommission

Decimal

Total amount of money this transaction is worth for

the requesting publisher. The currency is tied to the
country of the publisher: GBP for English publisher
accounts, EUR for all others.

RateInfo

RateInfo

Detailed information on the rate, which has been

used for this transaction.

Get Transactions: Publisher Webservices

Page 4

RegistrationDate

DateTime

The timestamp when the transaction has been

recorded in our database.

SubId

String

The SubId you have specified with the event, which

led to this transaction.

TrackingMethod

Enumeration

The recording method, which has been used to

create the transaction. Possible values are
PostClick
EfficientReach
IP
Fingerprint

TransactionId

Integer

The unique identifier of this transaction within our

database.

TransactionStatus

Enumeration

The status, which the transaction currently has.

Possible values are
Open
Confirmed
Cancelled

Property

Type

Description

BasketId

Integer

The unique Id of this basket within the affilinet

system. This Id can be used to request the single
basket items, using the method GetBasketItems.

OpenBasketItemCount

Integer

The amount of basket items, which have not been

cancelled by the advertiser. Only not cancelled
basket items are used to calculate the publisher
commission.

RegisteredNetPrice

Double

The total value of the basket, regardless of the

status of the contained basket items.

TotalBasketItemCount

Integer

The total amount of items within this basket,

regardless of their status.

2.3 BasketInfo

Get Transactions: Publisher Webservices

Page 5

2.4 RateInfo
Property

Type

Description

IsTieredCommission

Boolean

Open transactions, which have a tiered commission,

are normally worked on only once each month, and
are flagged with this field. For confirmed and
cancelled transactions, this flag is NULL.

RateDescription

String

A description of the applied rate. Normally this is the

rate name.

RateMode

Enumeration

The mode of the commission. Possible values are:

PayPerSale
PayPerLead
PayPerClickOut

RateNumber

Integer

The ID of the applied rate.

2.5 CreativeInfo
Property

Type

Description

CreativeNumber

Integer

The identifier of the creative which triggered this

transaction. ProgramId, CreativeType and
CreativeNumber form a unique key within the
affilinet platform.

CreativeType

Enumeration

The type of the creative which triggered this

transaction. Possible values are:
Banner
TextLink
Form
Html
BannerRotation
BannerOverwrite

Get Transactions: Publisher Webservices

Page 6