Module iris.lead

ballerinax/iris.lead Ballerina library

1.5.2

Overview

The IRIS Leads API v1.6.4 connector(https://www.iriscrm.com/api) OpenAPI specification. Connect with the Leads API to interact with your lead data.
Includes management of fields, user assignments, status changes, tasks, appointments, email, text messaging, and document attachments. Create custom reports without limits using the data already housed within your CRM.

Key Features

Programmatic access to create and manage resources via REST API
Access analytics, reports, and performance metrics
Manage user accounts and profiles
Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create a IRIS CRM account
Obtain tokens by following this guide

Quickstart

To use the IRIS Leads connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/iris.lead module into the Ballerina project.


import ballerinax/iris.lead;

Step 2: Create a new connector instance

Create a lead:ApiKeysConfig with the API key obtained, and initialize the connector with it.


lead:ApiKeysConfig config = {
    xApiKey: "<API_KEY>"
}
lead:Client baseClient = check new Client(config);

Step 3: Invoke connector operation

Now you can use the operations available within the connector. Note that they are in the form of remote operations.

Following is an example on how to get a list of leads using the connector.

Get a list of leads


public function main() returns error? {
    lead:InlineResponse20016 response = check baseClient->getLeads();
    log:printInfo(response.toString());
}

Use bal run command to compile and run the Ballerina program.

Clients

iris.lead: Client

Isolated

This is a generated connector for IRIS Leads API v1.6.4 OpenAPI specification. Connect with the Leads API to interact with your lead data.
Includes management of fields, user assignments, status changes, tasks, appointments, email, text messaging, and document attachments. Create custom reports without limits using the data already housed within your CRM.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a IRIS account and obtain tokens by following this guide.

init (ApiKeysConfig apiKeyConfig, string serviceUrl, ConnectionConfig config)

apiKeyConfig ApiKeysConfig - API keys for authorization

serviceUrl string - URL of the target service

config ConnectionConfig {} - The configurations to be used when initializing the connector

getLeads

Isolated FunctionRemote Function

function getLeads(int? page, int? perPage, string? sortBy, string sortDir, int? group, int? mid, int? campaign, int? 'source, int? status, int? category, int? user, string? dateFilter, string? startDate, string? endDate, string? email) returns InlineResponse200|error

Get a list of leads

Parameters

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

sortBy string? (default ()) - Sorting of leads by the field value

sortDir string (default "asc") - Direction of sorting

group int? (default ()) - Filter leads by a group id

mid int? (default ()) - Filter leads by a merchant id

campaign int? (default ()) - Filter leads by a campaign id

'source int? (default ()) - Filter leads by a source id

status int? (default ()) - Filter leads by a status id

category int? (default ()) - Filter leads by a status category id

user int? (default ()) - Filter leads by a user id

dateFilter string? (default ()) - Filtering leads by a date range depends on this filter

startDate string? (default ()) - Filter leads by a date in ISO 8601 format (Y-m-d\TH:i:sP) (Please note that + sign should be encoded to %2B)

endDate string? (default ()) - Filter leads by a date in ISO 8601 format (Y-m-d\TH:i:sP) (Please note that + sign should be encoded to %2B)

email string? (default ()) - Filter leads by a email

Return Type

InlineResponse200|error - A JSON array of leads

createLead

Isolated FunctionRemote Function

function createLead(V1LeadsBody payload) returns InlineResponse2001|error

Create a lead

Parameters

payload V1LeadsBody - Lead details

Return Type

InlineResponse2001|error - Lead has been created successfully

getDetailedLeadInformation

Isolated FunctionRemote Function

function getDetailedLeadInformation(int leadId) returns InlineResponse2002|error

Get detailed lead information

Parameters

leadId int - Lead Id

Return Type

InlineResponse2002|error - Detailed lead information

updateLead

Isolated FunctionRemote Function

function updateLead(int leadId, LeadsLeadidBody payload) returns InlineResponse2003|error

Update a lead

Parameters

leadId int - Lead Id

payload LeadsLeadidBody - Lead changes (send only fields you want to change)

Return Type

InlineResponse2003|error - Lead has been updated successfully

deleteRecordFromALeadRecordSet

Isolated FunctionRemote Function

function deleteRecordFromALeadRecordSet(int leadId, int catId, int recordId) returns InlineResponse2004|error

Delete record from a lead record set

Parameters

leadId int - Lead Id

catId int - Record category ID

recordId int - Record ID

Return Type

InlineResponse2004|error - The record has been deleted successfully

getAvailableLeadFields

Isolated FunctionRemote Function

function getAvailableLeadFields(int? page, int? perPage) returns InlineResponse2005|error

Get a list of available lead fields

Parameters

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse2005|error - A list of available fields

createNewLeadField

Isolated FunctionRemote Function

function createNewLeadField(LeadsFieldsBody payload) returns LeadField|error

Create a new lead field

Parameters

payload LeadsFieldsBody - LeadField data

Return Type

LeadField|error - Created field

getLeadField

Isolated FunctionRemote Function

function getLeadField(int fieldId) returns LeadField|error

Get a lead field

Parameters

fieldId int - Field Id

Return Type

LeadField|error - Get a lead field

updateLeadField

Isolated FunctionRemote Function

function updateLeadField(int fieldId, FieldsFieldidBody payload) returns LeadField|error

Update a lead field

Parameters

fieldId int - Field Id

payload FieldsFieldidBody - LeadField data

Return Type

LeadField|error - Updated field attributes

updateLeadFieldOrderPosition

Isolated FunctionRemote Function

function updateLeadFieldOrderPosition(int fieldId, LeadFieldOrder payload) returns InlineResponse2006|error

Update a lead field order position

Parameters

fieldId int - Field Id

payload LeadFieldOrder - LeadFieldOrder data

Return Type

InlineResponse2006|error - Updated Lead field order position

getAllLeadFieldTabs

Isolated FunctionRemote Function

function getAllLeadFieldTabs(int? page, int? perPage) returns InlineResponse2007|error

Get a list of all lead field tabs

Parameters

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse2007|error - A list of all lead field tabs

createLeadFieldTab

Isolated FunctionRemote Function

function createLeadFieldTab(LeadFieldTab payload) returns LeadFieldTab|error

Create a lead field tab

Parameters

payload LeadFieldTab - LeadFieldTab data

Return Type

LeadFieldTab|error - Create a lead field tab

getLeadFieldTab

Isolated FunctionRemote Function

function getLeadFieldTab(int tabId) returns LeadFieldTab|error

Get a lead field tab

Parameters

tabId int - Lead field tab Id

Return Type

LeadFieldTab|error - Lead field tab

updateLeadFieldTab

Isolated FunctionRemote Function

function updateLeadFieldTab(int tabId, LeadFieldTab payload) returns LeadFieldTab|error

Update a lead field tab

Parameters

tabId int - Lead field tab Id

payload LeadFieldTab - LeadFieldTab data

Return Type

LeadFieldTab|error - Updated lead field tab

getPricingTemplates

Isolated FunctionRemote Function

function getPricingTemplates(int? page, int? perPage) returns InlineResponse2008|error

Get pricing templates

Parameters

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse2008|error - A list of pricing templates

getLeadNotes

Isolated FunctionRemote Function

function getLeadNotes(int leadId, int? page, int? perPage) returns InlineResponse2009|error

Get lead notes

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse2009|error - A list of lead notes

createLeadNote

Isolated FunctionRemote Function

function createLeadNote(int leadId, LeadidNotesBody payload) returns InlineResponse20010|error

Create a lead note

Parameters

leadId int - Lead Id

payload LeadidNotesBody - Create a lead note

Return Type

InlineResponse20010|error - Note has been added successfully

getLeadAppointments

Isolated FunctionRemote Function

function getLeadAppointments(int leadId, int? page, int? setFor, int? setBy, int? modifiedBy, int? confirmedBy, int? rescheduledBy, int? seenBy, int? rescheduledCount, boolean? done, int? perPage, string? sortBy, string? sortDir, string? dateFilter, string? startDate, string? endDate) returns InlineResponse20011|error

Get lead appointments

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

setFor int? (default ()) - Filter by the user for who appointment was created

setBy int? (default ()) - Filter by the user for who have created an appointment

modifiedBy int? (default ()) - Filter by the user for who have modified an appointment

confirmedBy int? (default ()) - Filter by the user for who have confirmed an appointment

rescheduledBy int? (default ()) - Filter by the user for who have rescheduled an appointment

seenBy int? (default ()) - Filter by the user for who have mark an appointment as seen

rescheduledCount int? (default ()) - Filter by the count of rescheduling

done boolean? (default ()) - Filter by the done flag

perPage int? (default ()) - Count of records per page

sortBy string? (default ()) - Sort appointments by columns

sortDir string? (default ()) - Sort direction

dateFilter string? (default ()) - Filtering appointments by a date range depends on this filter

startDate string? (default ()) - Filter appointments by a date in format Y-m-d

endDate string? (default ()) - Filter leads by a date in format Y-m-d

Return Type

InlineResponse20011|error - A list of lead appointments

createLeadAppointment

Isolated FunctionRemote Function

function createLeadAppointment(int leadId, LeadidAppointmentsBody payload) returns InlineResponse20012|error

Create a lead appointment

Parameters

leadId int - Lead Id

payload LeadidAppointmentsBody - Create a lead appointment

Return Type

InlineResponse20012|error - Appointment has been created successfully

populatePdfDocument

Isolated FunctionRemote Function

function populatePdfDocument(int leadId, int applicationId) returns InlineResponse20013|error

Populate PDF Document

Parameters

leadId int - Lead Id

applicationId int - Application Id

Return Type

InlineResponse20013|error - Document populated successfully.

getLeadTasks

Isolated FunctionRemote Function

function getLeadTasks(int leadId, int? page, int? perPage) returns InlineResponse20014|error

Get lead tasks

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20014|error - A list of lead tasks

createLeadTask

Isolated FunctionRemote Function

function createLeadTask(int leadId, LeadidTasksBody payload) returns InlineResponse20015|error

Create a lead task

Parameters

leadId int - Lead Id

payload LeadidTasksBody - Create a lead task

Return Type

InlineResponse20015|error - Task has been created successfully

getAssignedUsers

Isolated FunctionRemote Function

function getAssignedUsers(int leadId, int? page, int? perPage) returns InlineResponse20016|error

Get a list of assigned users

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20016|error - A list of assigned users

assignUser

Isolated FunctionRemote Function

function assignUser(int leadId, LeadidUsersBody payload) returns InlineResponse20017|error

Assign a user

Parameters

leadId int - Lead Id

payload LeadidUsersBody - Create a lead task

Return Type

InlineResponse20017|error - User has been assigned successfully

unassignUserFromLead

Isolated FunctionRemote Function

function unassignUserFromLead(int leadId, int userId) returns InlineResponse20018|error

Unassign a user from a lead

Parameters

leadId int - Lead Id

userId int - User Id

Return Type

InlineResponse20018|error - User has been unassigned successfully

getAvailableDocuments

Isolated FunctionRemote Function

function getAvailableDocuments(int leadId, int? page, int? perPage) returns InlineResponse20019|error

Get a list of available documents

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20019|error - A list of available documents

getAvailableDocumentLabels

Isolated FunctionRemote Function

function getAvailableDocumentLabels(int? page, int? perPage) returns InlineResponse20020|error

Get a list of available document labels

Parameters

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20020|error - A list of available labels

downoladDocument

Isolated FunctionRemote Function

function downoladDocument(int leadId, int documentId) returns string|error

Download a document

Parameters

leadId int - Lead Id

documentId int - Document Id

Return Type

string|error - Document

getEmailTemplates

Isolated FunctionRemote Function

function getEmailTemplates() returns InlineResponse20021|error

Get a list of email templates

Return Type

InlineResponse20021|error - A list of available email templates

downloadMailboxEmailAttachment

Isolated FunctionRemote Function

function downloadMailboxEmailAttachment(int leadId, int emailId, int attachmentId) returns string|error

Download a mailbox email attachment

Parameters

leadId int - Lead Id

emailId int - Email Id

attachmentId int - Attachment Id

Return Type

string|error - Document

sendSmsToLeadWithSelectedSmsTemplate

Isolated FunctionRemote Function

function sendSmsToLeadWithSelectedSmsTemplate(int leadId, int templateId, SmsTemplateidBody payload) returns InlineResponse20022|error

Send an SMS to lead with selected SMS template

Parameters

leadId int - Lead Id

templateId int - Template Id

payload SmsTemplateidBody - Payload data

Return Type

InlineResponse20022|error - Result of proccess

getSmsTemplates

Isolated FunctionRemote Function

function getSmsTemplates() returns InlineResponse20023|error

Get list of SMS templates

Return Type

InlineResponse20023|error - A list of available SMS templates

getAllLeadCampaignActivity

Isolated FunctionRemote Function

function getAllLeadCampaignActivity(int leadId, int? page, int? perPage) returns InlineResponse20024|error

Get a list of all lead campaign activity

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20024|error - A list of activity

getAllLeadDeletionActivity

Isolated FunctionRemote Function

function getAllLeadDeletionActivity(int leadId, int? page, int? perPage) returns InlineResponse20025|error

Get a list of all lead deletion activity

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20025|error - A list of activity

getAllLeadDuplicateActivity

Isolated FunctionRemote Function

function getAllLeadDuplicateActivity(int leadId, int? page, int? perPage) returns InlineResponse20026|error

Get a list of all lead duplicate activity

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20026|error - A list of activity

getAllLeadLinksActivity

Isolated FunctionRemote Function

function getAllLeadLinksActivity(int leadId, int? page, int? perPage) returns InlineResponse20027|error

Get a list of all lead links activity

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20027|error - A list of activity

getAllLeadSourceActivity

Isolated FunctionRemote Function

function getAllLeadSourceActivity(int leadId, int? page, int? perPage) returns InlineResponse20028|error

Get a list of all lead source activity

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20028|error - A list of activity

getAllLeadStatusActivity

Isolated FunctionRemote Function

function getAllLeadStatusActivity(int leadId, int? page, int? perPage) returns InlineResponse20029|error

Get a list of all lead status activity

Parameters

leadId int - Lead Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20029|error - A list of activity

getAvailableApplications

Isolated FunctionRemote Function

function getAvailableApplications() returns BriefApplicationInfo[]|error

Get a list of available applications

Return Type

BriefApplicationInfo[]|error - A list of available applications

getAvailableApplicationFieldMappings

Isolated FunctionRemote Function

function getAvailableApplicationFieldMappings(int appId, int? page, int? perPage) returns InlineResponse20030|error

Get a list of available application field mappings

Parameters

appId int - Application Id

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20030|error - A list of available application field mappings

createNewApplicationFieldMapping

Isolated FunctionRemote Function

function createNewApplicationFieldMapping(int appId, ApplicationField payload) returns ApplicationField|error

Create a new application field mapping

Parameters

appId int - Application Id

payload ApplicationField -

Return Type

ApplicationField|error - Created new application field mapping

getAvailableCampaigns

Isolated FunctionRemote Function

function getAvailableCampaigns() returns InlineResponse20031|error

Get a list of available campaigns

Return Type

InlineResponse20031|error - A list of available campaigns

getAvailableGroups

Isolated FunctionRemote Function

function getAvailableGroups(int? status) returns InlineResponse20032|error

Get a list of available groups

Parameters

status int? (default ()) - Status Id

Return Type

InlineResponse20032|error - A list of available groups

getAvailableUsers

Isolated FunctionRemote Function

function getAvailableUsers(int? page, int? perPage) returns InlineResponse20016|error

Get a list of available users

Parameters

page int? (default ()) - Page number

perPage int? (default ()) - Count of records per page

Return Type

InlineResponse20016|error - A list of available users

Records

iris.lead: AdjustmentsInner

Fields

date? string - Adjustment date

'type? string - Adjustment type

amount? string - Adjustment amount

iris.lead: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields

xApiKey string - Represents API Key X-API-KEY

iris.lead: ApiUpdated

Fields

hook? ApiupdatedHook -

data? ApiupdatedData -

iris.lead: ApiupdatedData

Fields

'version? string - Version number

update? string - Should users do an update of their API clients functional

details? ApiupdatedDataDetails[] -

createdAt? string - Date and time of creation (ISO 8601)

iris.lead: ApiupdatedDataDetails

Fields

description? string - Description of update

link? string - Link to endpoint documentation

'type? string - Type of API update

iris.lead: ApiupdatedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: Apiv1leadsFields

Fields

id string - Field Id

'record? string - Record Id

value string - Field value

iris.lead: ApplicationField

Fields

id? int - Application field Id

'from int - Application field from field Id

'record? int - Application field record

to? string - Name of mapped field

toAlt? string - Alt of mapped field

toType? string - Type of mapped field

special? string - Special type of mapped field

info? ApplicationfieldInfo[] -

iris.lead: ApplicationfieldDuplicates

Fields

instance? int - Activity Id

left? int - Padding from left

right? int - Padding from right

top? int - Padding from top

bottom? int - Padding from bottom

height? int - Height of field

width? int - Width of field

page_number? int - Page number

iris.lead: ApplicationfieldInfo

Fields

field_name? string - Field name

field_type? string - Field type

left? int - Padding from left

right? int - Padding from right

top? int - Padding from top

bottom? int - Padding from bottom

field_height? int - Height of field

field_width? int - Width of field

page_number? int - Page number

page_height? int - Page height

page_width? int - Page width

page_rotation? int - Page rotation

export_value? string - Export value

duplicates? ApplicationfieldDuplicates[] -

iris.lead: ApplicationSubscription

Fields

id? int -

title? string -

group_id? int -

group_name? string -

iris.lead: BriefApplicationInfo

Fields

id? int - Application Id

name? string - Application name

'e\-sign? string - Is E-Sign available?

iris.lead: BriefCampaignInfo

Fields

id? int - Campaign Id

name? string - Campaign name

iris.lead: BriefCategoryInfo

Fields

id? int - Status category Id

name? string - Status category name

iris.lead: BriefEmailTemplate

Fields

id? int -

title? string -

iris.lead: BriefGroupInfo

Fields

id? int - Group Id

name? string - Group name

iris.lead: BriefLeadInfo

Fields

id? int - Lead Id

mid? int - Lead merchant Id

name? string - Lead name

group? BriefGroupInfo -

category? BriefCategoryInfo -

status? BriefStatusInfo -

campaign? BriefCampaignInfo -

'source? BriefSourceInfo -

created? string - Lead creation date (Y-m-d\TH:i:sP)

modified? string - Lead modification date (Y-m-d\TH:i:sP)

iris.lead: BriefMerchantInfo

Fields

mid? string - Merchant number

name? string - Merchant name

opened? string - Merchant open date

closed? string - Merchant closed date

created? string - Merchant created date

modified? string - Merchant modified date

first_batch? string - Merchant first batch date

last_batch? string - Merchant last batch date

group? string - Group name

processor? string - Processor name

datasource? string - Data source name

sic_code? string - SIC Code

vim? string - Is VIM?

deactivated? string - Merchant deactivation date

status? string - Merchant status

active? string - Merchant active flag

iris.lead: BriefSmsTemplate

Fields

id? int -

title? string -

iris.lead: BriefSourceInfo

Fields

id? int - Source Id

name? string - Source name

iris.lead: BriefStatusInfo

Fields

id? int - Status Id

name? string - Status name

iris.lead: BriefSubscriptionInfo

Fields

id? int - Subscription Id

url string - Subscription URL

events string[] - Subscription Events

options? BriefsubscriptioninfoOptions - Options for each event

multiple_at_once? boolean - Report multiple items in one request

iris.lead: BriefsubscriptioninfoOptions

Options for each event

Fields

'lead\.status\.updated? BriefsubscriptioninfoOptionsLeadStatusUpdated -

'lead\.created? BriefsubscriptioninfoOptionsLeadCreated -

'lead\.note\.added? BriefsubscriptioninfoOptionsLeadNoteAdded -

'lead\.document\.uploaded? BriefsubscriptioninfoOptionsLeadDocumentUploaded -

'lead\.email\.received? BriefsubscriptioninfoOptionsLeadEmailReceived -

iris.lead: BriefsubscriptioninfoOptionsLeadCreated

Fields

statuses? int[] - Statuses with which a created lead should be reported (any if not specified)

iris.lead: BriefsubscriptioninfoOptionsLeadDocumentUploaded

Fields

statuses? int[] - Statuses of leads whose uploaded documents should be reported (any if not specified)

iris.lead: BriefsubscriptioninfoOptionsLeadEmailReceived

Fields

statuses? int[] - Statuses of leads whose received emails should be reported (any if not specified)

iris.lead: BriefsubscriptioninfoOptionsLeadNoteAdded

Fields

statuses? int[] - Statuses of leads whose added notes should be reported (any if not specified)

iris.lead: BriefsubscriptioninfoOptionsLeadStatusUpdated

Fields

previousStatuses? int[] - Statuses from which a lead should be updated to report the update (any if not specified)

newStatuses? int[] - Statuses to which a lead should be updated to report the update (any if not specified)

iris.lead: BriefTabInfo

Fields

id? int - Tab Id

name? string - Tab name

iris.lead: BriefTicketChecklistInfo

Fields

id? int - Checklist item Id

template_id? int - Checklist template Id

name? string - Checklist item name

index? int - Index in list

required? boolean - Flag is checklist are required

fileRequired? boolean - Flag is checklist file are required

commentRequiredToDoneTicket? boolean - Flag is comment are required to resolve ticket

commentRequiredToDoneItem? boolean - Flag is checklist are required to resolve checklist item

commentedAt? anydata - Datetime when user have commented checklist item

commentedBy? int - User Id of user who have commented checklist item

iris.lead: BriefTicketComments

Fields

id? int - Comment id

ticketId? int - Ticket id

comment? string - Comment text

created? string - Comment created date

createdBy? int - Comment creator id

modified? string - Comment modified date

modifiedBy? int - Id of user who left comment

files? File[] -

preview_images? File[] -

merchantVisible? boolean - Indicates if the comment is visible to Merchant users

iris.lead: BriefTicketInfo

Fields

Fields Included from *Ticket

id int
subject string
description string
status TicketStatus
type TicketType
group TicketGroup
priority TicketPriority
lead_id int
mid int
merchantVisible boolean
anydata...

Fields Included from *TicketCreatedBlock

created string
created_by int
anydata...

modified? string - Ticket modified date

modified_by? int - Id of user who made last change

resolved? string - Ticket resolved date

resolved_by? int - Id of user who made last change

due_date? string - Ticket due date

due? string - Ticket SLA

only_business_days? boolean - Calculate only business days

last_comment? string - Ticket last comment date

files_count? int - Count of ticket files

iris.lead: BriefTicketTypeInfo

Fields

id? int - Ticket type id

name? string - Ticket type name

description? string - Ticket type description

daysToResolve? int - Days to Resolve

only_business_days? boolean - Calculate only business days

status? TicketStatus -

priority? TicketPriority -

created? string - Ticket type created date

createdBy? int - Ticket type creator id

modified? string - Ticket type modified date

modifiedBy? int - Id of user who made last change

'order? int - Ticket type order

permissions? int[] -

due_date? string - Ticket due date

assignees? BrieftickettypeinfoAssignees -

iris.lead: BrieftickettypeinfoAssignees

Fields

everyTime? int[] -

roundRobin? int[] -

iris.lead: BriefTicketUsersInfo

Fields

id? int - User id

name? string - User name

'class? string - User class

iris.lead: BriefUserInfo

Fields

id? int - User Id

name? string - User name

iris.lead: BriefUserInfoWithClass

Fields

id? int - User Id

username? string - User username

full_name? string - User name

email? string - User email

status? string - User status

'class? string - User class

iris.lead: CampaignActivity

Fields

id? int - Activity Id

newValue? string - New value of activity

assignedBy? int - User Id

assignedAt? string - Assigned date (Y-m-d\TH:i:sP)

iris.lead: CategoryWithStatuses

Fields

id? int - Status category Id

name? string - Status category name

statuses? BriefStatusInfo[] -

iris.lead: Chargeback

Fields

id? int - Chargeback internal ID

merchant_id? string - Merchant ID

dba? string - Merchant DBA

case_number? string - Case number

chargeback_date? string - Chargeback date

transaction_date? string - Transaction date

respond_due? string - Respond due date

amount? string - Amount

original_amount? string - Original amount of transaction

currency? string - Transaction currency

reason? string - Chargeback reason

reason_code? string - Chargeback reason code

card_number? string - Cardholder number

reply_form? string - Reply form type. Affects reply options.

cycle_indicator? string - Chargeback cycle indicator

transaction_id? string - Transaction ID

reference_number? string - Transaction ID

case_status? string - Case status

case_status_description? string - Status description

mcc? string - MCC code

dispute_jurisdiction? string - Dispute jurisdiction

card_product_type? string - Card product

process_date? string - Process date

transaction_method? string - Transaction method

invoice_number? string - Invoice number

microfilm_number? string - Microfilm number

airline_ticket_number? string - Airline ticket number

order_number? string - Order number

tracking_number? string - Tracking number

last_status_date? string - Date of the last status update

updated_at? string - Date of the most recent update

case_action? string - Case action

action? string - Can the case be viewed of replied

foreign_amount? string - Foreign amount of transaction

transaction_locator? string - Transaction locator

authorization_code? string - Authorization code

'type? string - Chargeback type

iris.lead: ChargebackAdded

Fields

hook? ChargebackaddedHook -

data? ChargebackaddedData -

iris.lead: ChargebackaddedData

Fields

chargebacks? ChargebackReplyResponse[] -

iris.lead: ChargebackaddedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: ChargebackReminder

Fields

hook? ChargebackreminderHook -

data? ChargebackreminderData -

iris.lead: ChargebackreminderData

Fields

chargebacks? record { due_in int }[] -

iris.lead: ChargebackreminderHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: ChargebackReplyCreditIssuedRequest

Fields

credit_date string - Credit transaction date

credit_amount string - Credit transaction amount

user_note string - User note

file string[] - Files to attach

iris.lead: ChargebackReplyDisputeRequest

Fields

selected_doc_types string - Selected documents

other_description? string - Other document description

compelling_doc? string - Compelling document

selected_compelling? string - Selected compelling

selected_digital_goods_04? string - Digital goods compelling documents

download_date? string - Download date

download_time? string - Download time

purchaser_ip_addr? string - Purchaser IP address

geographical_location? string - Physical location

device_id? string - PhDevice ID

device_name? string - Device ID

purchaser_name? string - Purchaser name

purchaser_email? string - Purchaser email

arn_04? string - ARN

tran_date_04? string - Transaction date

arn_09? string - ARN

tran_date_09? string - Transaction date

arn_13? string - ARN

tran_date_13? string - Transaction date

ip_address? string - IP address

email_address? string - Email address

phone_number? string - Phone number

physical_address? string - Physical address

user_note string - User note

file string[] - Files to attach

iris.lead: ChargebackReplyResponse

Fields

chargeback? ChargebackreplyresponseChargeback -

items? ChargebackreplyresponseItems -

Fields Included from *DisputeDetailsResponse

transactions DisputedetailsresponseTransactions[]
auth_records DisputedetailsresponseTransactions[]
notes DisputedetailsresponseNotes[]
messages DisputedetailsresponseMessages[]
directories DisputedetailsresponseDirectories[]
anydata...

iris.lead: ChargebackreplyresponseChargeback

Fields

id? string -

merchant_id? string -

dba? string -

cycle_indicator? string -

date? string -

transaction_date? string -

amount? string -

reason_code? string -

reason? string -

card_number? string -

case_number? string -

case_action? string -

action? string -

reply_form? string -

case_status? string -

case_status_description? string -

last_status_date? string -

respond_due? string -

original_amount? string -

updated_at? string -

mcc? string -

dispute_jurisdiction? string -

card_product_type? string -

process_date? string -

transaction_method? string -

invoice_number? string -

microfilm_number? string -

airline_ticket_number? string -

order_number? string -

tracking_number? string -

iris.lead: ChargebackreplyresponseItems

Fields

reason? string -

message_from_bank? string -

merchant_due_date? string -

financial_disposition_date? string -

'type? string -

iris.lead: ChargebackUpdated

Fields

hook? ChargebackupdatedHook -

data? ChargebackaddedData -

iris.lead: ChargebackupdatedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: ChecklistFullInfo

Fields

Fields Included from *BriefTicketChecklistInfo

id int
template_id int
name string
index int
required boolean
fileRequired boolean
commentRequiredToDoneTicket boolean
commentRequiredToDoneItem boolean
commentedAt anydata
commentedBy int
anydata...

completed? boolean - Flag is checklist are done

completed_by? int - User ID who compleated the checklist

completed_at? anydata - Datetime when user have completed the checklist item

files? File[] -

iris.lead: CheckListRequest

Fields

index? int - Checklist item index

files? string[] -

attached_files? int[] -

completed? boolean - Flag checklist are item completed

comment? string - Comment for checklist item

iris.lead: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy? ProxyConfig - Proxy server related options

iris.lead: CommentSubscriptionData

Fields

ticket_url? string -

assignedUsers? UserListStructure -

files? File[] -

merchantVisible? boolean - Indicates if the comment is visible for Merchant users

iris.lead: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol

http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache? CacheConfig - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

iris.lead: DeletionActivity

Fields

id? int - Activity Id

deletedId? int - User Id

deletedAt? string - Date of deletion (Y-m-d\TH:i:sP)

undeletedId? int - User Id

undeletedAt? string - Date of undeletion (Y-m-d\TH:i:sP)

iris.lead: DepositsInner

Fields

date? string - Deposit date

amount? string - Deposit amount

transactions? int - Transactions count

batch? string - Deposit batch number

iris.lead: DisputeDetailsResponse

Fields

transactions? DisputedetailsresponseTransactions[] -

auth_records? DisputedetailsresponseTransactions[] -

notes? DisputedetailsresponseNotes[] -

messages? DisputedetailsresponseMessages[] -

directories? DisputedetailsresponseDirectories[] -

iris.lead: DisputedetailsresponseDirectories

Fields

time? string -

title? string -

files? DisputedetailsresponseFiles[] -

iris.lead: DisputedetailsresponseFields

Fields

'key? string -

value? string -

iris.lead: DisputedetailsresponseFiles

Fields

time? string -

title? string -

url? string - site url

api_url? string - api url

iris.lead: DisputedetailsresponseMessages

Fields

message? string -

description? string -

added_at? string -

viewed_on? string -

iris.lead: DisputedetailsresponseNotes

Fields

message? string -

added_at? string -

iris.lead: DisputedetailsresponseTransactions

Fields

reference? string -

fields? DisputedetailsresponseFields[] -

iris.lead: DisputeFile

Fields

name? string - File name

directory? string - Folder name

content? string - base64 encoded content

iris.lead: DuplicateActivity

Fields

id? int - Activity Id

oldLeadId? int - Old lead Id

newLeadId? int - New lead Id

duplicatedBy? int - User Id

duplicatedAt? string - Date of duplication (Y-m-d\TH:i:sP)

iris.lead: FieldsFieldidBody

Fields

Fields Included from *LeadField

id int
tab int
label string
type string
length int
default string
alignment string
searchable int
special string
options LeadfieldOptions
order int
readOnly boolean
required boolean
anydata...

override? boolean - Flag for overriding existing special field

iris.lead: File

Fields

id? int -

name? string -

size? int -

created? string - File creation date (Y-m-d\TH:i:sP)

created_by? int -

iris.lead: FileLabel

Fields

id? int - Label Id

'order? int - Label display order

name? string - Label name

iris.lead: FullLeadSubscription

Fields

Fields Included from *ShortLeadSubscription

id int
lead_url string
name string
email string
contact string
phone string
address LeademailreceivedeventinfoDataLeadAddress
assignedUsers UserListStructure
anydata...

id? int - Lead ID

lead_url? string - Lead URL

name? string - Lead Name

email? string - Lead Default Email

contact? string - Lead Default Contact Name

phone? string - Lead Default Contact Phone Number

address? LeademailreceivedeventinfoDataLeadAddress -

group? FullleadsubscriptionGroup -

category? FullleadsubscriptionCategory -

status? FullleadsubscriptionStatus -

campaign? FullleadsubscriptionCampaign -

'source? FullleadsubscriptionSource -

createdAt? string - Date and time of creation (ISO 8601)

createdBy? UserStructure -

iris.lead: FullleadsubscriptionCampaign

Fields

id? int? - Campaign ID

name? string? - Campaign Name

iris.lead: FullleadsubscriptionCategory

Fields

id? int - Status category ID

name? string - Status category Name

iris.lead: FullleadsubscriptionGroup

Fields

id? int - Group ID

name? string - Group Name

iris.lead: FullleadsubscriptionSource

Fields

id? int? - Source ID

name? string? - Source Name

iris.lead: FullleadsubscriptionStatus

Fields

id? int - Status ID

name? string - Status Name

iris.lead: InlineResponse200

Fields

data? BriefLeadInfo[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse2001

Fields

leadId? int - Lead Id

message? string - Result message

iris.lead: InlineResponse20010

Fields

message? string -

iris.lead: InlineResponse20011

Fields

data? LeadAppointment[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20012

Fields

message? string -

iris.lead: InlineResponse20013

Fields

message? string -

url? string -

iris.lead: InlineResponse20014

Fields

data? InlineResponse20014Data[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20014Data

Fields

id? int - Task Id

user? BriefUserInfo -

text? string - Task description

date? string - Task Date and time in format ISO 8601 (Y-m-d\TH:i:sP)

confirmed? string - Task confirmed date and time in format ISO 8601 (Y-m-d\TH:i:sP)

iris.lead: InlineResponse20015

Fields

message? string -

iris.lead: InlineResponse20016

Fields

data? BriefUserInfoWithClass[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20017

Fields

message? string -

iris.lead: InlineResponse20018

Fields

message? string -

iris.lead: InlineResponse20019

Fields

data? InlineResponse20019Data[] - A list of lead documents

links? Links -

meta? Meta -

iris.lead: InlineResponse20019Data

Fields

id? string - Document Id

name? string - Name

size? string - Size

tab? InlineResponse20019Tab -

label? InlineResponse20019Label -

iris.lead: InlineResponse20019Label

Fields

id? int -

name? string -

iris.lead: InlineResponse20019Tab

Fields

id? int -

name? string -

iris.lead: InlineResponse2002

Fields

general? BriefLeadInfo -

details? InlineResponse2002Details[] -

iris.lead: InlineResponse20020

Fields

data? FileLabel[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20021

Fields

data? BriefEmailTemplate[] -

iris.lead: InlineResponse20022

Fields

message? string - SMS has been sent successfully.

receiver? string - Phone number of SMS receiver.

iris.lead: InlineResponse20023

Fields

data? BriefSmsTemplate[] -

iris.lead: InlineResponse20024

Fields

data? CampaignActivity[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20025

Fields

data? DeletionActivity[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20026

Fields

data? DuplicateActivity[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20027

Fields

data? LinksActivity[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20028

Fields

data? SourceActivity[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20029

Fields

data? StatusActivity[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse2002Details

Fields

id? int -

name? string -

'type? string -

'record? int - Record Id

fields? InlineResponse2002Fields[] -

iris.lead: InlineResponse2002Fields

Fields

id? string - Field Id

'field? string - Field name

value? string - Field value

iris.lead: InlineResponse2003

Fields

message? string -

iris.lead: InlineResponse20030

Fields

data? ApplicationField[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse20031

Fields

data? BriefCampaignInfo[] - A list of lead campaigns

iris.lead: InlineResponse20032

Fields

data? BriefGroupInfo[] - A list of lead groups

iris.lead: InlineResponse2004

Fields

message? string -

iris.lead: InlineResponse2005

Fields

data? LeadField[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse2006

Fields

result? string -

iris.lead: InlineResponse2007

Fields

data? LeadFieldTab[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse2008

Fields

data? InlineResponse2008Data[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse2008Data

Fields

id? int - Template Id

name? string - Template name

created_by? int - Template creator

created_at? string - Template modification date and time (ISO-8601)

modified_by? int - Template modification date and time (ISO-8601)

modified_at? string - Last template editor

fields_changed_by? int - Last fields editor

fields_changed_at? string - Last fileds modification date and time (ISO-8601)

values? InlineResponse2008Values[] -

iris.lead: InlineResponse2008Values

Fields

field_id? int -

value? string -

iris.lead: InlineResponse2009

Fields

data? InlineResponse2009Data[] -

links? Links -

meta? Meta -

iris.lead: InlineResponse2009Data

Fields

id? int - Note Id

sticky? string - Pin note to top

tab? BriefTabInfo -

text? string - Note text

created? string - Note creation date and time (ISO-8601)

modified? string - Note modification date and time (ISO-8601)

iris.lead: InlineResponse401

Fields

message? string -

iris.lead: InlineResponse403

Fields

message? string -

iris.lead: InlineResponse404

Fields

message? string -

iris.lead: InlineResponse405

Fields

message? string -

iris.lead: InlineResponse500

Fields

message? string -

iris.lead: LeadAppointment

Fields

id? int - Appointment Id

user? BriefUserInfo -

set_for? BriefUserInfo -

set_at? string - Appointment creation date and time in format ISO 8601 (Y-m-d\TH:i:sP)

set_by? BriefUserInfo -

modified? string - Appointment modification date and time in format ISO 8601 (Y-m-d\TH:i:sP)

modified_by? BriefUserInfo -

text? string - Appointment description

date? string - Appointment date and time in format ISO 8601 (Y-m-d\TH:i:sP)

date_end? string - Appointment end date and time in format ISO 8601 (Y-m-d\TH:i:sP)

done? string - Is appointment done?

confirmed? string - Appointment confirmed date and time in format ISO 8601 (Y-m-d\TH:i:sP)

confirmed_by? BriefUserInfo -

seen? string - Appointment seen date and time in format ISO 8601 (Y-m-d\TH:i:sP)

seen_by? BriefUserInfo -

rescheduled? string - Appointment rescheduled date and time in format ISO 8601 (Y-m-d\TH:i:sP)

rescheduled_by? BriefUserInfo -

rescheduled_count? int -

iris.lead: LeadCreatedEventInfo

Fields

hook? LeadcreatedeventinfoHook -

data? LeadcreatedeventinfoData -

iris.lead: LeadcreatedeventinfoData

Fields

lead? FullLeadSubscription -

leads? FullLeadSubscription[] - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.lead: LeadcreatedeventinfoHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: LeadDeletedEventInfo

Fields

hook? LeaddeletedeventinfoHook -

data? LeaddeletedeventinfoData -

iris.lead: LeaddeletedeventinfoData

Fields

lead? record { deletedBy UserStructure } -

leads? record { deletedBy UserStructure }[] - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.lead: LeaddeletedeventinfoHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: LeadDocumentUploadedEventInfo

Fields

hook? LeaddocumentuploadedeventinfoHook -

data? LeaddocumentuploadedeventinfoData -

iris.lead: LeaddocumentuploadedeventinfoData

Fields

lead? record { document record { id int, label string, filename string, file string, uploadedAt string, uploadedBy UserStructure } } -

leads? record { document record { id int, label string, filename string, file string, uploaded_at string, uploaded_by UserStructure } }[] - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.lead: LeaddocumentuploadedeventinfoHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: LeadEmailReceivedEventInfo

Fields

hook? LeademailreceivedeventinfoHook -

data? LeademailreceivedeventinfoData -

iris.lead: LeademailreceivedeventinfoData

Fields

lead? LeademailreceivedeventinfoDataLead - 'lead' property is passed when 'Multiple at once' feature is disabled

leads? LeademailreceivedeventinfoDataLeads[] - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.lead: LeademailreceivedeventinfoDataLead

'lead' property is passed when 'Multiple at once' feature is disabled

Fields

id? int - Lead ID

lead_url? string - Lead URL

name? string - Lead Name

emailAddress? string - Lead Default Email

contact? string - Lead Default Contact Name

phone? string - Lead Default Contact Phone Number

address? LeademailreceivedeventinfoDataLeadAddress -

email? LeademailreceivedeventinfoDataLeadEmail -

assignedUsers? UserListStructure -

iris.lead: LeademailreceivedeventinfoDataLeadAddress

Fields

address? string - Lead Default Address

city? string - Lead Default City

state? string - Lead Default State

zip? string - Lead Default ZIP

iris.lead: LeademailreceivedeventinfoDataLeadEmail

Fields

'from? string - Sent from (name and email)

to? string - Sent to(email)

subject? string - Email subject

bodyText? string - Email message without html

bodyHtml? string - Email message including html

sentAt? string - Date and time of receiving the email (ISO 8601)

iris.lead: LeademailreceivedeventinfoDataLeads

Fields

id? int - Lead ID

lead_url? string - Lead URL

name? string - Lead Name

emailAddress? string - Lead Default Email

contact? string - Lead Default Contact Name

phone? string - Lead Default Contact Phone Number

address? LeademailreceivedeventinfoDataLeadAddress -

email? LeademailreceivedeventinfoDataLeadEmail -

assignedUsers? UserListStructure -

iris.lead: LeademailreceivedeventinfoHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: LeadField

Fields

id? int - Field Id

tab int - Field tab Id

label string - Field label

'type string - Field type

length? int - Field size

default? string - Field default value

alignment? string - Field alignment

searchable? int - Searchable field

special? string - Field special value

options? LeadfieldOptions -

'order? int -

readOnly? boolean - Whether the field is read only

required? boolean - Whether the field is required

iris.lead: LeadfieldOptions

Fields

dupecheck? boolean - Enable dupecheck

contactid? string - Id of contact field

mask? string - Field mask

copy? LeadfieldOptionsCopy - Copy button properties

hyperlink? boolean - Enable hyperlink

sms? boolean - Enable SMS

dialer? boolean - Enable dialer

googlemaps? record {} - Google Maps search properties

zipcode_autocomplete? LeadfieldOptionsZipcodeAutocomplete - ZIP Code autofill properties

iris.lead: LeadfieldOptionsCopy

Copy button properties

Fields

title? string - Button label

'from? record {} - Copy from

to? record {} - Copy to

iris.lead: LeadfieldOptionsDropdown

Add new list item

Fields

'key? string - Key

value? string - Value

iris.lead: LeadfieldOptionsZipcodeAutocomplete

ZIP Code autofill properties

Fields

city? record {} - City fields

state? record {} - State fields

zipcode? record {} - Zipcode fields

iris.lead: LeadFieldOrder

Fields

value int - New order position of lead field

'type? string - Type of changing order position

iris.lead: LeadFieldTab

Fields

id? int - Tab Id

active? int - Active tab

position int - Tab position

'class string - Tab class

name string - Tab class

'order int - Tab order

iris.lead: LeadidAppointmentsBody

Fields

date string - Date in format ISO 8601 (Y-m-d\TH:i:sP)

date_end string - End date in format ISO 8601 (Y-m-d\TH:i:sP)

text string - Task description

set_by string - Task set by user (User Id)

set_for string - Task set for user (User Id)

iris.lead: LeadidNotesBody

Fields

tab int - Tab Id

note string - Note text

sticky string - Pin to top?

iris.lead: LeadidTasksBody

Fields

priority string - Priority

date string - Date in ISO 8601 format (Y-m-d\TH:i:sP)

date_end string - End date in ISO 8601 format (Y-m-d\TH:i:sP)

text string - Task description

set_by string - Task set by user (user Id)

set_for string - Task set for user (user Id)

iris.lead: LeadidUsersBody

Fields

user int - User Id

iris.lead: LeadNoteAddedEventInfo

Fields

hook? LeadnoteaddedeventinfoHook -

data? LeadnoteaddedeventinfoData -

iris.lead: LeadnoteaddedeventinfoData

Fields

lead? record { note record { id int, name string, pinned boolean, images string[], createdAt string, createdBy UserStructure } } -

leads? record { note record { id int, name string, pinned boolean, images string[], createdAt string, createdBy UserStructure } }[] - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.lead: LeadnoteaddedeventinfoHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: LeadRestoredEventInfo

Fields

hook? LeadrestoredeventinfoHook -

data? LeadrestoredeventinfoData -

iris.lead: LeadrestoredeventinfoData

Fields

lead? record { restoredAt string, restoredBy UserStructure } -

leads? record { restoredAt string, restoredBy UserStructure }[] - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.lead: LeadrestoredeventinfoHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: LeadsFieldsBody

Fields

Fields Included from *LeadField

id int
tab int
label string
type string
length int
default string
alignment string
searchable int
special string
options LeadfieldOptions
order int
readOnly boolean
required boolean
anydata...

override? boolean - Flag for overriding existing special field

iris.lead: LeadsLeadidBody

Fields

campaign? int - Campaign Id

status? int - Status Id

'source? int - Source Id

group? int - Group Id

fields? Apiv1leadsFields[] - Lead fields

iris.lead: LeadStatusUpdatedEventInfo

Fields

hook? LeadstatusupdatedeventinfoHook -

data? LeadstatusupdatedeventinfoData -

iris.lead: LeadstatusupdatedeventinfoData

Fields

lead? record { previousStatus record { id int, name string }, newStatus record { id int, name string }, statusUpdatedAt string, statusUpdatedBy UserStructure, salesRep UserStructure } -

leads? record { previousStatus record { id int, name string }, newStatus record { id int, name string }, statusUpdatedAt string, statusUpdatedBy UserStructure, salesRep UserStructure }[] - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.lead: LeadstatusupdatedeventinfoHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: LeadUpdatedEventInfo

Fields

hook? LeadupdatedeventinfoHook -

data? LeadupdatedeventinfoData -

iris.lead: LeadupdatedeventinfoData

Fields

lead? record { updated_at string, updated_by UserStructure } -

leads? record { updated_at string, updated_by UserStructure }[] - 'leads' property is passed when 'Multiple at once' feature is enabled

iris.lead: LeadupdatedeventinfoHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: LineItemAdded

Fields

hook? LineitemaddedHook -

data? LineitemaddedData -

iris.lead: LineitemaddedData

Fields

line_items? LineItems[] -

iris.lead: LineitemaddedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: LineItems

Fields

id? int -

'type? string -

item_id? int -

user? LineitemsUser -

merchant? LineitemsMerchant -

related_mid? int -

related_dba? string -

description? string -

income? int -

expense? int -

percentage? int -

agent_net? int -

is_recurring? boolean -

created? string - Created date of line item

modified? string - Last update date of line item

agents? LineitemsAgents[] -

recurring_start_date? string - Date of start recurring line item

recurring_payment_count? int - Count of payments what was already done

recurring_max_payment_count? int - Count of payments which will be done (this will be null if there is no limit)

recurring_period? string -

iris.lead: LineitemsAgents

Fields

user_id? int -

username? string -

full_name? string -

agent_net? int -

percentage? int -

iris.lead: LineitemsMerchant

Fields

mid? string -

dba? string -

iris.lead: LineitemsUser

Fields

user_id? int -

username? string -

full_name? string -

'class? string -

iris.lead: Links

Fields

first? string - An URL to the first page of the data set

last? string - An URL to the last page of the data set

prev? string - An URL to the previous page of the data set

next? string - An URL to the next page of the data set

iris.lead: LinksActivity

Fields

id? int - Activity Id

status? string - Status of link

lead? string - Lead Id

merchant? string - Merchant Id

linkedBy? int - User Id

linkedAt? string - Linking date (Y-m-d\TH:i:sP)

iris.lead: MerchantRow

Fields

merchant? string -

transactions? int -

sales_amount? int -

income? int -

expense? int -

net? int -

bps? int -

users? boolean -

percentage? int -

agent_net? int -

mid? int -

iris.lead: Meta

Fields

current_page? int - The current page number of a data set

'from? int - The current position of a data set

last_page? string - The last page of a data set

path? string - API path

per_page? int - A number of records per page

to? int - The last position in a data set

total? int - Total number of records in a data set

iris.lead: MonetaryBatch

Fields

date? string - Batch date

reference_number? string - Batch description

amount? string - Batch amount

count? string - A number of transactions

terminal_number? string - Batch terminal number

transactions? MonetarybatchTransactions[] -

iris.lead: MonetarybatchTransactions

Fields

id? int - Transaction ID

date? string - Transaction date

'type? string - Transaction type

amount? string - Transaction amount

cardholder? string - Cardholder number

auth_code? string - Transaction auth code

pos_entry_mode? string - POS entry mode

invoice_number? string - Invoice number

void_reject_chargeback? boolean - Is a transaction rejected?

iris.lead: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

iris.lead: ReportPublished

Fields

hook? ReportpublishedHook -

data? ReportpublishedData -

iris.lead: ReportpublishedData

Fields

reports? ReportpublishedDataReports[] -

iris.lead: ReportpublishedDataReports

Fields

id? int -

month? int -

year? int -

sys_prin? int -

created? string - Ticket created date

created_by? UserStructure -

added_merchants_count? int -

rows_count? int -

revision? int -

deactivated_merchants_count? int -

processor_id? int -

processor_name? string -

sum_transactions? int -

sum_volume? decimal -

sum_net? decimal -

sum_agent_net? int -

iris.lead: ReportpublishedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: ResidualsDetails

Fields

MID? string -

DBA? string -

iris.lead: ResidualTemplate

Fields

id? int -

name? string -

creator_id? int -

creator_name? string -

created_at? string - Created date of template

revision? int -

rules? TemplateRules[] -

iris.lead: ResidualTemplateAssigned

Fields

user_id? int -

username? string -

full_name? string -

templates? ResidualtemplateassignedTemplates[] -

iris.lead: ResidualtemplateassignedTemplates

Fields

id? int -

name? string -

'version? int -

processor_id? int -

rules? TemplateRules[] -

iris.lead: Retrieval

Fields

id? int - Chargeback internal ID

merchant_id? string - Merchant ID

dba? string - Merchant DBA

case_number? string - Case number

retrieval_date? string - Request date

transaction_date? string - Transaction date

amount? string - Amount

respond_due? string - Respond due date

original_amount? string - Original amount of transaction

currency? string - Transaction currency

reason? string - Retrieval case reason

reason_code? string - Retrieval case reason code

card_number? string - Cardholder number

transaction_id? string - Transaction ID

reference_number? string - Transaction ID

case_status? string - Case status

case_status_description? string - Status description

mcc? string - MCC code

dispute_jurisdiction? string - Dispute jurisdiction

card_product_type? string - Card product

transaction_method? string - Transaction method

invoice_number? string - Invoice number

microfilm_number? string - Microfilm number

airline_ticket_number? string - Airline ticket number

order_number? string - Order number

tracking_number? string - Tracking number

last_status_date? string - Date of the last status update

updated_at? string - Date of the most recent update

case_action? string - Case action

action? string - Can the case be viewed of replied

foreign_amount? string - Foreign amount of transaction

transaction_locator? string - Transaction locator

iris.lead: RetrievalAdded

Fields

hook? RetrievaladdedHook -

data? RetrievaladdedData -

iris.lead: RetrievaladdedData

Fields

retrievals? RetrievalsReplyResponse[] -

iris.lead: RetrievaladdedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: RetrievalReminder

Fields

hook? RetrievalreminderHook -

data? RetrievalreminderData -

iris.lead: RetrievalreminderData

Fields

retrievals? record { due_in int }[] -

iris.lead: RetrievalreminderHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: RetrievalReplyCreditIssuedRequest

Fields

credit_date string - Credit transaction date

credit_amount string - Credit transaction amount

user_note string - User note

file string[] - Files to attach

iris.lead: RetrievalReplyResponseRequest

Fields

user_note string - User note

file string[] - Files to attach

iris.lead: RetrievalReplyUnableRequest

Fields

user_note string - User note

file string[] - Files to attach

iris.lead: RetrievalsReplyResponse

Fields

retrieval? RetrievalsreplyresponseRetrieval -

Fields Included from *DisputeDetailsResponse

transactions DisputedetailsresponseTransactions[]
auth_records DisputedetailsresponseTransactions[]
notes DisputedetailsresponseNotes[]
messages DisputedetailsresponseMessages[]
directories DisputedetailsresponseDirectories[]
anydata...

iris.lead: RetrievalsreplyresponseRetrieval

Fields

id? string -

merchant_id? string -

dba? string -

date? string -

transaction_date? string -

amount? string -

reason_code? string -

reason? string -

card_number? string -

case_number? string -

case_action? string -

action? string -

case_status? string -

case_status_description? string -

last_status_date? string -

respond_due? string -

original_amount? string -

updated_at? string -

mcc? string -

dispute_jurisdiction? string -

card_product_type? string -

foreign_amount? string -

transaction_method? string -

transaction_locator? string -

invoice_number? string -

microfilm_number? string -

airline_ticket_number? string -

order_number? string -

tracking_number? string -

iris.lead: RetrievalUpdated

Fields

hook? RetrievalupdatedHook -

data? RetrievaladdedData -

iris.lead: RetrievalupdatedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: ShortLeadSubscription

Fields

id? int - Lead ID

lead_url? string - Lead URL

name? string - Lead Name

email? string - Lead Default Email

contact? string - Lead Default Contact Name

phone? string - Lead Default Contact Phone Number

address? LeademailreceivedeventinfoDataLeadAddress -

assignedUsers? UserListStructure -

iris.lead: SignatureGenerated

Fields

hook? SignaturegeneratedHook -

data? SignaturegeneratedData -

iris.lead: SignaturegeneratedData

Fields

signatures? SignaturegeneratedDataSignatures[] -

iris.lead: SignaturegeneratedDataSignatures

Fields

signature? SignatureSubscription -

application? ApplicationSubscription -

lead? FullLeadSubscription -

iris.lead: SignaturegeneratedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: SignatureOpened

Fields

hook? SignatureopenedHook -

data? SignaturegeneratedData -

iris.lead: SignatureopenedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: SignatureSigned

Fields

hook? SignaturesignedHook -

data? SignaturegeneratedData -

iris.lead: SignaturesignedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: SignatureSubscription

Fields

id? int -

hash? string -

url? string -

status? string -

created? string - Signature created date

created_by? UserStructure -

multi_signer? boolean -

completed? boolean -

signers? SignaturesubscriptionSigners[] -

iris.lead: SignaturesubscriptionSigners

Fields

name? string -

email? string -

iris.lead: SourceActivity

Fields

id? int - Activity Id

newValue? string - New value of activity

assignedBy? int - User Id

assignedAt? string - Assigned date (Y-m-d\TH:i:sP)

iris.lead: StatusActivity

Fields

id? int - Activity Id

changedBy? int - User Id

changedAt? string - Deleted date (Y-m-d\TH:i:sP)

oldStatus? string - Old status

old_status_id? int - Old Status Id

newStatus? string - New status

new_status_id? int - New Status Id

iris.lead: SubscriptionCommentEdited

Fields

hook? SubscriptioncommenteditedHook -

data? TicketcommentedData -

iris.lead: SubscriptioncommenteditedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: SummaryResponse

Fields

processor_id? int -

name? string -

created? string -

created_by? int -

modified? string -

modified_by? int -

merchants_count? int -

sum_transactions? int -

sum_sales_amount? decimal -

sum_income? decimal -

sum_expense? decimal -

sum_net? decimal -

sum_bps? decimal -

sum_agent_net? int -

iris.lead: TemplateRules

Fields

column? string -

rule? string -

value? int -

'field? string -

iris.lead: TestSubscription

Fields

hook? TestsubscriptionHook -

data? TestsubscriptionData -

iris.lead: TestsubscriptionData

Fields

message? string -

iris.lead: TestsubscriptionHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: Ticket

Fields

id? int - Ticket id

subject? string - Ticket subject

description? string - Ticket description

status? TicketStatus -

'type? TicketType -

group? TicketGroup -

priority? TicketPriority -

lead_id? int - Assigned Lead ID

mid? int - Assigned Merchant ID

merchantVisible? boolean - Indicates if the ticket is visible to Merchant users

iris.lead: TicketCommented

Fields

hook? TicketcommentedHook -

data? TicketcommentedData -

iris.lead: TicketcommentedData

Fields

comments? record { id int, ticketId int, comment string, created string, createdBy UserStructure, modified string, modified_by UserStructure }[] -

iris.lead: TicketcommentedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: TicketCreated

Fields

hook? TicketcreatedHook -

data? TicketcreatedData -

iris.lead: TicketCreatedBlock

Fields

created? string - Ticket created date

created_by? int - Ticket creator id

iris.lead: TicketcreatedData

Fields

tickets? record {}[] -

iris.lead: TicketcreatedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: TicketDetail

Fields

general? File[] -

checklist? ChecklistFullInfo[] -

iris.lead: TicketGroup

Fields

id? int - Group id

name? string - Group name

iris.lead: TicketPriority

Fields

id? int - Priority id

name? string - Priority name

iris.lead: TicketResolved

Fields

hook? TicketresolvedHook -

data? TicketresolvedData -

iris.lead: TicketresolvedData

Fields

tickets? record { created string, created_by UserStructure, modified string, modified_by UserStructure, last_comment string, resolved string, resolved_by UserStructure }[] -

iris.lead: TicketresolvedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: TicketStatus

Fields

id? int - Status id

name? string - Status name

iris.lead: TicketSubscriptionData

Fields

ticket_url? string -

assignedUsers? UserListStructure -

files? File[] -

preview_images? File[] -

due_date? string - Ticket due date

due? string - Ticket SLA

only_business_days? boolean - Calculate only business days

iris.lead: TicketType

Fields

id? int - Type id

name? string - Ticket type

iris.lead: TicketTypeRequest

Fields

name? string - Ticket type name

description? string - Ticket type description

daysToResolve? int - Days to Resolve

only_business_days? boolean - Calculate only business days

status? string - Status

priority? int - Priority (0 - Normal, 1 - Medium, 2 - Rush)

permissions? int[] -

assignees? BrieftickettypeinfoAssignees -

iris.lead: TicketUpdated

Fields

hook? TicketupdatedHook -

data? TicketupdatedData -

iris.lead: TicketupdatedData

Fields

tickets? record { modified string, modified_by UserStructure, last_comment string }[] -

iris.lead: TicketupdatedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: TurboAppApproved

Fields

hook? TurboappapprovedHook -

data? TurboappapprovedData -

iris.lead: TurboappapprovedData

Fields

accounts? TurboappapprovedDataAccounts[] -

iris.lead: TurboappapprovedDataAccounts

Fields

id? int - Account ID

application_url? string - Application URL

identifier? string - Application identifier

processor? string - Processor name

dba? string - Merchant name

mid? int - Merchant ID

lid? int - Lead ID related to the application

activation_status? TurboappupdatedDataActivationStatus -

application_status? TurboappupdatedDataActivationStatus -

contact_name? string -

contact_address? string -

contact_phone? string -

salesman? string -

co_name? string -

approved_at? string - Date and time of account approve (ISO 8601)

legal_name? string - Merchant name

comments? TurboappupdatedDataComments -

entitlements? TurboappapprovedDataEntitlements -

users? string[] -

date_submitted? string - Date and time of account submit (ISO 8601)

date_decision? string - Date and time of decision (ISO 8601)

mcc_code? string - MCC code

annual_sales? string - Annual sales

average_ticket? string - Average ticket

tier? string -

tier_status? string -

iris.lead: TurboappapprovedDataEntitlements

Fields

card_type? string -

srv? string -

proc_flag? string -

iris.lead: TurboappapprovedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: TurboAppDeclined

Fields

hook? TurboappdeclinedHook -

data? TurboappdeclinedData -

iris.lead: TurboappdeclinedData

Fields

accounts? TurboappdeclinedDataAccounts[] -

iris.lead: TurboappdeclinedDataAccounts

Fields

id? int - Account ID

application_url? string - Application URL

identifier? string - Application identifier

processor? string - Processor name

dba? string - Merchant name

mid? int - Merchant ID

lid? int - Lead ID related to the application

activation_status? TurboappdeclinedDataActivationStatus -

application_status? TurboappdeclinedDataActivationStatus -

contact_name? string -

contact_address? string -

contact_phone? string -

salesman? string -

co_name? string -

declined_at? string - Date and time of account was declined (ISO 8601)

legal_name? string - Merchant name

comments? TurboappdeclinedDataComments -

entitlements? TurboappapprovedDataEntitlements -

users? string[] -

date_submitted? string - Date and time of account submit (ISO 8601)

date_decision? string - Date and time of decision (ISO 8601)

mcc_code? string - MCC code

annual_sales? string - Annual sales

average_ticket? string - Average ticket

tier? string -

tier_status? string -

iris.lead: TurboappdeclinedDataActivationStatus

Fields

old? string -

'new? string -

iris.lead: TurboappdeclinedDataComments

Fields

date? string - Date and time of comment (ISO 8601)

co? string -

text? string -

iris.lead: TurboappdeclinedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: TurboAppSubmited

Fields

hook? TurboappsubmitedHook -

data? TurboappsubmitedData -

iris.lead: TurboappsubmitedData

Fields

applications? TurboappsubmitedDataApplications[] -

iris.lead: TurboappsubmitedDataApplications

Fields

id? int - Application ID

application_url? string - Application URL

identifier? string - Application identifier

submission_id? string - Application submission identifier

dba? string - Merchant name

lid? int - Lead ID related to the application

createdAt? string - Date and time of creation (ISO 8601)

createdBy? UserStructure -

finishedAt? string - Date and time of submission (ISO 8601)

finishedBy? UserStructure -

iris.lead: TurboappsubmitedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: TurboAppUpdated

Fields

hook? TurboappupdatedHook -

data? TurboappupdatedData -

iris.lead: TurboappupdatedData

Fields

accounts? TurboappupdatedDataAccounts[] -

iris.lead: TurboappupdatedDataAccounts

Fields

id? int - Account ID

application_url? string - Application URL

identifier? string - Application identifier

dba? string - Merchant name

mid? int - Merchant ID

lid? int - Lead ID related to the application

comments? TurboappupdatedDataComments -

activation_status? TurboappupdatedDataActivationStatus -

application_status? TurboappupdatedDataActivationStatus -

contact_name? string -

salesman? string -

updatedAt? string - Date and time of account update (ISO 8601)

iris.lead: TurboappupdatedDataActivationStatus

Fields

old? string -

'new? string -

iris.lead: TurboappupdatedDataComments

Fields

date? string - Date and time of comment (ISO 8601)

co? string -

text? string -

iris.lead: TurboappupdatedHook

Fields

requestId? int - Request ID

event? string - Event ID

iris.lead: TypeDetail

Fields

general? BriefTicketTypeInfo -

checklist? ChecklistFullInfo[] -

iris.lead: UserStructure

Fields

id? int - User ID

name? string - User Name

userClass? string - User Class

iris.lead: V1LeadsBody

Fields

campaign? int - Campaign Id

status int - Status Id

'source? int - Source Id

group? int - Group Id

users? int[] - Ids of users to assign to a new lead

fields Apiv1leadsFields[] - Lead fields

Union types

iris.lead: SmsTemplateidBody

record { fieldId int }|record { phone string }

SmsTemplateidBody

Array types

iris.lead: BriefApplicationInfoArr

BriefApplicationInfo[]

BriefApplicationInfoArr

iris.lead: Adjustments

AdjustmentsInner[]

Adjustments

iris.lead: UserListStructure

UserStructure[]

UserListStructure

iris.lead: Deposits

DepositsInner[]

Deposits

Import

import ballerinax/iris.lead;

Other versions

1.5.2

1.5.1 1.5.0 1.4.0 1.2.0

Metadata

Released date: 4 days ago

Version: 1.5.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 27

Current verison: 0

Weekly downloads

Source repository

Keywords

Type/Connector

Vendor/IRIS

Area/CRM & Sales

Sales & CRM/Customer Relationship Management

Cost/Paid

Contributors

Dependencies

ballerina/url/2.4.0 ballerina/http/2.10.24

Cookie policy

Delete policy

clients

records

unionTypes

arrayTypes

ballerinax/iris.lead Ballerina library

Overview

Key Features

Prerequisites

Quickstart

Step 1: Import connector

Step 2: Create a new connector instance

Step 3: Invoke connector operation

Clients

iris.lead: Client

Constructor

getLeads

Parameters

Return Type

createLead

Parameters

Return Type

getDetailedLeadInformation

Parameters

Return Type

updateLead

Parameters

Return Type

deleteRecordFromALeadRecordSet

Parameters

Return Type

getAvailableLeadFields

Parameters

Return Type

createNewLeadField

Parameters

Return Type

getLeadField

Parameters

Return Type

updateLeadField

Parameters

Return Type

updateLeadFieldOrderPosition

Parameters

Return Type

getAllLeadFieldTabs

Parameters

Return Type

createLeadFieldTab

Parameters

Return Type

getLeadFieldTab

Parameters

Return Type

updateLeadFieldTab

Parameters

Return Type

getPricingTemplates

Parameters

Return Type

getLeadNotes

Parameters

Return Type

createLeadNote

Parameters

Return Type

getLeadAppointments

Parameters

Return Type

createLeadAppointment

Parameters

Return Type

populatePdfDocument

Parameters

Return Type

getLeadTasks

Parameters

Return Type

createLeadTask

Parameters