Taken

Taken zijn te beheren via de controller 'task'.

list

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

Invoerparameters:

Veldnaam	Waarde	Omschrijving
referenceId	int	Gekoppelde entiteits ID
referenceType	string	Aan taken te koppelen entiteitstype, zie variabelen-lijst
status	string	Taak status, zie variabelen-lijst
offset	int	Standaard: 0
limit	int	Standaard: 1000
sort	string	Standaard: DueAtDate
order	'ASC' of 'DESC'	Standaard: DESC
searchat	string	Welke velden doorzocht moeten worden. Standaard: Title\|Description
searchfor	string	Zoekterm

Voorbeeld invoer:

$parameters = [
    "status" => "open"
];

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

Voorbeeld uitvoer:

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

    [tasks] => Array
        (
            [0] => Array
                (
                    [Identifier] => 1
                    [DueAt] => 
                    [DueAtTime] => 
                    [CompletedAt] => 0000-00-00 00:00:00
                    [AssigneeId] => 
                    [DebtorId] => 
                    [DebtorContactId] => 
                    [CreditorId] => 
                    [InvoiceId] => 
                    [PriceQuoteId] => 
                    [CreditInvoiceId] => 
                    [UnprocessedCreditInvoiceId] => 
                    [SubscriptionId] => 
                    [Title] => Example task
                    [Description] => Example description
                    [CreatedByEmployeeId] => 
                    [Status] => open
                    [Created] => 2024-01-21 11:00:00
                    [Modified] => 2024-01-21 11:00:00
                )

        )

)