Interacties

Interacties zijn te beheren via de controller 'interaction'.


list

Middels deze functie kunt u een lijst met interacties ophalen die voldoen aan de meegegeven parameters.


Invoerparameters:


Veldnaam Waarde Omschrijving
referenceId int Gekoppelde entiteits ID
referenceType string Aan interacties te koppelen entiteitstype, zie variabelen-lijst
offset int Standaard: 0
limit int Standaard: 1000
sort string Standaard: Date
order 'ASC' of 'DESC' Standaard: DESC
searchat string Welke velden doorzocht moeten worden.
Standaard: Description
searchfor string Zoekterm
Verplichte velden: referenceId en referenceType

Voorbeeld invoer:


$parameters = [
    "referenceId" => 1,
    "referenceType" => "debtor"
];

$api->sendRequest('interaction', 'list', $parameters);

Voorbeeld uitvoer:


Array
(
    [controller] => interaction
    [action] => list
    [status] => success
    [date] => 2024-01-21T12:00:00+02:00
    [totalresults] => 1
    [currentresults] => 1
    [offset] => 0
    [filters] => Array
        (
            [referenceId] => 1
            [referenceType] => debtor
        )

    [interactions] => Array
        (
            [0] => Array
                (
                    [Identifier] => 1
                    [Date] => 0000-00-00
                    [Time] => 
                    [AssigneeId] => 1
                    [DebtorId] => 1
                    [DebtorContactId] => 
                    [CreditorId] => 
                    [InvoiceId] => 
                    [PriceQuoteId] => 
                    [CreditInvoiceId] => 
                    [UnprocessedCreditInvoiceId] => 
                    [SubscriptionId] => 
                    [Description] => Example interaction
                    [CreatedByEmployeeId] => 
                    [CommunicationMethod] => phone
                    [Created] => 2024-01-21 11:00:00
                    [Modified] => 2024-01-21 11:00:00
                )

        )

)